cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands
Class Configuration

java.lang.Object
  cz.cuni.amis.pogamut.base.communication.messages.CommandMessage
      cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands.Configuration

public class Configuration
extends CommandMessage

Representation of the GameBots2004 command CONF. Configures various attributes of the bot. This command can be issued also by bot on the bot itself (in this case Id attribute is not parsed).

Field Summary

protected String	Action Sets atomic action for the bot (BDI).
protected Boolean	AutoPickupOff It enables/disables automatic pickup of the bot.
protected Boolean	AutoTrace Enables/disables auto ray tracing feature.
protected Boolean	DrawTraceLines If set to true, the rays of automatic ray tracing (ATR messages) will be drawn in the game.
protected UnrealId	Id Id of the target bot.
protected Boolean	Invulnerable Will set godmode for bot on (bot can't be killed).
protected Boolean	ManualSpawn Sets if the bot wil have tol be respawned after death manually by RESPAWN command.
protected String	Name You can change the name of the bot in the game.
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected Rotation	RotationRate Sets the 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 true some additional debug information will be logged to UT2004 server console window.
protected Boolean	ShowFocalPoint If set to true an actor will appear in the game on the location the bot is actually looking at.
protected Double	SpeedMultiplier Bots default speed will be multiplied by this number.
protected Boolean	SynchronousOff It enables/disables sending of all GB synchronous messages for the bot.
protected Boolean	SyncNavPointsOff It enables/disables sending of NavPoints in GB synchronous batch for the bot.
protected Double	VisionTime The delay between two synchronous batches containing vision updates (can range from 0.1 to 2 seconds).

Constructor Summary

Configuration()
Creates new instance of command Configuration.

Configuration(Configuration original)
Cloning constructor.

Configuration(UnrealId Id, Boolean AutoTrace, Boolean ManualSpawn, String Name, String Action, Double SpeedMultiplier, Rotation RotationRate, Boolean Invulnerable, Double SelfUpdateTime, Double VisionTime, Boolean ShowDebug, Boolean ShowFocalPoint, Boolean DrawTraceLines, Boolean SynchronousOff, Boolean SyncNavPointsOff, Boolean AutoPickupOff)
Creates new instance of command Configuration.

Method Summary

void	copy(ConfigChange confCh) Copy configuration from existing info message to this command.
String	getAction() Sets atomic action for the bot (BDI).
UnrealId	getId() Id of the target bot.
String	getName() You can change the name of the bot in the game.
Rotation	getRotationRate() Sets the bot rotation rate.
Double	getSelfUpdateTime() The delay between two self message synchronous batches (can range from 0.01 to 2 seconds).
Double	getSpeedMultiplier() Bots default speed will be multiplied by this number.
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() Enables/disables auto ray tracing feature.
Boolean	isDrawTraceLines() If set to true, the rays of automatic ray tracing (ATR messages) will be drawn in the game.
Boolean	isInvulnerable() Will set godmode for bot on (bot can't be killed).
Boolean	isManualSpawn() Sets if the bot wil have tol be respawned after death manually by RESPAWN command.
Boolean	isShowDebug() If true some additional debug information will be logged to UT2004 server console window.
Boolean	isShowFocalPoint() If set to true an actor will appear in the game on the location the bot is actually looking at.
Boolean	isSynchronousOff() It enables/disables sending of all GB synchronous messages for the bot.
Boolean	isSyncNavPointsOff() It enables/disables sending of NavPoints in GB synchronous batch for the bot.
Configuration	setAction(String Action) Sets atomic action for the bot (BDI).
Configuration	setAutoPickupOff(Boolean AutoPickupOff) It enables/disables automatic pickup of the bot.
Configuration	setAutoTrace(Boolean AutoTrace) Enables/disables auto ray tracing feature.
Configuration	setDrawTraceLines(Boolean DrawTraceLines) If set to true, the rays of automatic ray tracing (ATR messages) will be drawn in the game.
Configuration	setId(UnrealId Id) Id of the target bot.
Configuration	setInvulnerable(Boolean Invulnerable) Will set godmode for bot on (bot can't be killed).
Configuration	setManualSpawn(Boolean ManualSpawn) Sets if the bot wil have tol be respawned after death manually by RESPAWN command.
Configuration	setName(String Name) You can change the name of the bot in the game.
Configuration	setRotationRate(Rotation RotationRate) Sets the bot rotation rate.
Configuration	setSelfUpdateTime(Double SelfUpdateTime) The delay between two self message synchronous batches (can range from 0.01 to 2 seconds).
Configuration	setShowDebug(Boolean ShowDebug) If true some additional debug information will be logged to UT2004 server console window.
Configuration	setShowFocalPoint(Boolean ShowFocalPoint) If set to true an actor will appear in the game on the location the bot is actually looking at.
Configuration	setSpeedMultiplier(Double SpeedMultiplier) Bots default speed will be multiplied by this number.
Configuration	setSynchronousOff(Boolean SynchronousOff) It enables/disables sending of all GB synchronous messages for the bot.
Configuration	setSyncNavPointsOff(Boolean SyncNavPointsOff) It enables/disables sending of NavPoints in GB synchronous batch for the bot.
Configuration	setVisionTime(Double VisionTime) The delay between two synchronous batches containing vision updates (can range from 0.1 to 2 seconds).
String	toHtmlString()
String	toMessage()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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 the target bot. Not used if sent as a command for the bot.

AutoTrace

protected Boolean AutoTrace

Enables/disables auto ray tracing feature.

ManualSpawn

protected Boolean ManualSpawn

Sets if the bot wil have tol be respawned after death manually by RESPAWN command. If false, the bot will respawn automatically.

Name

protected String Name

You can change the name of the bot in the game.

Action

protected String Action

Sets atomic action for the bot (BDI).

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

Sets the 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

Will set godmode for bot on (bot can't be killed). This can be changed just when cheating is enabled on the server. (bAllowCheats = True)

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. Setting this can change VisionTime value as well, as VisionTime needs to be set to multiple of this value.

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 then this value can be set only to multiples of SelfUpdateTime - the closest value will be found and VisionTime will be set to this number.

ShowDebug

protected Boolean ShowDebug

If true some additional debug information will be logged to UT2004 server console window.

ShowFocalPoint

protected Boolean ShowFocalPoint

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

DrawTraceLines

protected Boolean DrawTraceLines

If set to true, the rays of automatic ray tracing (ATR messages) will be drawn in the game.

SynchronousOff

protected Boolean SynchronousOff

It enables/disables sending of all GB synchronous messages for the bot.

SyncNavPointsOff

protected Boolean SyncNavPointsOff

It enables/disables sending of NavPoints in GB synchronous batch for the bot.

AutoPickupOff

protected Boolean AutoPickupOff

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

Constructor Detail

Configuration

public Configuration(UnrealId Id,
                     Boolean AutoTrace,
                     Boolean ManualSpawn,
                     String Name,
                     String Action,
                     Double SpeedMultiplier,
                     Rotation RotationRate,
                     Boolean Invulnerable,
                     Double SelfUpdateTime,
                     Double VisionTime,
                     Boolean ShowDebug,
                     Boolean ShowFocalPoint,
                     Boolean DrawTraceLines,
                     Boolean SynchronousOff,
                     Boolean SyncNavPointsOff,
                     Boolean AutoPickupOff)

Creates new instance of command Configuration. Configures various attributes of the bot. This command can be issued also by bot on the bot itself (in this case Id attribute is not parsed). Corresponding GameBots message for this command is CONF.

Parameters:

Id - Id of the target bot. Not used if sent as a command for the bot.

AutoTrace - Enables/disables auto ray tracing feature.

ManualSpawn - Sets if the bot wil have tol be respawned after death manually by RESPAWN command. If false, the bot will respawn automatically.

Name - You can change the name of the bot in the game.

Action - Sets atomic action for the bot (BDI).

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 - Sets the 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 - Will set godmode for bot on (bot can't be killed). This can be changed just when cheating is enabled on the server. (bAllowCheats = True)

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. Setting this can change VisionTime value as well, as VisionTime needs to be set to multiple of this value.

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 then this value can be set only to multiples of SelfUpdateTime - the closest value will be found and VisionTime will be set to this number.

ShowDebug - If true some additional debug information will be logged to UT2004 server console window.

ShowFocalPoint - If set to true an actor will appear in the game on the location the bot is actually looking at.

DrawTraceLines - If set to true, the rays of automatic ray tracing (ATR messages) will be drawn in the game.

SynchronousOff - It enables/disables sending of all GB synchronous messages for the bot.

SyncNavPointsOff - It enables/disables sending of NavPoints in GB synchronous batch for the bot.

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

Configuration

public Configuration()

Creates new instance of command Configuration. Configures various attributes of the bot. This command can be issued also by bot on the bot itself (in this case Id attribute is not parsed). Corresponding GameBots message for this command is CONF.

WARNING: this is empty-command constructor, you have to use setters to fill it up with data that should be sent to GameBots2004!

Configuration

public Configuration(Configuration original)

Cloning constructor.

Parameters:

original -

Method Detail

getId

public UnrealId getId()

Id of the target bot. Not used if sent as a command for the bot.

setId

public Configuration setId(UnrealId Id)

Id of the target bot. Not used if sent as a command for the bot.

isAutoTrace

public Boolean isAutoTrace()

Enables/disables auto ray tracing feature.

setAutoTrace

public Configuration setAutoTrace(Boolean AutoTrace)

Enables/disables auto ray tracing feature.

isManualSpawn

public Boolean isManualSpawn()

Sets if the bot wil have tol be respawned after death manually by RESPAWN command. If false, the bot will respawn automatically.

setManualSpawn

public Configuration setManualSpawn(Boolean ManualSpawn)

Sets if the bot wil have tol be respawned after death manually by RESPAWN command. If false, the bot will respawn automatically.

getName

public String getName()

You can change the name of the bot in the game.

setName

public Configuration setName(String Name)

You can change the name of the bot in the game.

getAction

public String getAction()

Sets atomic action for the bot (BDI).

setAction

public Configuration setAction(String Action)

Sets atomic action for the bot (BDI).

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

setSpeedMultiplier

public Configuration setSpeedMultiplier(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).

getRotationRate

public Rotation getRotationRate()

Sets the 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)

setRotationRate

public Configuration setRotationRate(Rotation RotationRate)

Sets the 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 Boolean isInvulnerable()

Will set godmode for bot on (bot can't be killed). This can be changed just when cheating is enabled on the server. (bAllowCheats = True)

setInvulnerable

public Configuration setInvulnerable(Boolean Invulnerable)

Will set godmode for bot on (bot can't be killed). This can be changed just when cheating is enabled on the server. (bAllowCheats = True)

getSelfUpdateTime

public 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. Setting this can change VisionTime value as well, as VisionTime needs to be set to multiple of this value.

setSelfUpdateTime

public Configuration setSelfUpdateTime(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. Setting this can change VisionTime value as well, as VisionTime needs to be set to multiple of this value.

getVisionTime

public 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 then this value can be set only to multiples of SelfUpdateTime - the closest value will be found and VisionTime will be set to this number.

setVisionTime

public Configuration setVisionTime(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 then this value can be set only to multiples of SelfUpdateTime - the closest value will be found and VisionTime will be set to this number.

isShowDebug

public Boolean isShowDebug()

If true some additional debug information will be logged to UT2004 server console window.

setShowDebug

public Configuration setShowDebug(Boolean ShowDebug)

If true some additional debug information will be logged to UT2004 server console window.

isShowFocalPoint

public Boolean isShowFocalPoint()

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

setShowFocalPoint

public Configuration setShowFocalPoint(Boolean ShowFocalPoint)

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

isDrawTraceLines

public Boolean isDrawTraceLines()

If set to true, the rays of automatic ray tracing (ATR messages) will be drawn in the game.

setDrawTraceLines

public Configuration setDrawTraceLines(Boolean DrawTraceLines)

If set to true, the rays of automatic ray tracing (ATR messages) will be drawn in the game.

isSynchronousOff

public Boolean isSynchronousOff()

It enables/disables sending of all GB synchronous messages for the bot.

setSynchronousOff

public Configuration setSynchronousOff(Boolean SynchronousOff)

It enables/disables sending of all GB synchronous messages for the bot.

isSyncNavPointsOff

public Boolean isSyncNavPointsOff()

It enables/disables sending of NavPoints in GB synchronous batch for the bot.

setSyncNavPointsOff

public Configuration setSyncNavPointsOff(Boolean SyncNavPointsOff)

It enables/disables sending of NavPoints in GB synchronous batch for the bot.

isAutoPickupOff

public Boolean isAutoPickupOff()

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

setAutoPickupOff

public Configuration setAutoPickupOff(Boolean AutoPickupOff)

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

toString

public String toString()

Overrides:

toString in class CommandMessage

toHtmlString

public String toHtmlString()

toMessage

public String toMessage()

copy

public void copy(ConfigChange confCh)

Copy configuration from existing info message to this command.