ConfigChangeLocalImpl (pogamut-ut2004 3.6.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

Package class diagram package ConfigChangeLocalImpl

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

All Implemented Interfaces:: IWorldObject, ILocalWorldObject, Cloneable

public class ConfigChangeLocalImpl
extends ConfigChangeLocal
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 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 int`	`LocUpdateMultiplier` 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.
`protected boolean`	`ManualSpawn` True if we have to spawn the bot manually after each death
`protected String`	`Name` The bot's name.
`protected Rotation`	`RotationRate` Bot rotation rate.
`protected double`	`SelfUpdateTime` The delay between two self message synchronous batches (can range from 0.01 to 2 seconds).
`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 containing vision updates (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, String Name, double SpeedMultiplier, Rotation RotationRate, boolean Invulnerable, double SelfUpdateTime, double VisionTime, int LocUpdateMultiplier, boolean ShowDebug, boolean ShowFocalPoint, boolean DrawTraceLines, boolean SynchronousOff, boolean AutoPickupOff, String Action)` Creates new instance of the message ConfigChange.

Method Summary
`ConfigChangeLocalImpl`	`clone()`
`String`	`getAction()` Name of current BDI action.
`UnrealId`	`getBotId()` Unique Id of the bot.
`UnrealId`	`getId()` Id of this config message.
`ConfigChangeLocalImpl`	`getLocal()`
`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.
`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.
`void`	`setSimTime(long SimTime)` Used by Yylex to slip correct time of the object or programmatically.
`String`	`toHtmlString()`
`String`	`toString()`

Methods inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ConfigChangeLocal
`getCompositeClass, getSimTime`

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`

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

SelfUpdateTime

protected double SelfUpdateTime

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.

VisionTime

protected double VisionTime

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

LocUpdateMultiplier

protected int LocUpdateMultiplier

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.

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

Name of current BDI action.

Constructor Detail