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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, Event

public class PlayerInput
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event PLI.

Complete message documentation: Aynchronous message. When the player has our bot selected by mouse cursor, he can provide the bot with key input (keys 0 - 9 represented by int 0-9 and key T represented by 10). If the player has some dialog on the HUD, Id of the dialog will be sent (if any).

Field Summary

protected java.lang.String	DialogId An Id of the dialog (if set any) that the player has visible on the HUD.
protected UnrealId	Id Id of the player that sent the input.
protected int	Key Which key was pressed.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime

Constructor Summary

PlayerInput()
Parameter-less contructor for the message.

PlayerInput(PlayerInput original)
Cloning constructor from the full message.

PlayerInput(UnrealId Id, java.lang.String DialogId, int Key)
Creates new instance of the message PlayerInput.

Method Summary

java.lang.String	getDialogId() An Id of the dialog (if set any) that the player has visible on the HUD.
UnrealId	getId() Id of the player that sent the input.
int	getKey() Which key was pressed.
long	getSimTime() Returns the simulation time when the event has occurred.
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

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

Field Detail

PROTOTYPE

public static final java.lang.String PROTOTYPE

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

See Also:

Constant Field Values

SimTime

protected long SimTime

Id

protected UnrealId Id

Id of the player that sent the input.

DialogId

protected java.lang.String DialogId

An Id of the dialog (if set any) that the player has visible on the HUD. This attribute won't be sent at all if DialogId is "" or if no dialog on player HUD.

Key

protected int Key

Which key was pressed. Supported keys: 0 - 9 represented by int 0-9 and key T represented by 10/

Constructor Detail

PlayerInput

public PlayerInput()

Parameter-less contructor for the message.

PlayerInput

public PlayerInput(UnrealId Id,
                   java.lang.String DialogId,
                   int Key)

Creates new instance of the message PlayerInput. Aynchronous message. When the player has our bot selected by mouse cursor, he can provide the bot with key input (keys 0 - 9 represented by int 0-9 and key T represented by 10). If the player has some dialog on the HUD, Id of the dialog will be sent (if any). Corresponding GameBots message is PLI.

Parameters:

Id - Id of the player that sent the input.

DialogId - An Id of the dialog (if set any) that the player has visible on the HUD. This attribute won't be sent at all if DialogId is "" or if no dialog on player HUD.

Key - Which key was pressed. Supported keys: 0 - 9 represented by int 0-9 and key T represented by 10/

PlayerInput

public PlayerInput(PlayerInput original)

Cloning constructor from the full message.

Parameters:

original -

Method Detail

getSimTime

public long getSimTime()

Description copied from interface: IWorldEvent

Returns the simulation time when the event has occurred.

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

Returns:

timestamp

setSimTime

protected void setSimTime(long SimTime)

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

getId

public UnrealId getId()

Id of the player that sent the input.

getDialogId

public java.lang.String getDialogId()

An Id of the dialog (if set any) that the player has visible on the HUD. This attribute won't be sent at all if DialogId is "" or if no dialog on player HUD.

getKey

public int getKey()

Which key was pressed. Supported keys: 0 - 9 represented by int 0-9 and key T represented by 10/

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()