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

Package class diagram package FlagInfoShared
java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FlagInfoShared
All Implemented Interfaces:
IWorldObject, ISharedWorldObject, 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 cz.cuni.amis.utils.token.Token HolderPropertyToken
           
static cz.cuni.amis.utils.token.Token LocationPropertyToken
           
static Set<cz.cuni.amis.utils.token.Token> SharedPropertyTokens
           
protected  long SimTime
           
static cz.cuni.amis.utils.token.Token StatePropertyToken
           
static cz.cuni.amis.utils.token.Token TeamPropertyToken
           
 
Constructor Summary
FlagInfoShared()
          Parameter-less contructor for the message.
 
Method Summary
abstract  FlagInfoShared clone()
           
 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()
          Simulation time in MILLI SECONDS !!!
abstract  String getState()
          Represents the state the flag is in.
abstract  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.
 String toHtmlString()
           
 String toString()
           
 
Methods inherited from class cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
toJsonLiteral
 
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 cz.cuni.amis.utils.token.Token LocationPropertyToken

HolderPropertyToken

public static final cz.cuni.amis.utils.token.Token HolderPropertyToken

TeamPropertyToken

public static final cz.cuni.amis.utils.token.Token TeamPropertyToken

StatePropertyToken

public static final cz.cuni.amis.utils.token.Token StatePropertyToken

SharedPropertyTokens

public static final Set<cz.cuni.amis.utils.token.Token> SharedPropertyTokens
Constructor Detail

FlagInfoShared

public FlagInfoShared()
Parameter-less contructor for the message.

Method Detail

getSimTime

public long getSimTime()
Simulation time in MILLI SECONDS !!!

Specified by:
getSimTime in interface IWorldObject
Specified by:
getSimTime in interface ISharedWorldObject

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 Object

getCompositeClass

public 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

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 Integer getTeam()
The owner team of this flag.


getState

public abstract 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 String toString()
Overrides:
toString in class InfoMessage

toHtmlString

public String toHtmlString()


Copyright © 2013 AMIS research group, Faculty of Mathematics and Physics, Charles University in Prague, Czech Republic. All Rights Reserved.