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

Package class diagram package TeamChat
java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.TeamChat
All Implemented Interfaces:
IWorldChangeEvent, IWorldEvent, cz.cuni.amis.utils.listener.Event

public class TeamChat
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event VMT.

Complete message documentation: Asynchronous message. Recieved message from team chat channel.


Field Summary
protected  Boolean ControlServer
          True if this message was sent by control server - in that case the id will be id of control server (that has no physical appearance in the game).
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  long SimTime
           
protected  String Text
          A human readable message sent by a team mate in the game on the private team channel.
 
Constructor Summary
TeamChat()
          Parameter-less contructor for the message.
TeamChat(TeamChat original)
          Cloning constructor from the full message.
TeamChat(UnrealId Id, String Name, Boolean ControlServer, String Text)
          Creates new instance of the message TeamChat.
 
Method Summary
 UnrealId getId()
          Unique UnrealId of the sender.
 String getName()
          Human readable name of the sender.
 long getSimTime()
          Simulation time in MILLI SECONDS !!!
 String getText()
          A human readable message sent by a team mate in the game on the private team channel.
 Boolean isControlServer()
          True if this message was sent by control server - in that case the id will be id of control server (that has no physical appearance in the game).
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 UnrealId of the sender.


Name

protected String Name
Human readable name of the sender.


ControlServer

protected Boolean ControlServer
True if this message was sent by control server - in that case the id will be id of control server (that has no physical appearance in the game).


Text

protected String Text
A human readable message sent by a team mate in the game on the private team channel.

Constructor Detail

TeamChat

public TeamChat()
Parameter-less contructor for the message.


TeamChat

public TeamChat(UnrealId Id,
                String Name,
                Boolean ControlServer,
                String Text)
Creates new instance of the message TeamChat. Asynchronous message. Recieved message from team chat channel. Corresponding GameBots message is VMT.

Parameters:
Id - Unique UnrealId of the sender.
Name - Human readable name of the sender.
ControlServer - True if this message was sent by control server - in that case the id will be id of control server (that has no physical appearance in the game).
Text - A human readable message sent by a team mate in the game on the private team channel.

TeamChat

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


getName

public String getName()
Human readable name of the sender.


isControlServer

public Boolean isControlServer()
True if this message was sent by control server - in that case the id will be id of control server (that has no physical appearance in the game).


getText

public String getText()
A human readable message sent by a team mate in the game on the private team channel.


toString

public String toString()
Overrides:
toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()
Overrides:
toJsonLiteral in class InfoMessage


Copyright © 2013 AMIS research group, Faculty of Mathematics and Physics, Charles University in Prague, Czech Republic. All Rights Reserved.