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

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

All Implemented Interfaces:

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

public class BeginMessage
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event BEG.

Complete message documentation: Synchronous message. Begin message signalizes start of synchronous batch. In the batch are send information about visible navpoints, game status, items and so on.

Field Summary

static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime
protected double	Time Timestamp form the GameBots.
protected boolean	VisUpdate Sent only if new synchronous batch procotol is used (NewSelfBatchProtocol attribute in INIT message).

Constructor Summary

BeginMessage()
Parameter-less contructor for the message.

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

BeginMessage(double Time, boolean VisUpdate)
Creates new instance of the message BeginMessage.

Method Summary

long	getSimTime() Simulation time in MILLI SECONDS !!!
double	getTime() Timestamp form the GameBots.
boolean	isVisUpdate() Sent only if new synchronous batch procotol is used (NewSelfBatchProtocol attribute in INIT message).
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

Time

protected double Time

Timestamp form the GameBots.

VisUpdate

protected boolean VisUpdate

Sent only if new synchronous batch procotol is used (NewSelfBatchProtocol attribute in INIT message). If true it means this sync. batches contains also visiblity information - PLR, INV, PRJ messages... If false, it means that only SELF message is in this synchronous batch.

Constructor Detail

BeginMessage

public BeginMessage()

Parameter-less contructor for the message.

BeginMessage

public BeginMessage(double Time,
                    boolean VisUpdate)

Creates new instance of the message BeginMessage. Synchronous message. Begin message signalizes start of synchronous batch. In the batch are send information about visible navpoints, game status, items and so on. Corresponding GameBots message is BEG.

Parameters:

Time - Timestamp form the GameBots.

VisUpdate - Sent only if new synchronous batch procotol is used (NewSelfBatchProtocol attribute in INIT message). If true it means this sync. batches contains also visiblity information - PLR, INV, PRJ messages... If false, it means that only SELF message is in this synchronous batch.

BeginMessage

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

getTime

public double getTime()

Timestamp form the GameBots.

isVisUpdate

public boolean isVisUpdate()

Sent only if new synchronous batch procotol is used (NewSelfBatchProtocol attribute in INIT message). If true it means this sync. batches contains also visiblity information - PLR, INV, PRJ messages... If false, it means that only SELF message is in this synchronous batch.

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()

Overrides:

toJsonLiteral in class InfoMessage