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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEventWrapper, IWorldEvent, IGBWorldEvent, cz.cuni.amis.utils.listener.Event

public class GlobalChat
extends GBEvent
implements IWorldEvent, IWorldChangeEvent

Asynchronous message. Recieved message from global chat channel. Corresponding GameBots message is VMS.

Field Summary

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

Constructor Summary

GlobalChat()
Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).

GlobalChat(GlobalChat original)
Cloning constructor.

GlobalChat(UnrealId Id, String Name, String Text)
Creates new instance of command GlobalChat.

Method Summary

UnrealId	getId() Unique UnrealId of the sender.
String	getName() Human readable name of the sender.
long	getSimTime()
String	getText() A human readable message sent by another player in the game on the global channel.
String	toHtmlString()
String	toString()

Methods inherited from class cz.cuni.amis.pogamut.udk.communication.messages.GBEvent

getWorldEvent

Methods inherited from class cz.cuni.amis.pogamut.base.communication.messages.InfoMessage

toJsonLiteral

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

Id

protected UnrealId Id

Unique UnrealId of the sender.

Name

protected String Name

Human readable name of the sender.

Text

protected String Text

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

Constructor Detail

GlobalChat

public GlobalChat(UnrealId Id,
                  String Name,
                  String Text)

Creates new instance of command GlobalChat. Asynchronous message. Recieved message from global chat channel. Corresponding GameBots message for this command is .

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.

GlobalChat

public GlobalChat()

Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).

Method Detail

getId

public UnrealId getId()

Unique UnrealId of the sender.

getName

public String getName()

Human readable name of the sender.

getText

public String getText()

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

getSimTime

public long getSimTime()

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

Overrides:

getSimTime in class GBEvent

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()