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

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

All Implemented Interfaces:

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

public class LocationUpdate
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event UPD.

Complete message documentation: "Synchronous" message. Arrives outside sync. batch. The frequency of this message is configured through locUpdateMultiplier variable in GameBots2004.ini file. It gets exported N times faster than regular sync. batch where N equals locUpdateMultiplier. Holds information about Location, Velocity and Rotation of the bot and should help us to create more robust navigation.

Field Summary

protected Location	Loc An absolute location of the bot.
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected Rotation	Rot Which direction the bot is facing in absolute terms.
protected long	SimTime
protected Velocity	Vel Absolute velocity of the bot as a vector of movement per one game second.

Constructor Summary

LocationUpdate()
Parameter-less contructor for the message.

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

LocationUpdate(Location Loc, Velocity Vel, Rotation Rot)
Creates new instance of the message LocationUpdate.

Method Summary

Location	getLoc() An absolute location of the bot.
Rotation	getRot() Which direction the bot is facing in absolute terms.
long	getSimTime() Simulation time in MILLI SECONDS !!!
Velocity	getVel() Absolute velocity of the bot as a vector of movement per one game second.
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

Loc

protected Location Loc

An absolute location of the bot.

Vel

protected Velocity Vel

Absolute velocity of the bot as a vector of movement per one game second.

Rot

protected Rotation Rot

Which direction the bot is facing in absolute terms.

Constructor Detail

LocationUpdate

public LocationUpdate()

Parameter-less contructor for the message.

LocationUpdate

public LocationUpdate(Location Loc,
                      Velocity Vel,
                      Rotation Rot)

Creates new instance of the message LocationUpdate. "Synchronous" message. Arrives outside sync. batch. The frequency of this message is configured through locUpdateMultiplier variable in GameBots2004.ini file. It gets exported N times faster than regular sync. batch where N equals locUpdateMultiplier. Holds information about Location, Velocity and Rotation of the bot and should help us to create more robust navigation. Corresponding GameBots message is UPD.

Parameters:

Loc - An absolute location of the bot.

Vel - Absolute velocity of the bot as a vector of movement per one game second.

Rot - Which direction the bot is facing in absolute terms.

LocationUpdate

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

getLoc

public Location getLoc()

An absolute location of the bot.

getVel

public Velocity getVel()

Absolute velocity of the bot as a vector of movement per one game second.

getRot

public Rotation getRot()

Which direction the bot is facing in absolute terms.

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()

Overrides:

toJsonLiteral in class InfoMessage