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

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

All Implemented Interfaces:

IWorldObject, ISharedWorldObject, java.lang.Cloneable

Direct Known Subclasses:

FlagInfoMessage.FlagInfoSharedMessage, FlagInfoSharedImpl

public abstract class FlagInfoShared
extends InfoMessage
implements ISharedWorldObject

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

Complete message documentation: Synchronous message. FlagInfo contains all info about the flag in the CTF game mode. Is not sent in other game types.

Field Summary

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

Constructor Summary

FlagInfoShared()
Parameter-less contructor for the message.

Method Summary

abstract FlagInfoShared	clone()
java.lang.Class	getCompositeClass()
abstract UnrealId	getHolder() Id of player/bot holding the flag.
abstract UnrealId	getId() An unique Id for this flag, assigned by the game.
abstract Location	getLocation() An absolute location of the flag (Sent if we can actually see the flag).
long	getSimTime() Returns world time when the object was seen/updated for the last time.
abstract java.lang.String	getState() Represents the state the flag is in.
abstract java.lang.Integer	getTeam() The owner team of this flag.
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

HolderPropertyToken

public static final Token HolderPropertyToken

TeamPropertyToken

public static final Token TeamPropertyToken

StatePropertyToken

public static final Token StatePropertyToken

SharedPropertyTokens

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

Constructor Detail

FlagInfoShared

public FlagInfoShared()

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 FlagInfoShared 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()

An unique Id for this flag, assigned by the game.

Specified by:

getId in interface IWorldObject

Returns:

getLocation

public abstract Location getLocation()

An absolute location of the flag (Sent if we can actually see the flag).

getHolder

public abstract UnrealId getHolder()

Id of player/bot holding the flag. (Sent if we can actually see the flag and the flag is being carried, or if the flag is being carried by us).

getTeam

public abstract java.lang.Integer getTeam()

The owner team of this flag.

getState

public abstract java.lang.String getState()

Represents the state the flag is in. Can be "Held", "Dropped" or "Home" (note that the first letter does not have to be in upper case!).

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()