ConfigChangeMessage (pogamut-ut2004 3.3.1-SNAPSHOT API)

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldObjectUpdatedEvent, IWorldEvent, IWorldObject, ICompositeWorldObjectUpdatedEvent, ICompositeWorldObject, cz.cuni.amis.utils.listener.Event
```
public class ConfigChangeMessage
extends ConfigChange
implements IWorldObjectUpdatedEvent, ICompositeWorldObjectUpdatedEvent
```
Implementation of the GameBots2004 message CONFCH contains also its Local/Shared/Static subpart class definitions..
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

Nested Classes
Modifier and Type	Class and Description
`class`	`ConfigChangeMessage.ConfigChangeLocalMessage` Implementation of the local part of the GameBots2004 message CONFCH, used to facade CONFCHMessage.
`class`	`ConfigChangeMessage.ConfigChangeSharedMessage` Implementation of the shared part of the GameBots2004 message CONFCH, used to facade CONFCHMessage.
`class`	`ConfigChangeMessage.ConfigChangeStaticMessage` Implementation of the static part of the GameBots2004 message CONFCH, used to facade CONFCHMessage.

Nested classes/interfaces inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ConfigChange
ConfigChange.ConfigChangeUpdate

Nested classes/interfaces inherited from interface cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdatedEvent
IWorldObjectUpdatedEvent.DestroyWorldObject

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`Action` Name of current BDI action.
`protected boolean`	`Action_Set` Whether property 'Action' was received from GB2004.
`protected boolean`	`AutoPickupOff` It enables/disables automatic pickup of the bot.
`protected boolean`	`AutoPickupOff_Set` Whether property 'AutoPickupOff' was received from GB2004.
`protected boolean`	`AutoTrace` True if the bot is using auto ray tracing (is provided with synchronous ATR messages).
`protected boolean`	`AutoTrace_Set` Whether property 'AutoTrace' was received from GB2004.
`protected UnrealId`	`BotId` Unique Id of the bot.
`protected boolean`	`BotId_Set` Whether property 'BotId' was received from GB2004.
`protected boolean`	`DrawTraceLines` if the GB should draw lines representing the auto ray traces of the bot (for more information see ATR message).
`protected boolean`	`DrawTraceLines_Set` Whether property 'DrawTraceLines' was received from GB2004.
`protected UnrealId`	`Id` Id of this config message.
`protected boolean`	`Id_Set` Whether property 'Id' was received from GB2004.
`protected boolean`	`Invulnerable` If bot is invulnerable (cannot die) or not.
`protected boolean`	`Invulnerable_Set` Whether property 'Invulnerable' was received from GB2004.
`protected boolean`	`ManualSpawn` True if we have to spawn the bot manually after each death
`protected boolean`	`ManualSpawn_Set` Whether property 'ManualSpawn' was received from GB2004.
`protected String`	`Name` The bot's name.
`protected boolean`	`Name_Set` Whether property 'Name' was received from GB2004.
`protected Rotation`	`RotationRate` Bot rotation rate.
`protected boolean`	`RotationRate_Set` Whether property 'RotationRate' was received from GB2004.
`protected boolean`	`ShowDebug` If some additional debug information will be shown in the UT2004 server console window.
`protected boolean`	`ShowDebug_Set` Whether property 'ShowDebug' was received from GB2004.
`protected boolean`	`ShowFocalPoint` If true an actor visualizing the location the bot is actually looking at will appear in the game.
`protected boolean`	`ShowFocalPoint_Set` Whether property 'ShowFocalPoint' was received from GB2004.
`protected double`	`SpeedMultiplier` Bots default speed will be multiplied by this number.
`protected boolean`	`SpeedMultiplier_Set` Whether property 'SpeedMultiplier' was received from GB2004.
`protected boolean`	`SynchronousOff` It informs if sending of all GB synchronous messages is enabled or disabled.
`protected boolean`	`SynchronousOff_Set` Whether property 'SynchronousOff' was received from GB2004.
`protected ITeamId`	`TeamId`
`protected double`	`VisionTime` The delay between two synchronous batches (can range from 0.1 to 2 seconds).
`protected boolean`	`VisionTime_Set` Whether property 'VisionTime' was received from GB2004.

