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

Class SetSendKeys

java.lang.Object

cz.cuni.amis.pogamut.base.communication.messages.CommandMessage

cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands.SetSendKeys

public class SetSendKeys
extends CommandMessage

Representation of the GameBots2004 command SETSENDKEYS. Sets whether all key (not mouse) events should be sent through the KEYEVENT message.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	Player Name of the affected player.
protected UnrealId	PlayerId Id of the affected player.
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected Boolean	Send If true, the player can behave normally.

Constructor Summary

Constructors

Constructor and Description
SetSendKeys() Creates new instance of command SetSendKeys.
SetSendKeys(SetSendKeys original) Cloning constructor.
SetSendKeys(UnrealId PlayerId, String Player, Boolean Send) Creates new instance of command SetSendKeys.

Method Summary

Methods

Modifier and Type	Method and Description
String	getPlayer() Name of the affected player.
UnrealId	getPlayerId() Id of the affected player.
Boolean	isSend() If true, the player can behave normally.
SetSendKeys	setPlayer(String Player) Name of the affected player.
SetSendKeys	setPlayerId(UnrealId PlayerId) Id of the affected player.
SetSendKeys	setSend(Boolean Send) If true, the player can behave normally.
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

PlayerId

protected UnrealId PlayerId

Id of the affected player. Used in GBUE2.

Player

protected String Player

Name of the affected player. Used in GBScenario.

Send

protected Boolean Send

If true, the player can behave normally. If false, the player cannot perform any action.

Constructor Detail

SetSendKeys

public SetSendKeys(UnrealId PlayerId,
           String Player,
           Boolean Send)

Creates new instance of command SetSendKeys. Sets whether all key (not mouse) events should be sent through the KEYEVENT message. Corresponding GameBots message for this command is SETSENDKEYS.

Parameters:

PlayerId - Id of the affected player. Used in GBUE2.

Player - Name of the affected player. Used in GBScenario.

Send - If true, the player can behave normally. If false, the player cannot perform any action.

SetSendKeys

public SetSendKeys()

Creates new instance of command SetSendKeys. Sets whether all key (not mouse) events should be sent through the KEYEVENT message. Corresponding GameBots message for this command is SETSENDKEYS.

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

SetSendKeys

public SetSendKeys(SetSendKeys original)

Cloning constructor.

Parameters:

original -

Method Detail

getPlayerId

public UnrealId getPlayerId()

Id of the affected player. Used in GBUE2.

setPlayerId

public SetSendKeys setPlayerId(UnrealId PlayerId)

Id of the affected player. Used in GBUE2.

getPlayer

public String getPlayer()

Name of the affected player. Used in GBScenario.

setPlayer

public SetSendKeys setPlayer(String Player)

Name of the affected player. Used in GBScenario.

isSend

public Boolean isSend()

If true, the player can behave normally. If false, the player cannot perform any action.

setSend

public SetSendKeys setSend(Boolean Send)

If true, the player can behave normally. If false, the player cannot perform any action.

toString

public String toString()

Overrides:

toString in class CommandMessage

toHtmlString

public String toHtmlString()

toMessage

public String toMessage()