cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages
Class ConfigChangeLocalImpl

java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ConfigChangeLocal
          extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ConfigChangeLocalImpl
All Implemented Interfaces:
IWorldObject, ILocalWorldObject, java.lang.Cloneable

public class ConfigChangeLocalImpl
extends ConfigChangeLocal

Implementation of the local part of the GameBots2004 message CONFCH.

Complete message documentation: Asynchronous message. Message sent when the bot configuration changed - each agent has a lot of parameters affecting his state in the environment. See each property for the details.


Nested Class Summary
static class ConfigChangeLocalImpl.ConfigChangeLocalUpdate
           
 
Field Summary
protected  java.lang.String Action
          Name of current BDI action.
protected  boolean AutoPickupOff
          It enables/disables automatic pickup of the bot.
protected  boolean AutoTrace
          True if the bot is using auto ray tracing (is provided with synchronous ATR messages).
protected  UnrealId BotId
          Unique Id of the bot.
protected  boolean DrawTraceLines
          if the GB should draw lines representing the auto ray traces of the bot (for more information see ATR message).
protected  UnrealId Id
          Id of this config message.
protected  boolean Invulnerable
          If bot is invulnerable (cannot die) or not.
protected  boolean ManualSpawn
          True if we have to spawn the bot manually after each death
protected  java.lang.String Name
          The bot's name.
protected  Rotation RotationRate
          Bot rotation rate.
protected  boolean ShowDebug
          If some additional debug information will be shown in the UT2004 server console window.
protected  boolean ShowFocalPoint
          If true an actor visualizing the location the bot is actually looking at will appear in the game.
protected  double SpeedMultiplier
          Bots default speed will be multiplied by this number.
protected  boolean SynchronousOff
          It informs if sending of all GB synchronous messages is enabled or disabled.
protected  double VisionTime
          The delay between two synchronous batches (can range from 0.1 to 2 seconds).
 
Fields inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ConfigChangeLocal
SimTime
 
Constructor Summary
ConfigChangeLocalImpl()
          Parameter-less contructor for the message.
ConfigChangeLocalImpl(ConfigChange original)
          Cloning constructor from the full message.
ConfigChangeLocalImpl(ConfigChangeLocal original)
          Cloning constructor from the message part.
ConfigChangeLocalImpl(ConfigChangeLocalImpl original)
          Cloning constructor from the full message.
ConfigChangeLocalImpl(UnrealId Id, UnrealId BotId, boolean ManualSpawn, boolean AutoTrace, java.lang.String Name, double SpeedMultiplier, Rotation RotationRate, boolean Invulnerable, double VisionTime, boolean ShowDebug, boolean ShowFocalPoint, boolean DrawTraceLines, boolean SynchronousOff, boolean AutoPickupOff, java.lang.String Action)
          Creates new instance of the message ConfigChange.
 
Method Summary
 ConfigChangeLocalImpl clone()
           
 java.lang.String getAction()
          Name of current BDI action.
 UnrealId getBotId()
          Unique Id of the bot.
 UnrealId getId()
          Id of this config message.
 ConfigChangeLocalImpl getLocal()
           
 java.lang.String getName()
          The bot's name.
 Rotation getRotationRate()
          Bot rotation rate.
 ISharedWorldObject getShared()
           
 double getSpeedMultiplier()
          Bots default speed will be multiplied by this number.
 IStaticWorldObject getStatic()
           
 double getVisionTime()
          The delay between two synchronous batches (can range from 0.1 to 2 seconds).
 boolean isAutoPickupOff()
          It enables/disables automatic pickup of the bot.
 boolean isAutoTrace()
          True if the bot is using auto ray tracing (is provided with synchronous ATR messages).
 boolean isDrawTraceLines()
          if the GB should draw lines representing the auto ray traces of the bot (for more information see ATR message).
 boolean isInvulnerable()
          If bot is invulnerable (cannot die) or not.
 boolean isManualSpawn()
          True if we have to spawn the bot manually after each death
 boolean isShowDebug()
          If some additional debug information will be shown in the UT2004 server console window.
 boolean isShowFocalPoint()
          If true an actor visualizing the location the bot is actually looking at will appear in the game.
 boolean isSynchronousOff()
          It informs if sending of all GB synchronous messages is enabled or disabled.
 void setSimTime(long SimTime)
          Used by Yylex to slip correct time of the object or programmatically.
 java.lang.String toHtmlString()
           
 java.lang.String toString()
           
 
