cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages
Class ConfigChangeMessage.ConfigChangeLocalMessage

java.lang.Object
  cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ConfigChangeLocal
          cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ConfigChangeMessage.ConfigChangeLocalMessage

All Implemented Interfaces:

IWorldObject, ILocalWorldObject, Cloneable

Enclosing class:

ConfigChangeMessage

public class ConfigChangeMessage.ConfigChangeLocalMessage
extends ConfigChangeLocal

Implementation of the local part of the GameBots2004 message CONFCH, used to facade CONFCHMessage.

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.

Field Summary

Fields inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ConfigChangeLocal

SimTime

Constructor Summary

ConfigChangeMessage.ConfigChangeLocalMessage()

Method Summary

ConfigChangeMessage.ConfigChangeLocalMessage	clone()
String	getAction() Name of current BDI action.
UnrealId	getBotId() Unique Id of the bot.
UnrealId	getId() Id of this config message.
ConfigChangeMessage.ConfigChangeLocalMessage	getLocal()
int	getLocUpdateMultiplier() Holds information how many times faster is exported location update message (UPD) compared to sync.
String	getName() The bot's name.
Rotation	getRotationRate() Bot rotation rate.
double	getSelfUpdateTime() The delay between two self message synchronous batches (can range from 0.01 to 2 seconds).
ISharedWorldObject	getShared()
double	getSpeedMultiplier() Bots default speed will be multiplied by this number.
IStaticWorldObject	getStatic()
double	getVisionTime() The delay between two synchronous batches containing vision updates (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.
String	toHtmlString()
String	toString()

Methods inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ConfigChangeLocal

getCompositeClass, getSimTime, setSimTime

Methods inherited from class cz.cuni.amis.pogamut.base.communication.messages.InfoMessage

toJsonLiteral

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigChangeMessage.ConfigChangeLocalMessage

public ConfigChangeMessage.ConfigChangeLocalMessage()

Method Detail

clone

public ConfigChangeMessage.ConfigChangeLocalMessage clone()

Specified by:

clone in interface ILocalWorldObject

Specified by:

clone in class ConfigChangeLocal

getLocal

public ConfigChangeMessage.ConfigChangeLocalMessage getLocal()

Overrides:

getLocal in class ConfigChangeLocal

getShared

public ISharedWorldObject getShared()

Overrides:

getShared in class ConfigChangeLocal

getStatic

public IStaticWorldObject getStatic()

Overrides:

getStatic 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

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 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

getSelfUpdateTime

public double getSelfUpdateTime()

The delay between two self message synchronous batches (can range from 0.01 to 2 seconds). Will be used only if NewSelfBatchProtocol attribute is set to true in INIT message.

Specified by:

getSelfUpdateTime in class ConfigChangeLocal

getVisionTime

public double getVisionTime()

The delay between two synchronous batches containing vision updates (can range from 0.1 to 2 seconds). If NewSelfBatchProtocol attribute is set to true in INIT message, more batch messages containing only SELF message will arrive between two vision update batches (containing PLR,PRJ,INV.. messages).

Specified by:

getVisionTime in class ConfigChangeLocal

getLocUpdateMultiplier

public int getLocUpdateMultiplier()

Holds information how many times faster is exported location update message (UPD) compared to sync. batch, e.g. when this multiplier is set to 5 and vision time is 250 ms, UPD message will arrive every 50 ms.

Specified by:

getLocUpdateMultiplier 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 String getAction()

Name of current BDI action.

Specified by:

getAction in class ConfigChangeLocal

toString

public String toString()

Overrides:

toString in class ConfigChangeLocal

toHtmlString

public String toHtmlString()

Overrides:

toHtmlString in class ConfigChangeLocal