Fields inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ConfigChange
PROTOTYPE, SimTime

Constructor Summary

Constructors
Constructor and Description
`ConfigChangeMessage()` Parameter-less contructor for the message.
`ConfigChangeMessage(ConfigChangeMessage original)` Cloning constructor from the full message.
`ConfigChangeMessage(UnrealId Id, UnrealId BotId, boolean ManualSpawn, boolean AutoTrace, String Name, double SpeedMultiplier, Rotation RotationRate, boolean Invulnerable, double VisionTime, boolean ShowDebug, boolean ShowFocalPoint, boolean DrawTraceLines, boolean SynchronousOff, boolean AutoPickupOff, String Action)` Creates new instance of the message ConfigChange.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAction()` Name of current BDI action.
`UnrealId`	`getBotId()` Unique Id of the bot.
`UnrealId`	`getId()` Id of this config message.
`ConfigChangeLocal`	`getLocal()`
`ILocalWorldObjectUpdatedEvent`	`getLocalEvent()`
`String`	`getName()` The bot's name.
`Rotation`	`getRotationRate()` Bot rotation rate.
`ConfigChangeShared`	`getShared()`
`ISharedWorldObjectUpdatedEvent`	`getSharedEvent()`
`double`	`getSpeedMultiplier()` Bots default speed will be multiplied by this number.
`ConfigChangeStatic`	`getStatic()`
`IStaticWorldObjectUpdatedEvent`	`getStaticEvent()`
`ITeamId`	`getTeamId()`
`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.
`protected void`	`setTeamId(ITeamId TeamId)` Used by Yylex to slip corretn TeamId.
`String`	`toHtmlString()`
`String`	`toString()`
`IWorldObjectUpdateResult<IWorldObject>`	`update(IWorldObject object)`

Methods inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ConfigChange
getSimTime, setSimTime, toJsonLiteral

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.base.communication.translator.event.IWorldChangeEvent
getSimTime

- Field Detail
  - TeamId
```
protected ITeamId TeamId
```
  - Id
```
protected UnrealId Id
```
    Id of this config message. This Id is generated from BotId, string "_CONFCH" is added at the end.
  - Id_Set
```
protected boolean Id_Set
```
    Whether property 'Id' was received from GB2004.
  - BotId
```
protected UnrealId BotId
```
    Unique Id of the bot.
  - BotId_Set
```
protected boolean BotId_Set
```
    Whether property 'BotId' was received from GB2004.
  - ManualSpawn
```
protected boolean ManualSpawn
```
    True if we have to spawn the bot manually after each death
  - ManualSpawn_Set
```
protected boolean ManualSpawn_Set
```
    Whether property 'ManualSpawn' was received from GB2004.
  - 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.
  - AutoTrace_Set
```
protected boolean AutoTrace_Set
```
    Whether property 'AutoTrace' was received from GB2004.
  - Name
```
protected String Name
```
    The bot's name.
  - Name_Set
```
protected boolean Name_Set
```
    Whether property 'Name' was received from GB2004.
  - 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).
  - SpeedMultiplier_Set
```
protected boolean SpeedMultiplier_Set
```
    Whether property 'SpeedMultiplier' was received from GB2004.
  - 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)
  - RotationRate_Set
```
protected boolean RotationRate_Set
```
    Whether property 'RotationRate' was received from GB2004.
  - Invulnerable
```
protected boolean Invulnerable
```
    If bot is invulnerable (cannot die) or not.
  - Invulnerable_Set
```
protected boolean Invulnerable_Set
```
    Whether property 'Invulnerable' was received from GB2004.
  - VisionTime
```
protected double VisionTime
```
    The delay between two synchronous batches (can range from 0.1 to 2 seconds).
  - VisionTime_Set
```
protected boolean VisionTime_Set
```
    Whether property 'VisionTime' was received from GB2004.
  - ShowDebug
```
protected boolean ShowDebug
```
    If some additional debug information will be shown in the UT2004 server console window.
  - ShowDebug_Set
```
protected boolean ShowDebug_Set
```
    Whether property 'ShowDebug' was received from GB2004.
  - ShowFocalPoint
```
protected boolean ShowFocalPoint
```
    If true an actor visualizing the location the bot is actually looking at will appear in the game.
  - ShowFocalPoint_Set