Methods inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ConfigChangeLocal
getCompositeClass, getSimTime
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

Id

protected UnrealId Id
Id of this config message. This Id is generated from BotId, string "_CONFCH" is added at the end.


BotId

protected UnrealId BotId
Unique Id of the bot.


ManualSpawn

protected boolean ManualSpawn
True if we have to spawn the bot manually after each death


AutoTrace

protected boolean AutoTrace
True if the bot is using auto ray tracing (is provided with synchronous ATR messages). See ATR messages for more details.


Name

protected java.lang.String Name
The bot's name.


SpeedMultiplier

protected double SpeedMultiplier
Bots default speed will be multiplied by this number. Ranges from 0.1 to 2 (default, can be set in ini in [GameBots2004.RemoteBot] MaxSpeed).


RotationRate

protected Rotation RotationRate
Bot rotation rate. Default rotation rate is: (Pitch=3072,Yaw=60000,Roll=2048) and may be configured in ini file in [GameBots2004.RemoteBot] DefaultRotationRate. (pitch - up/down, yaw - left/right, roll - equivalent of doing a cartwheel)


Invulnerable

protected boolean Invulnerable
If bot is invulnerable (cannot die) or not.


VisionTime

protected double VisionTime
The delay between two synchronous batches (can range from 0.1 to 2 seconds).


ShowDebug

protected boolean ShowDebug
If some additional debug information will be shown in the UT2004 server console window.


ShowFocalPoint

protected boolean ShowFocalPoint
If true an actor visualizing the location the bot is actually looking at will appear in the game.


DrawTraceLines

protected boolean DrawTraceLines
if the GB should draw lines representing the auto ray traces of the bot (for more information see ATR message).


SynchronousOff

protected boolean SynchronousOff
It informs if sending of all GB synchronous messages is enabled or disabled.


AutoPickupOff

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


Action

protected java.lang.String Action
Name of current BDI action.

Constructor Detail

ConfigChangeLocalImpl

public ConfigChangeLocalImpl()
Parameter-less contructor for the message.


ConfigChangeLocalImpl

public ConfigChangeLocalImpl(UnrealId Id,
                             UnrealId BotId,
                             boolean ManualSpawn,
                             boolean AutoTrace,
                             java.lang.String Name,
                             double SpeedMultiplier,
                             Rotation RotationRate,
                             boolean Invulnerable,
                             double VisionTime,
                             boolean ShowDebug,
                             boolean ShowFocalPoint,
                             boolean DrawTraceLines,
                             boolean SynchronousOff,
                             boolean AutoPickupOff,
                             java.lang.String Action)
Creates new instance of the message ConfigChange. Asynchronous message. Message sent when the bot configuration changed - each agent has a lot of parameters affecting his state in the environment. See each property for the details. Corresponding GameBots message (local part) is CONFCH.

Parameters:
Id - Id of this config message. This Id is generated from BotId, string "_CONFCH" is added at the end.
BotId - Unique Id of the bot.
ManualSpawn - True if we have to spawn the bot manually after each death
AutoTrace - True if the bot is using auto ray tracing (is provided with synchronous ATR messages). See ATR messages for more details.
Name - The bot's name.
SpeedMultiplier - Bots default speed will be multiplied by this number. Ranges from 0.1 to 2 (default, can be set in ini in [GameBots2004.RemoteBot] MaxSpeed).
RotationRate - Bot rotation rate. Default rotation rate is: (Pitch=3072,Yaw=60000,Roll=2048) and may be configured in ini file in [GameBots2004.RemoteBot] DefaultRotationRate. (pitch - up/down, yaw - left/right, roll - equivalent of doing a cartwheel)
Invulnerable - If bot is invulnerable (cannot die) or not.
VisionTime - The delay between two synchronous batches (can range from 0.1 to 2 seconds).
ShowDebug - If some additional debug information will be shown in the UT2004 server console window.
ShowFocalPoint - If true an actor visualizing the location the bot is actually looking at will appear in the game.
DrawTraceLines - if the GB should draw lines representing the auto ray traces of the bot (for more information see ATR message).
SynchronousOff - It informs if sending of all GB synchronous messages is enabled or disabled.
AutoPickupOff - It enables/disables automatic pickup of the bot. If true the items can be picked up through PICK command.
Action - Name of current BDI action.

