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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, Event

public class GlobalChat
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event VMS.

Complete message documentation: tAsynchronous message. Recieved message from global chat channel

Field Summary

protected UnrealId	Id Unique UnrealId of the sender.
protected java.lang.String	Name Human readable name of the sender.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime
protected java.lang.String	Text A human readable message sent by another player in the game on the global channel.

Constructor Summary

GlobalChat()
Parameter-less contructor for the message.

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

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

Method Summary

UnrealId	getId() Unique UnrealId of the sender.
java.lang.String	getName() Human readable name of the sender.
long	getSimTime() Returns the simulation time when the event has occurred.
java.lang.String	getText() A human readable message sent by another player in the game on the global channel.
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 UnrealId of the sender.

Name

protected java.lang.String Name

Human readable name of the sender.

Text

protected java.lang.String Text

A human readable message sent by another player in the game on the global channel.

Constructor Detail

GlobalChat

public GlobalChat()

Parameter-less contructor for the message.

GlobalChat

public GlobalChat(UnrealId Id,
                  java.lang.String Name,
                  java.lang.String Text)

Creates new instance of the message GlobalChat. tAsynchronous message. Recieved message from global chat channel Corresponding GameBots message is VMS.

Parameters:

Id - Unique UnrealId of the sender.

Name - Human readable name of the sender.

Text - A human readable message sent by another player in the game on the global channel.

GlobalChat

public GlobalChat(GlobalChat 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 UnrealId of the sender.

getName

public java.lang.String getName()

Human readable name of the sender.

getText

public java.lang.String getText()

A human readable message sent by another player in the game on the global channel.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()