cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages
Class FlagInfoMessage.FlagInfoSharedMessage

java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FlagInfoShared
          extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FlagInfoMessage.FlagInfoSharedMessage
All Implemented Interfaces:
IWorldObject, ISharedWorldObject, java.lang.Cloneable
Enclosing class:
FlagInfoMessage

public class FlagInfoMessage.FlagInfoSharedMessage
extends FlagInfoShared

Implementation of the shared part of the GameBots2004 message FLG, used to facade FLGMessage.

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
protected  UnrealIdProperty myHolder
          Id of player/bot holding the flag.
protected  LocationProperty myLocation
          An absolute location of the flag (Sent if we can actually see the flag).
protected  StringProperty myState
          Represents the state the flag is in.
protected  IntegerProperty myTeam
          The owner team of this flag.
protected  java.util.HashMap<PropertyId,ISharedProperty> propertyMap
           
 
Fields inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FlagInfoShared
HolderPropertyToken, LocationPropertyToken, SharedPropertyTokens, SimTime, StatePropertyToken, TeamPropertyToken
 
Constructor Summary
FlagInfoMessage.FlagInfoSharedMessage()
           
 
Method Summary
 FlagInfoMessage.FlagInfoSharedMessage clone()
           
 UnrealId getHolder()
          Id of player/bot holding the flag.
 UnrealId getId()
          An unique Id for this flag, assigned by the game.
 Location getLocation()
          An absolute location of the flag (Sent if we can actually see the flag).
 java.util.Map<PropertyId,ISharedProperty> getProperties()
           
 ISharedProperty getProperty(PropertyId id)
           
 java.lang.String getState()
          Represents the state the flag is in.
 java.lang.Integer getTeam()
          The owner team of this flag.
 java.lang.String toHtmlString()
           
 java.lang.String toString()
           
 
Methods inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FlagInfoShared
getCompositeClass, getSimTime, setSimTime
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

propertyMap

protected java.util.HashMap<PropertyId,ISharedProperty> propertyMap

myLocation

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


myHolder

protected UnrealIdProperty myHolder
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).


myTeam

protected IntegerProperty myTeam
The owner team of this flag.


myState

protected StringProperty myState
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!).

Constructor Detail

FlagInfoMessage.FlagInfoSharedMessage

public FlagInfoMessage.FlagInfoSharedMessage()
Method Detail

clone

public FlagInfoMessage.FlagInfoSharedMessage clone()
Specified by:
clone in interface ISharedWorldObject
Specified by:
clone in class FlagInfoShared

getProperty

public ISharedProperty getProperty(PropertyId id)

getProperties

public java.util.Map<PropertyId,ISharedProperty> getProperties()

getId

public UnrealId getId()
An unique Id for this flag, assigned by the game.

Specified by:
getId in interface IWorldObject
Specified by:
getId in class FlagInfoShared
Returns:

getLocation

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

Specified by:
getLocation in class FlagInfoShared

getHolder

public 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).

Specified by:
getHolder in class FlagInfoShared

getTeam

public java.lang.Integer getTeam()
The owner team of this flag.

Specified by:
getTeam in class FlagInfoShared

getState

public 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!).

Specified by:
getState in class FlagInfoShared

toString

public java.lang.String toString()
Overrides:
toString in class FlagInfoShared

toHtmlString

public java.lang.String toHtmlString()
Overrides:
toHtmlString in class FlagInfoShared