cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands
Class Initialize

java.lang.Object
  cz.cuni.amis.pogamut.base.communication.messages.CommandMessage
      cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands.Initialize

public class Initialize
extends CommandMessage

Representation of the GameBots2004 command INIT. Message you'll send at the beginning of the communication to create a bot in the game. You must send this message before you can have a character to play in the game.

Field Summary

protected java.lang.Boolean	AutoPickupOff It enables/disables automatic pickup of the bot.
protected java.lang.Boolean	AutoTrace Enables/disables auto ray tracing feature.
protected java.lang.String	ClassName Sets the Unreal Tournament class of the bot that should be used.
protected java.lang.Integer	DesiredSkill Can range from 0 to 7.
protected java.lang.String	Jmx Sets the jmx adress we can use to debug the bot from Java (if we are using Pogamut).
protected Location	Location Specify start location, if unspecified, then random.
protected java.lang.Boolean	ManualSpawn Sets if the bot wil have tol be respawned after death manually by RESPAWN command.
protected java.lang.String	Name Desired name.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected Rotation	Rotation Specify start rotation, if unspecified, then random.
protected java.lang.Boolean	ShouldLeadTarget When firing slow projectiles (missiles...), if the engine will try to count the impact point for the bot or not (when shooting at moving targets).
protected java.lang.String	Skin Sets the bot current skin (e.g.
protected java.lang.Integer	Team Preferred team.

Constructor Summary

Initialize()
Creates new instance of command Initialize.

Initialize(Initialize original)
Cloning constructor.

Initialize(java.lang.String Name, java.lang.Integer Team, java.lang.Boolean ManualSpawn, java.lang.Boolean AutoTrace, Location Location, Rotation Rotation, java.lang.String Skin, java.lang.Integer DesiredSkill, java.lang.Boolean ShouldLeadTarget, java.lang.Boolean AutoPickupOff, java.lang.String Jmx, java.lang.String ClassName)
Creates new instance of command Initialize.

Method Summary

java.lang.String	getClassName() Sets the Unreal Tournament class of the bot that should be used.
java.lang.Integer	getDesiredSkill() Can range from 0 to 7.
java.lang.String	getJmx() Sets the jmx adress we can use to debug the bot from Java (if we are using Pogamut).
Location	getLocation() Specify start location, if unspecified, then random.
java.lang.String	getName() Desired name.
Rotation	getRotation() Specify start rotation, if unspecified, then random.
java.lang.String	getSkin() Sets the bot current skin (e.g.
java.lang.Integer	getTeam() Preferred team.
java.lang.Boolean	isAutoPickupOff() It enables/disables automatic pickup of the bot.
java.lang.Boolean	isAutoTrace() Enables/disables auto ray tracing feature.
java.lang.Boolean	isManualSpawn() Sets if the bot wil have tol be respawned after death manually by RESPAWN command.
java.lang.Boolean	isShouldLeadTarget() When firing slow projectiles (missiles...), if the engine will try to count the impact point for the bot or not (when shooting at moving targets).
Initialize	setAutoPickupOff(java.lang.Boolean AutoPickupOff) It enables/disables automatic pickup of the bot.
Initialize	setAutoTrace(java.lang.Boolean AutoTrace) Enables/disables auto ray tracing feature.
Initialize	setClassName(java.lang.String ClassName) Sets the Unreal Tournament class of the bot that should be used.
Initialize	setDesiredSkill(java.lang.Integer DesiredSkill) Can range from 0 to 7.
Initialize	setJmx(java.lang.String Jmx) Sets the jmx adress we can use to debug the bot from Java (if we are using Pogamut).
Initialize	setLocation(Location Location) Specify start location, if unspecified, then random.
Initialize	setManualSpawn(java.lang.Boolean ManualSpawn) Sets if the bot wil have tol be respawned after death manually by RESPAWN command.
Initialize	setName(java.lang.String Name) Desired name.
Initialize	setRotation(Rotation Rotation) Specify start rotation, if unspecified, then random.
Initialize	setShouldLeadTarget(java.lang.Boolean ShouldLeadTarget) When firing slow projectiles (missiles...), if the engine will try to count the impact point for the bot or not (when shooting at moving targets).
Initialize	setSkin(java.lang.String Skin) Sets the bot current skin (e.g.
Initialize	setTeam(java.lang.Integer Team) Preferred team.
java.lang.String	toHtmlString()
java.lang.String	toMessage()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROTOTYPE

public static final java.lang.String PROTOTYPE

Example how the message looks like - used during parser tests.

See Also:

Constant Field Values

Name

protected java.lang.String Name

Desired name.

Team

protected java.lang.Integer Team

Preferred team. If illegal or no team provided, one will be provided for you. Normally a team game has team 0 and team 1. In BotDeathMatch, team is meaningless.

ManualSpawn

protected java.lang.Boolean ManualSpawn

Sets if the bot wil have tol be respawned after death manually by RESPAWN command. If false, the bot will respawn automatically.

AutoTrace

protected java.lang.Boolean AutoTrace

Enables/disables auto ray tracing feature.

Location

protected Location Location

Specify start location, if unspecified, then random.

Rotation

protected Rotation Rotation

Specify start rotation, if unspecified, then random.

Skin

protected java.lang.String Skin

Sets the bot current skin (e.g. "HumanMaleA.MercMaleA"). Find all packages and skins through unrealEd (Actor browser, search in UT2004/Animations folder). Supported bot skins are Aliens (Aliens.), Bots (Bot.), human males (HumanMaleA.), human females (HumanFemaleA. ), juggernauts (Jugg.). Skaarj skins are not supported at the time being.

DesiredSkill

protected java.lang.Integer DesiredSkill

Can range from 0 to 7. This sets the bot accuracy. 1 lowest, 7 highest. Shouldn't have any other effect.

ShouldLeadTarget

protected java.lang.Boolean ShouldLeadTarget

When firing slow projectiles (missiles...), if the engine will try to count the impact point for the bot or not (when shooting at moving targets).

AutoPickupOff

protected java.lang.Boolean AutoPickupOff

It enables/disables automatic pickup of the bot. If true the items can be picked up through PICK command.

Jmx

protected java.lang.String Jmx

Sets the jmx adress we can use to debug the bot from Java (if we are using Pogamut).

ClassName

protected java.lang.String ClassName

Sets the Unreal Tournament class of the bot that should be used. By default leave it blank. In UnrealRuntime2 it may be used to spawn bots of different class.

Constructor Detail

Initialize

public Initialize(java.lang.String Name,
                  java.lang.Integer Team,
                  java.lang.Boolean ManualSpawn,
                  java.lang.Boolean AutoTrace,
                  Location Location,
                  Rotation Rotation,
                  java.lang.String Skin,
                  java.lang.Integer DesiredSkill,
                  java.lang.Boolean ShouldLeadTarget,
                  java.lang.Boolean AutoPickupOff,
                  java.lang.String Jmx,
                  java.lang.String ClassName)

Creates new instance of command Initialize. Message you'll send at the beginning of the communication to create a bot in the game. You must send this message before you can have a character to play in the game. Corresponding GameBots message for this command is INIT.

Parameters:

Name - Desired name.

Team - Preferred team. If illegal or no team provided, one will be provided for you. Normally a team game has team 0 and team 1. In BotDeathMatch, team is meaningless.

ManualSpawn - Sets if the bot wil have tol be respawned after death manually by RESPAWN command. If false, the bot will respawn automatically.

AutoTrace - Enables/disables auto ray tracing feature.

Location - Specify start location, if unspecified, then random.

Rotation - Specify start rotation, if unspecified, then random.

Skin - Sets the bot current skin (e.g. "HumanMaleA.MercMaleA"). Find all packages and skins through unrealEd (Actor browser, search in UT2004/Animations folder). Supported bot skins are Aliens (Aliens.), Bots (Bot.), human males (HumanMaleA.), human females (HumanFemaleA. ), juggernauts (Jugg.). Skaarj skins are not supported at the time being.

DesiredSkill - Can range from 0 to 7. This sets the bot accuracy. 1 lowest, 7 highest. Shouldn't have any other effect.

ShouldLeadTarget - When firing slow projectiles (missiles...), if the engine will try to count the impact point for the bot or not (when shooting at moving targets).

AutoPickupOff - It enables/disables automatic pickup of the bot. If true the items can be picked up through PICK command.

Jmx - Sets the jmx adress we can use to debug the bot from Java (if we are using Pogamut).

ClassName - Sets the Unreal Tournament class of the bot that should be used. By default leave it blank. In UnrealRuntime2 it may be used to spawn bots of different class.

Initialize

public Initialize()

Creates new instance of command Initialize. Message you'll send at the beginning of the communication to create a bot in the game. You must send this message before you can have a character to play in the game. Corresponding GameBots message for this command is INIT.

WARNING: this is empty-command constructor, you have to use setters to fill it up with data that should be sent to GameBots2004!

Initialize

public Initialize(Initialize original)

Cloning constructor.

Parameters:

original -

Method Detail

getName

public java.lang.String getName()

Desired name.

setName

public Initialize setName(java.lang.String Name)

Desired name.

getTeam

public java.lang.Integer getTeam()

Preferred team. If illegal or no team provided, one will be provided for you. Normally a team game has team 0 and team 1. In BotDeathMatch, team is meaningless.

setTeam

public Initialize setTeam(java.lang.Integer Team)

Preferred team. If illegal or no team provided, one will be provided for you. Normally a team game has team 0 and team 1. In BotDeathMatch, team is meaningless.

isManualSpawn

public java.lang.Boolean isManualSpawn()

Sets if the bot wil have tol be respawned after death manually by RESPAWN command. If false, the bot will respawn automatically.

setManualSpawn

public Initialize setManualSpawn(java.lang.Boolean ManualSpawn)

Sets if the bot wil have tol be respawned after death manually by RESPAWN command. If false, the bot will respawn automatically.

isAutoTrace

public java.lang.Boolean isAutoTrace()

Enables/disables auto ray tracing feature.

setAutoTrace

public Initialize setAutoTrace(java.lang.Boolean AutoTrace)

Enables/disables auto ray tracing feature.

getLocation

public Location getLocation()

Specify start location, if unspecified, then random.

setLocation

public Initialize setLocation(Location Location)

Specify start location, if unspecified, then random.

getRotation

public Rotation getRotation()

Specify start rotation, if unspecified, then random.

setRotation

public Initialize setRotation(Rotation Rotation)

Specify start rotation, if unspecified, then random.

getSkin

public java.lang.String getSkin()

Sets the bot current skin (e.g. "HumanMaleA.MercMaleA"). Find all packages and skins through unrealEd (Actor browser, search in UT2004/Animations folder). Supported bot skins are Aliens (Aliens.), Bots (Bot.), human males (HumanMaleA.), human females (HumanFemaleA. ), juggernauts (Jugg.). Skaarj skins are not supported at the time being.

setSkin

public Initialize setSkin(java.lang.String Skin)

Sets the bot current skin (e.g. "HumanMaleA.MercMaleA"). Find all packages and skins through unrealEd (Actor browser, search in UT2004/Animations folder). Supported bot skins are Aliens (Aliens.), Bots (Bot.), human males (HumanMaleA.), human females (HumanFemaleA. ), juggernauts (Jugg.). Skaarj skins are not supported at the time being.

getDesiredSkill

public java.lang.Integer getDesiredSkill()

Can range from 0 to 7. This sets the bot accuracy. 1 lowest, 7 highest. Shouldn't have any other effect.

setDesiredSkill

public Initialize setDesiredSkill(java.lang.Integer DesiredSkill)

Can range from 0 to 7. This sets the bot accuracy. 1 lowest, 7 highest. Shouldn't have any other effect.

isShouldLeadTarget

public java.lang.Boolean isShouldLeadTarget()

When firing slow projectiles (missiles...), if the engine will try to count the impact point for the bot or not (when shooting at moving targets).

setShouldLeadTarget

public Initialize setShouldLeadTarget(java.lang.Boolean ShouldLeadTarget)

When firing slow projectiles (missiles...), if the engine will try to count the impact point for the bot or not (when shooting at moving targets).

isAutoPickupOff

public java.lang.Boolean isAutoPickupOff()

It enables/disables automatic pickup of the bot. If true the items can be picked up through PICK command.

setAutoPickupOff

public Initialize setAutoPickupOff(java.lang.Boolean AutoPickupOff)

It enables/disables automatic pickup of the bot. If true the items can be picked up through PICK command.

getJmx

public java.lang.String getJmx()

Sets the jmx adress we can use to debug the bot from Java (if we are using Pogamut).

setJmx

public Initialize setJmx(java.lang.String Jmx)

Sets the jmx adress we can use to debug the bot from Java (if we are using Pogamut).

getClassName

public java.lang.String getClassName()

Sets the Unreal Tournament class of the bot that should be used. By default leave it blank. In UnrealRuntime2 it may be used to spawn bots of different class.

setClassName

public Initialize setClassName(java.lang.String ClassName)

Sets the Unreal Tournament class of the bot that should be used. By default leave it blank. In UnrealRuntime2 it may be used to spawn bots of different class.

toString

public java.lang.String toString()

Overrides:

toString in class CommandMessage

toHtmlString

public java.lang.String toHtmlString()

toMessage

public java.lang.String toMessage()