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

java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.Mutator
All Implemented Interfaces:
IWorldChangeEvent, IWorldEvent, IMutator, Event

public class Mutator
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent, IMutator

Definition of the event MUT.

Complete message documentation: Info batch message. Starts with SMUT message, ends with EMUT message. Hold information about current mutators active on the server.


Field Summary
protected  UnrealId Id
          Id of the mutator.
protected  java.lang.String Name
          Name of the mutator.
static java.lang.String PROTOTYPE
          Example how the message looks like - used during parser tests.
protected  long SimTime
           
 
Constructor Summary
Mutator()
          Parameter-less contructor for the message.
Mutator(Mutator original)
          Cloning constructor from the full message.
Mutator(UnrealId Id, java.lang.String Name)
          Creates new instance of the message Mutator.
 
Method Summary
 UnrealId getId()
          Id of the mutator.
 java.lang.String getName()
          Name of the mutator.
 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
Id of the mutator.


Name

protected java.lang.String Name
Name of the mutator.

Constructor Detail

Mutator

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


Mutator

public Mutator(UnrealId Id,
               java.lang.String Name)
Creates new instance of the message Mutator. Info batch message. Starts with SMUT message, ends with EMUT message. Hold information about current mutators active on the server. Corresponding GameBots message is MUT.

Parameters:
Id - Id of the mutator.
Name - Name of the mutator.

Mutator

public Mutator(Mutator 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()
Id of the mutator.

Specified by:
getId in interface IMutator

getName

public java.lang.String getName()
Name of the mutator.

Specified by:
getName in interface IMutator

toString

public java.lang.String toString()
Overrides:
toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()
Specified by:
toHtmlString in interface IMutator