```
protected boolean ShowFocalPoint_Set
```
    Whether property 'ShowFocalPoint' was received from GB2004.
  - DrawTraceLines
```
protected boolean DrawTraceLines
```
    if the GB should draw lines representing the auto ray traces of the bot (for more information see ATR message).
  - DrawTraceLines_Set
```
protected boolean DrawTraceLines_Set
```
    Whether property 'DrawTraceLines' was received from GB2004.
  - SynchronousOff
```
protected boolean SynchronousOff
```
    It informs if sending of all GB synchronous messages is enabled or disabled.
  - SynchronousOff_Set
```
protected boolean SynchronousOff_Set
```
    Whether property 'SynchronousOff' was received from GB2004.
  - AutoPickupOff
```
protected boolean AutoPickupOff
```
    It enables/disables automatic pickup of the bot. If true the items can be picked up through PICK command.
  - AutoPickupOff_Set
```
protected boolean AutoPickupOff_Set
```
    Whether property 'AutoPickupOff' was received from GB2004.
  - Action
```
protected String Action
```
    Name of current BDI action.
  - Action_Set
```
protected boolean Action_Set
```
    Whether property 'Action' was received from GB2004.
- Constructor Detail
  - ConfigChangeMessage
```
public ConfigChangeMessage()
```
    Parameter-less contructor for the message.
  - ConfigChangeMessage