ConfigChangeLocalImpl

public ConfigChangeLocalImpl(ConfigChange original)
Cloning constructor from the full message.

Parameters:
original -

ConfigChangeLocalImpl

public ConfigChangeLocalImpl(ConfigChangeLocalImpl original)
Cloning constructor from the full message.

Parameters:
original -

ConfigChangeLocalImpl

public ConfigChangeLocalImpl(ConfigChangeLocal original)
Cloning constructor from the message part.

Parameters:
original -
Method Detail

setSimTime

public void setSimTime(long SimTime)
Description copied from class: ConfigChangeLocal
Used by Yylex to slip correct time of the object or programmatically.

Overrides:
setSimTime in class ConfigChangeLocal

clone

public ConfigChangeLocalImpl clone()
Specified by:
clone in interface ILocalWorldObject
Specified by:
clone in class ConfigChangeLocal

getId

public UnrealId getId()
Id of this config message. This Id is generated from BotId, string "_CONFCH" is added at the end.

Specified by:
getId in interface IWorldObject
Specified by:
getId in class ConfigChangeLocal
Returns:

getBotId

public UnrealId getBotId()
Unique Id of the bot.

Specified by:
getBotId in class ConfigChangeLocal

isManualSpawn

public boolean isManualSpawn()
True if we have to spawn the bot manually after each death

Specified by:
isManualSpawn in class ConfigChangeLocal

isAutoTrace

public boolean isAutoTrace()
True if the bot is using auto ray tracing (is provided with synchronous ATR messages). See ATR messages for more details.

Specified by:
isAutoTrace in class ConfigChangeLocal

getName

public java.lang.String getName()
The bot's name.

Specified by:
getName in class ConfigChangeLocal

getSpeedMultiplier

public double getSpeedMultiplier()
Bots default speed will be multiplied by this number. Ranges from 0.1 to 2 (default, can be set in ini in [GameBots2004.RemoteBot] MaxSpeed).

Specified by:
getSpeedMultiplier in class ConfigChangeLocal

getRotationRate

public Rotation getRotationRate()
Bot rotation rate. Default rotation rate is: (Pitch=3072,Yaw=60000,Roll=2048) and may be configured in ini file in [GameBots2004.RemoteBot] DefaultRotationRate. (pitch - up/down, yaw - left/right, roll - equivalent of doing a cartwheel)

Specified by:
getRotationRate in class ConfigChangeLocal

isInvulnerable

public boolean isInvulnerable()
If bot is invulnerable (cannot die) or not.

Specified by:
isInvulnerable in class ConfigChangeLocal

getVisionTime

public double getVisionTime()
The delay between two synchronous batches (can range from 0.1 to 2 seconds).

Specified by:
getVisionTime in class ConfigChangeLocal

isShowDebug

public boolean isShowDebug()
If some additional debug information will be shown in the UT2004 server console window.

Specified by:
isShowDebug in class ConfigChangeLocal

isShowFocalPoint

public boolean isShowFocalPoint()
If true an actor visualizing the location the bot is actually looking at will appear in the game.

Specified by:
isShowFocalPoint in class ConfigChangeLocal

isDrawTraceLines

public boolean isDrawTraceLines()
if the GB should draw lines representing the auto ray traces of the bot (for more information see ATR message).

Specified by:
isDrawTraceLines in class ConfigChangeLocal

isSynchronousOff

public boolean isSynchronousOff()
It informs if sending of all GB synchronous messages is enabled or disabled.

Specified by:
isSynchronousOff in class ConfigChangeLocal

isAutoPickupOff

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

Specified by:
isAutoPickupOff in class ConfigChangeLocal

getAction

public java.lang.String getAction()
Name of current BDI action.

Specified by:
getAction in class ConfigChangeLocal

getLocal

public ConfigChangeLocalImpl getLocal()
Overrides:
getLocal in class ConfigChangeLocal

getShared

public ISharedWorldObject getShared()
Overrides:
getShared in class ConfigChangeLocal

getStatic

public IStaticWorldObject getStatic()
Overrides:
getStatic in class ConfigChangeLocal

toString

public java.lang.String toString()
Overrides:
toString in class ConfigChangeLocal

toHtmlString

public java.lang.String toHtmlString()
Overrides:
toHtmlString in class ConfigChangeLocal