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, 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 java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime
protected double	Time Timestamp form the GameBots.

Constructor Summary

BeginMessage()
Parameter-less contructor for the message.

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

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

Method Summary

long	getSimTime() Returns the simulation time when the event has occurred.
double	getTime() Timestamp form the GameBots.
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

Time

protected double Time

Timestamp form the GameBots.

Constructor Detail

BeginMessage

public BeginMessage()

Parameter-less contructor for the message.

BeginMessage

public BeginMessage(double Time)

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.

BeginMessage

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

getTime

public double getTime()

Timestamp form the GameBots.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()