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

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

All Implemented Interfaces:

IWorldObject, ILocated, ILocomotive, ISharedWorldObject, java.lang.Cloneable

Direct Known Subclasses:

MoverMessage.MoverSharedMessage, MoverSharedImpl

public abstract class MoverShared
extends InfoMessage
implements ISharedWorldObject, ILocated, ILocomotive

Abstract definition of the shared part of the GameBots2004 message MOV.

Complete message documentation: Synchronous message. Movers can be doors, elevators, or any other chunk of architecture that can move. They generally need to be either run into, or activated by shooting or pressing a button. We are working on ways to provide bots with more of the information they need to deal with movers appropriately.

Field Summary

static Token	LocationPropertyToken
static java.util.Set<Token>	SharedPropertyTokens
protected long	SimTime
static Token	StatePropertyToken
static Token	VelocityPropertyToken

Constructor Summary

MoverShared()
Parameter-less contructor for the message.

Method Summary

abstract MoverShared	clone()
java.lang.Class	getCompositeClass()
abstract UnrealId	getId() A unique Id of this mover assigned by the game.
abstract Location	getLocation() Location of the mover.
long	getSimTime() Returns world time when the object was seen/updated for the last time.
abstract java.lang.String	getState() Name of the state Mover is currently in.
abstract Velocity	getVelocity() Velocity vector.
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

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface cz.cuni.amis.pogamut.multi.communication.worldview.object.ISharedWorldObject

getProperties, getProperty

Field Detail

SimTime

protected long SimTime

LocationPropertyToken

public static final Token LocationPropertyToken

VelocityPropertyToken

public static final Token VelocityPropertyToken

StatePropertyToken

public static final Token StatePropertyToken

SharedPropertyTokens

public static final java.util.Set<Token> SharedPropertyTokens

Constructor Detail

MoverShared

public MoverShared()

Parameter-less contructor for the message.

Method Detail

getSimTime

public long getSimTime()

Description copied from interface: ISharedWorldObject

Returns world time when the object was seen/updated for the last time.

The time suppose to be growing as the simulation carries on.

Always should be actual_timestamp >= any_prevously_recorded_timestamp,

object1.getLastSeenTime() > object2.getLastSeenTime() means that object1 last seen after object2

Specified by:

getSimTime in interface IWorldObject

Specified by:

getSimTime in interface ISharedWorldObject

Returns:

setSimTime

protected void setSimTime(long SimTime)

Used by Yylex to slip correct time of the object or programmatically.

clone

public abstract MoverShared clone()

Specified by:

clone in interface ISharedWorldObject

Overrides:

clone in class java.lang.Object

getCompositeClass

public java.lang.Class getCompositeClass()

Specified by:

getCompositeClass in interface ISharedWorldObject

getId

public abstract UnrealId getId()

A unique Id of this mover assigned by the game.

Specified by:

getId in interface IWorldObject

Returns:

getLocation

public abstract Location getLocation()

Location of the mover.

Specified by:

getLocation in interface ILocated

Returns:

Current location of the object, represented as a point within the world's coordinates.

getVelocity

public abstract Velocity getVelocity()

Velocity vector.

Specified by:

getVelocity in interface ILocomotive

Returns:

Current direction in which the object is moving and absolute velocity of the object within the world. The direction is represented as a vector within the world's coordinates. The size of velocity is represented by length of that vector.

getState

public abstract java.lang.String getState()

Name of the state Mover is currently in. Can be used to determine the type of the mover.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()