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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, Event

public class PlayerJoinsGame
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event JOIN.

Complete message documentation: Asynchronous message. A player joined the game.

Field Summary

protected UnrealId	Id Unique Id of the player.
protected java.lang.String	Name Name of the player.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime

Constructor Summary

PlayerJoinsGame()
Parameter-less contructor for the message.

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

PlayerJoinsGame(UnrealId Id, java.lang.String Name)
Creates new instance of the message PlayerJoinsGame.

Method Summary

UnrealId	getId() Unique Id of the player.
java.lang.String	getName() Name of the player.
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

Unique Id of the player.

Name

protected java.lang.String Name

Name of the player.

Constructor Detail

PlayerJoinsGame

public PlayerJoinsGame()

Parameter-less contructor for the message.

PlayerJoinsGame

public PlayerJoinsGame(UnrealId Id,
                       java.lang.String Name)

Creates new instance of the message PlayerJoinsGame. Asynchronous message. A player joined the game. Corresponding GameBots message is JOIN.

Parameters:

Id - Unique Id of the player.

Name - Name of the player.

PlayerJoinsGame

public PlayerJoinsGame(PlayerJoinsGame 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()

Unique Id of the player.

getName

public java.lang.String getName()

Name of the player.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()