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

Package class diagram package Initialize
java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.CommandMessage
      extended by cz.cuni.amis.pogamut.udk.communication.messages.gbcommands.Initialize

public class Initialize
extends CommandMessage

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 command is INIT.


Field Summary
protected  boolean AutoPickupOff
          It enables/disables automatic pickup of the bot.
protected  boolean AutoTrace
          Enables/disables auto ray tracing feature.
protected  String ClassName
          TODO Michal, whats this?
protected  int DesiredSkill
          Can range from 0 to 7.
protected  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  boolean ManualSpawn
          Sets if the bot wil have tol be respawned after death manually by RESPAWN command.
protected  String Name
          Desired name.
protected  Rotation Rotation
          Specify start rotation, if unspecified, then random.
protected  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  String Skin
          Sets the bot current skin using UTFamilyInfo (e.g.
protected  int Team
          Preferred team.
 
Constructor Summary
Initialize()
          Creates new instance of command Initialize.
Initialize(Initialize original)
          Cloning constructor.
Initialize(String Name, int Team, boolean ManualSpawn, boolean AutoTrace, Location Location, Rotation Rotation, String Skin, int DesiredSkill, boolean ShouldLeadTarget, boolean AutoPickupOff, String Jmx, String ClassName)
          Creates new instance of command Initialize.
 
Method Summary
 String getClassName()
          TODO Michal, whats this?
 int getDesiredSkill()
          Can range from 0 to 7.
 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.
 String getName()
          Desired name.
 Rotation getRotation()
          Specify start rotation, if unspecified, then random.
 String getSkin()
          Sets the bot current skin using UTFamilyInfo (e.g.
 int getTeam()
          Preferred team.
 boolean isAutoPickupOff()
          It enables/disables automatic pickup of the bot.
 boolean isAutoTrace()
          Enables/disables auto ray tracing feature.
 boolean isManualSpawn()
          Sets if the bot wil have tol be respawned after death manually by RESPAWN command.
 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(boolean AutoPickupOff)
          It enables/disables automatic pickup of the bot.
 Initialize setAutoTrace(boolean AutoTrace)
          Enables/disables auto ray tracing feature.
 Initialize setClassName(String ClassName)
          TODO Michal, whats this?
 Initialize setDesiredSkill(int DesiredSkill)
          Can range from 0 to 7.
 Initialize setJmx(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(boolean ManualSpawn)
          Sets if the bot wil have tol be respawned after death manually by RESPAWN command.
 Initialize setName(String Name)
          Desired name.
 Initialize setRotation(Rotation Rotation)
          Specify start rotation, if unspecified, then random.
 Initialize setShouldLeadTarget(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(String Skin)
          Sets the bot current skin using UTFamilyInfo (e.g.
 Initialize setTeam(int Team)
          Preferred team.
 String toHtmlString()
           
 String toMessage()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

Name

protected String Name
Desired name.


Team

protected int 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 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 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 String Skin
Sets the bot current skin using UTFamilyInfo (e.g. "UTGame.UTFamilyInfo_Liandri_Male"). // TODO: we might want to export all possible skins at the beginning of the game


DesiredSkill

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


ShouldLeadTarget

protected 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 boolean AutoPickupOff
It enables/disables automatic pickup of the bot. If true the items can be picked up through PICK command.


Jmx

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


ClassName

protected String ClassName
TODO Michal, whats this?

Constructor Detail

Initialize

public Initialize(String Name,
                  int Team,
                  boolean ManualSpawn,
                  boolean AutoTrace,
                  Location Location,
                  Rotation Rotation,
                  String Skin,
                  int DesiredSkill,
                  boolean ShouldLeadTarget,
                  boolean AutoPickupOff,
                  String Jmx,
                  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 using UTFamilyInfo (e.g. "UTGame.UTFamilyInfo_Liandri_Male"). // TODO: we might want to export all possible skins at the beginning of the game
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 - TODO Michal, whats this?

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!


Initialize

public Initialize(Initialize original)
Cloning constructor.

Method Detail

getName

public String getName()
Desired name.


setName

public Initialize setName(String Name)
Desired name.


getTeam

public int 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(int 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 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(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 boolean isAutoTrace()
Enables/disables auto ray tracing feature.


setAutoTrace

public Initialize setAutoTrace(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 String getSkin()
Sets the bot current skin using UTFamilyInfo (e.g. "UTGame.UTFamilyInfo_Liandri_Male"). // TODO: we might want to export all possible skins at the beginning of the game


setSkin

public Initialize setSkin(String Skin)
Sets the bot current skin using UTFamilyInfo (e.g. "UTGame.UTFamilyInfo_Liandri_Male"). // TODO: we might want to export all possible skins at the beginning of the game


getDesiredSkill

public int 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(int DesiredSkill)
Can range from 0 to 7. This sets the bot accuracy. 1 lowest, 7 highest. Shouldn't have any other effect.


isShouldLeadTarget

public 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(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 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(boolean AutoPickupOff)
It enables/disables automatic pickup of the bot. If true the items can be picked up through PICK command.


getJmx

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


setJmx

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


getClassName

public String getClassName()
TODO Michal, whats this?


setClassName

public Initialize setClassName(String ClassName)
TODO Michal, whats this?


toString

public String toString()
Overrides:
toString in class CommandMessage

toHtmlString

public String toHtmlString()

toMessage

public String toMessage()


Copyright © 2014 AMIS research group, Faculty of Mathematics and Physics, Charles University in Prague, Czech Republic. All Rights Reserved.