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

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

public class MapList
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent, IMapList

Definition of the event IMAP.

Complete message documentation: Info batch message. Starts with SMAP message, ends with EMAP message. Hold information about available maps on the server (maps to which we can change the game).


Field Summary
protected  java.lang.String Name
          Name of one map in map list on the server.
static java.lang.String PROTOTYPE
          Example how the message looks like - used during parser tests.
protected  long SimTime
           
 
Constructor Summary
MapList()
          Parameter-less contructor for the message.
MapList(MapList original)
          Cloning constructor from the full message.
MapList(java.lang.String Name)
          Creates new instance of the message MapList.
 
Method Summary
 java.lang.String getName()
          Name of one map in map list on the server.
 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

Name

protected java.lang.String Name
Name of one map in map list on the server.

Constructor Detail

MapList

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


MapList

public MapList(java.lang.String Name)
Creates new instance of the message MapList. Info batch message. Starts with SMAP message, ends with EMAP message. Hold information about available maps on the server (maps to which we can change the game). Corresponding GameBots message is IMAP.

Parameters:
Name - Name of one map in map list on the server.

MapList

public MapList(MapList 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.


getName

public java.lang.String getName()
Name of one map in map list on the server.

Specified by:
getName in interface IMapList

toString

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

toHtmlString

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