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

java.lang.Object
  cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ConfigChange

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, IWorldObject, ICompositeWorldObject, cz.cuni.amis.utils.listener.Event

Direct Known Subclasses:

ConfigChangeCompositeImpl, ConfigChangeMessage

public abstract class ConfigChange
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent, ICompositeWorldObject

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

ConfigChange.ConfigChangeUpdate

Field Summary

static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime

Constructor Summary

ConfigChange()
Parameter-less contructor for the message.

Method Summary

abstract String	getAction() Name of current BDI action.
abstract UnrealId	getBotId() Unique Id of the bot.
abstract UnrealId	getId() Id of this config message.
abstract int	getLocUpdateMultiplier() Holds information how many times faster is exported location update message (UPD) compared to sync.
abstract String	getName() The bot's name.
abstract Rotation	getRotationRate() Bot rotation rate.
abstract double	getSelfUpdateTime() The delay between two self message synchronous batches (can range from 0.01 to 2 seconds).
long	getSimTime() Simulation time in MILLI SECONDS !!!
abstract double	getSpeedMultiplier() Bots default speed will be multiplied by this number.
abstract double	getVisionTime() The delay between two synchronous batches containing vision updates (can range from 0.1 to 2 seconds).
abstract boolean	isAutoPickupOff() It enables/disables automatic pickup of the bot.
abstract boolean	isAutoTrace() True if the bot is using auto ray tracing (is provided with synchronous ATR messages).
abstract boolean	isDrawTraceLines() if the GB should draw lines representing the auto ray traces of the bot (for more information see ATR message).
abstract boolean	isInvulnerable() If bot is invulnerable (cannot die) or not.
abstract boolean	isManualSpawn() True if we have to spawn the bot manually after each death
abstract boolean	isShowDebug() If some additional debug information will be shown in the UT2004 server console window.
abstract boolean	isShowFocalPoint() If true an actor visualizing the location the bot is actually looking at will appear in the game.
abstract boolean	isSynchronousOff() It informs if sending of all GB synchronous messages is enabled or disabled.
protected void	setSimTime(long SimTime) Used by Yylex to slip correct time of the object or programmatically.
String	toHtmlString()
String	toJsonLiteral()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface cz.cuni.amis.pogamut.multi.communication.worldview.object.ICompositeWorldObject

getLocal, getShared, getStatic

Field Detail

PROTOTYPE

public static final String PROTOTYPE

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

See Also:

Constant Field Values

SimTime

protected long SimTime

Constructor Detail

ConfigChange

public ConfigChange()

Parameter-less contructor for the message.

Method Detail

getSimTime

public long getSimTime()

Simulation time in MILLI SECONDS !!!

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

Specified by:

getSimTime in interface IWorldObject

setSimTime

protected void setSimTime(long SimTime)

Used by Yylex to slip correct time of the object or programmatically.

getId

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

getBotId

public abstract UnrealId getBotId()

Unique Id of the bot.

isManualSpawn

public abstract boolean isManualSpawn()

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

isAutoTrace

public abstract boolean isAutoTrace()

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

getName

public abstract String getName()

The bot's name.

getSpeedMultiplier

public abstract 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).

getRotationRate

public abstract 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)

isInvulnerable

public abstract boolean isInvulnerable()

If bot is invulnerable (cannot die) or not.

getSelfUpdateTime

public abstract 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.

getVisionTime

public abstract 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).

getLocUpdateMultiplier

public abstract 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.

isShowDebug

public abstract boolean isShowDebug()

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

isShowFocalPoint

public abstract boolean isShowFocalPoint()

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

isDrawTraceLines

public abstract boolean isDrawTraceLines()

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

isSynchronousOff

public abstract boolean isSynchronousOff()

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

isAutoPickupOff

public abstract boolean isAutoPickupOff()

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

getAction

public abstract String getAction()

Name of current BDI action.

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()

Overrides:

toJsonLiteral in class InfoMessage