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, cz.cuni.amis.utils.listener.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

Fields

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

Constructor Summary

Constructors

Constructor and Description
PlayerLeft() Parameter-less contructor for the message.
PlayerLeft(PlayerLeft original) Cloning constructor from the full message.
PlayerLeft(UnrealId Id, String Name) Creates new instance of the message PlayerLeft.

Method Summary

Methods

Modifier and Type	Method and Description
UnrealId	getId() Unique Id of the player who left.
String	getName() The name of the player.
long	getSimTime() Simulation time in MILLI SECONDS !!!
protected void	setSimTime(long SimTime) Used by Yylex to slip correct time of the object or programmatically.
String	toHtmlString()
String	toJsonLiteral()
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

SimTime

protected long SimTime

Id

protected UnrealId Id

Unique Id of the player who left.

Name

protected String Name

The name of the player.

Constructor Detail

PlayerLeft

public PlayerLeft()

Parameter-less contructor for the message.

PlayerLeft

public PlayerLeft(UnrealId Id,
          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()

Simulation time in MILLI SECONDS !!!

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

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 String getName()

The name of the player.

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()

Overrides:

toJsonLiteral in class InfoMessage