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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, Event

public class PlayerLeft
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event LEFT.

Complete message documentation: Asynchronous message. Message sent when a player leaves the server.

Field Summary

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

Constructor Summary

PlayerLeft()
Parameter-less contructor for the message.

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

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

Method Summary

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

Name

protected java.lang.String Name

The name of the player.

Constructor Detail

PlayerLeft

public PlayerLeft()

Parameter-less contructor for the message.

PlayerLeft

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

Creates new instance of the message PlayerLeft. Asynchronous message. Message sent when a player leaves the server. Corresponding GameBots message is LEFT.

Parameters:

Id - Unique Id of the player who left.

Name - The name of the player.

PlayerLeft

public PlayerLeft(PlayerLeft 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 who left.

getName

public java.lang.String getName()

The name of the player.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()