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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldObjectUpdatedEvent, IWorldObject, IGBWorldObjectEvent, cz.cuni.amis.utils.listener.Event

public class ConfigChange
extends GBObjectUpdate
implements IGBWorldObjectEvent, IWorldObject

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.

Nested Class Summary

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

IWorldObjectUpdatedEvent.DestroyWorldObject

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 boolean	ManualSpawn True if we have to spawn the bot manually after each death
protected String	Name The bot's name.
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected Rotation	RotationRate Bot rotation rate.
protected boolean	ShowDebug If some additional debug information will be shown in the UDK 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	Time
protected double	VisionTime The delay between two synchronous batches (can range from 0.1 to 2 seconds).

Constructor Summary

ConfigChange()
Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).

ConfigChange(ConfigChange original)
Cloning constructor.

ConfigChange(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 command ConfigChange.

Method Summary

boolean	equals(Object obj)
String	getAction() Name of current BDI action.
UnrealId	getBotId() Unique Id of the bot.
UnrealId	getId() Id of this config message.
double	getLastSeenTime()
ILocalWorldObject	getLocal()
String	getName() The bot's name.
IWorldObject	getObject() Returns original object (if method update() has already been called, for bot-programmer that is always true as the original object is updated and then the event is propagated).
Rotation	getRotationRate() Bot rotation rate.
ISharedWorldObject	getShared()
long	getSimTime()
double	getSpeedMultiplier() Bots default speed will be multiplied by this number.
IStaticWorldObject	getStatic()
protected double	getTime()
double	getVisionTime() The delay between two synchronous batches (can range from 0.1 to 2 seconds).
int	hashCode()
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 UDK 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	setTime(double time)
String	toHtmlString()
String	toString()
IWorldObjectUpdateResult	update(IWorldObject obj)

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

toJsonLiteral

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PROTOTYPE

public static final String PROTOTYPE

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

See Also:

Constant Field Values

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 [GameBotsUDK.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 [GameBotsUDK.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 UDK 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.

Time

protected double Time

Constructor Detail

ConfigChange

public ConfigChange(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 command 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 for this command is .

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 [GameBotsUDK.RemoteBot] MaxSpeed).

RotationRate - Bot rotation rate. Default rotation rate is: (Pitch=3072,Yaw=60000,Roll=2048) and may be configured in ini file in [GameBotsUDK.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 UDK 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.

ConfigChange

public ConfigChange(ConfigChange original)

Cloning constructor.

ConfigChange

public ConfigChange()

Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).

Method Detail

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 IWorldObjectUpdatedEvent

Specified by:

getId in interface IWorldObject

getBotId

public UnrealId getBotId()

Unique Id of the bot.

isManualSpawn

public boolean isManualSpawn()

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

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.

getName

public String getName()

The bot's name.

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 [GameBotsUDK.RemoteBot] MaxSpeed).

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 [GameBotsUDK.RemoteBot] DefaultRotationRate. (pitch - up/down, yaw - left/right, roll - equivalent of doing a cartwheel)

isInvulnerable

public boolean isInvulnerable()

If bot is invulnerable (cannot die) or not.

getVisionTime

public double getVisionTime()

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

isShowDebug

public boolean isShowDebug()

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

isShowFocalPoint

public boolean isShowFocalPoint()

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

isDrawTraceLines

public boolean isDrawTraceLines()

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

isSynchronousOff

public boolean isSynchronousOff()

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

isAutoPickupOff

public boolean isAutoPickupOff()

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

getAction

public String getAction()

Name of current BDI action.

getTime

protected double getTime()

setTime

protected void setTime(double time)

getLastSeenTime

public double getLastSeenTime()

getLocal

public ILocalWorldObject getLocal()

getShared

public ISharedWorldObject getShared()

getStatic

public IStaticWorldObject getStatic()

getSimTime

public long getSimTime()

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldObject

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

update

public IWorldObjectUpdateResult update(IWorldObject obj)

Specified by:

update in interface IWorldObjectUpdatedEvent

getObject

public IWorldObject getObject()

Returns original object (if method update() has already been called, for bot-programmer that is always true as the original object is updated and then the event is propagated).

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()