```
public ConfigChangeMessage(UnrealId Id,
                   UnrealId BotId,
                   boolean ManualSpawn,
                   boolean AutoTrace,
                   String Name,
                   double SpeedMultiplier,
                   Rotation RotationRate,
                   boolean Invulnerable,
                   double VisionTime,
                   boolean ShowDebug,
                   boolean ShowFocalPoint,
                   boolean DrawTraceLines,
                   boolean SynchronousOff,
                   boolean AutoPickupOff,
                   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 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.
  - ConfigChangeMessage
```
public ConfigChangeMessage(ConfigChangeMessage original)
```
    Cloning constructor from the full message.
    
    Parameters:
    original -
- Method Detail
  - setTeamId
```
protected void setTeamId(ITeamId TeamId)
```
    Used by Yylex to slip corretn TeamId.
  - getTeamId
```
public ITeamId getTeamId()
```
  - getId
```
public UnrealId getId()
```
    Description copied from class: ConfigChange
    
    Id of this config message. This Id is generated from BotId, string "_CONFCH" is added at the end.
    
    Specified by:
    
    getId in interface IWorldObjectUpdatedEvent
    
    Specified by:
    
    getId in interface IWorldObject
    
    Specified by:
    
    getId in interface ICompositeWorldObjectUpdatedEvent
    
    Specified by:
    
    getId in class ConfigChange
  - getBotId
```
public UnrealId getBotId()
```
    Description copied from class: ConfigChange
    
    Unique Id of the bot.
    
    Specified by:
    
    getBotId in class ConfigChange
  - isManualSpawn
```
public boolean isManualSpawn()
```
    Description copied from class: ConfigChange
    
    True if we have to spawn the bot manually after each death
    
    Specified by:
    
    isManualSpawn in class ConfigChange
  - isAutoTrace
```
public boolean isAutoTrace()
```
    Description copied from class: ConfigChange
    
    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 ConfigChange
  - getName
```
public String getName()
```
    Description copied from class: ConfigChange
    
    The bot's name.
    
    Specified by:
    
    getName in class ConfigChange
  - getSpeedMultiplier
```
public double getSpeedMultiplier()
```
    Description copied from class: ConfigChange
    
    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 ConfigChange
  - getRotationRate
```
public Rotation getRotationRate()
```
    Description copied from class: ConfigChange
    
    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 ConfigChange
  - isInvulnerable
```
public boolean isInvulnerable()
```
    Description copied from class: ConfigChange
    
    If bot is invulnerable (cannot die) or not.
    
    Specified by:
    
    isInvulnerable in class ConfigChange
  - getVisionTime
```
public double getVisionTime()
```
    Description copied from class: ConfigChange
    
    The delay between two synchronous batches (can range from 0.1 to 2 seconds).
    
    Specified by:
    
    getVisionTime in class ConfigChange
  - isShowDebug
```
public boolean isShowDebug()
```
    Description copied from class: ConfigChange
    
    If some additional debug information will be shown in the UT2004 server console window.
    
    Specified by:
    
    isShowDebug in class ConfigChange
  - isShowFocalPoint
```
public boolean isShowFocalPoint()
```
    Description copied from class: ConfigChange
    
    If true an actor visualizing the location the bot is actually looking at will appear in the game.
    
    Specified by:
    
    isShowFocalPoint in class ConfigChange
  - isDrawTraceLines
```
public boolean isDrawTraceLines()
```
    Description copied from class: ConfigChange
    
    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 ConfigChange
  - isSynchronousOff
```
public boolean isSynchronousOff()
```
    Description copied from class: ConfigChange
    
    It informs if sending of all GB synchronous messages is enabled or disabled.
    
    Specified by:
    
    isSynchronousOff in class ConfigChange
  - isAutoPickupOff
```
public boolean isAutoPickupOff()
```
    Description copied from class: ConfigChange
    
    It enables/disables automatic pickup of the bot. If true the items can be picked up through PICK command.
    
    Specified by:
    
    isAutoPickupOff in class ConfigChange
  - getAction
```
public String getAction()
```
    Description copied from class: ConfigChange
    
    Name of current BDI action.
    
    Specified by:
    
    getAction in class ConfigChange
  - getLocal
```
public ConfigChangeLocal getLocal()
```
    Specified by:
    
    getLocal in interface ICompositeWorldObject
  - getShared
```
public ConfigChangeShared getShared()
```
    Specified by:
    
    getShared in interface ICompositeWorldObject
  - getStatic
```
public ConfigChangeStatic getStatic()
```
    Specified by:
    
    getStatic in interface ICompositeWorldObject
  - update
```
public IWorldObjectUpdateResult<IWorldObject> update(IWorldObject object)
```
    Specified by:
    
    update in interface IWorldObjectUpdatedEvent
  - getLocalEvent
```
public ILocalWorldObjectUpdatedEvent getLocalEvent()
```
    Specified by:
    
    getLocalEvent in interface ICompositeWorldObjectUpdatedEvent
  - getSharedEvent
```
public ISharedWorldObjectUpdatedEvent getSharedEvent()
```
    Specified by:
    
    getSharedEvent in interface ICompositeWorldObjectUpdatedEvent
  - getStaticEvent
```
public IStaticWorldObjectUpdatedEvent getStaticEvent()
```
    Specified by:
    
    getStaticEvent in interface ICompositeWorldObjectUpdatedEvent
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class ConfigChange
  - toHtmlString
```
public String toHtmlString()
```
    Overrides:
    
    toHtmlString in class ConfigChange

Class ConfigChangeMessage

Nested Class Summary

Nested classes/interfaces inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ConfigChange

Nested classes/interfaces inherited from interface cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdatedEvent

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface cz.cuni.amis.pogamut.base.communication.translator.event.IWorldChangeEvent

Field Detail

TeamId

Id

Id_Set

BotId

BotId_Set

ManualSpawn

ManualSpawn_Set

AutoTrace

AutoTrace_Set

Name

Name_Set

SpeedMultiplier

SpeedMultiplier_Set

RotationRate

RotationRate_Set

Invulnerable

Invulnerable_Set

VisionTime

VisionTime_Set

ShowDebug

ShowDebug_Set

ShowFocalPoint

ShowFocalPoint_Set

DrawTraceLines

DrawTraceLines_Set

SynchronousOff

SynchronousOff_Set

AutoPickupOff

AutoPickupOff_Set

Action

Action_Set

Constructor Detail

ConfigChangeMessage

ConfigChangeMessage

ConfigChangeMessage

Method Detail

setTeamId

getTeamId

getId

getBotId

isManualSpawn

isAutoTrace

getName

getSpeedMultiplier

getRotationRate

isInvulnerable

getVisionTime

isShowDebug

isShowFocalPoint

isDrawTraceLines

isSynchronousOff

isAutoPickupOff

getAction

getLocal

getShared

getStatic

update

getLocalEvent

getSharedEvent

getStaticEvent

toString

toHtmlString