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

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

All Implemented Interfaces:

IWorldObject, ILocalWorldObject, java.lang.Cloneable

Direct Known Subclasses:

ConfigChangeLocalImpl, ConfigChangeMessage.ConfigChangeLocalMessage

public abstract class ConfigChangeLocal
extends InfoMessage
implements ILocalWorldObject

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

Field Summary

protected long

SimTime

Constructor Summary

ConfigChangeLocal()
Parameter-less contructor for the message.

Method Summary

abstract ConfigChangeLocal	clone()
abstract java.lang.String	getAction() Name of current BDI action.
abstract UnrealId	getBotId() Unique Id of the bot.
java.lang.Class	getCompositeClass()
abstract UnrealId	getId() Id of this config message.
ConfigChangeLocal	getLocal()
abstract java.lang.String	getName() The bot's name.
abstract Rotation	getRotationRate() Bot rotation rate.
ISharedWorldObject	getShared()
long	getSimTime() Returns world time when the object was seen/updated for the last time.
abstract double	getSpeedMultiplier() Bots default speed will be multiplied by this number.
IStaticWorldObject	getStatic()
abstract double	getVisionTime() The delay between two synchronous batches (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.
java.lang.String	toHtmlString()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SimTime

protected long SimTime

Constructor Detail

ConfigChangeLocal

public ConfigChangeLocal()

Parameter-less contructor for the message.

Method Detail

getSimTime

public long getSimTime()

Description copied from interface: IWorldObject

Returns world time when the object was seen/updated for the last time.

The time suppose to be growing as the simulation carries on.

Always should be actual_timestamp >= any_prevously_recorded_timestamp,

object1.getLastSeenTime() > object2.getLastSeenTime() means that object1 last seen after object2

Specified by:

getSimTime in interface IWorldObject

Returns:

setSimTime

protected void setSimTime(long SimTime)

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

clone

public abstract ConfigChangeLocal clone()

Specified by:

clone in interface ILocalWorldObject

Overrides:

clone in class java.lang.Object

getCompositeClass

public java.lang.Class getCompositeClass()

Specified by:

getCompositeClass in interface ILocalWorldObject

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

Returns:

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

getVisionTime

public abstract double getVisionTime()

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

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 java.lang.String getAction()

Name of current BDI action.

getLocal

public ConfigChangeLocal getLocal()

getShared

public ISharedWorldObject getShared()

getStatic

public IStaticWorldObject getStatic()

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()