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

java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FlagInfo
          extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FlagInfoMessage
All Implemented Interfaces:
IWorldChangeEvent, IWorldObjectUpdatedEvent, IWorldEvent, IWorldObject, IViewable, ICompositeWorldObject, IGBViewable, Event

public class FlagInfoMessage
extends FlagInfo
implements IWorldObjectUpdatedEvent

Implementation of the GameBots2004 message FLG contains also its Local/Shared/Static subpart class definitions..

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


Nested Class Summary
 class FlagInfoMessage.FlagInfoLocalMessage
          Implementation of the local part of the GameBots2004 message FLG, used to facade FLGMessage.
 class FlagInfoMessage.FlagInfoSharedMessage
          Implementation of the shared part of the GameBots2004 message FLG, used to facade FLGMessage.
 class FlagInfoMessage.FlagInfoStaticMessage
          Implementation of the static part of the GameBots2004 message FLG, used to facade FLGMessage.
 
Nested classes/interfaces inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FlagInfo
FlagInfo.FlagInfoUpdate, FlagInfo.ObjectDisappeared
 
Field Summary
protected  UnrealId Holder
          Id of player/bot holding the flag.
protected  UnrealId Id
          An unique Id for this flag, assigned by the game.
protected  Location Location
          An absolute location of the flag (Sent if we can actually see the flag).
protected  boolean Reachable
          True if the bot can run here directly, false otherwise.
protected  java.lang.String State
          Represents the state the flag is in.
protected  java.lang.Integer Team
          The owner team of this flag.
protected  ITeamId TeamId
           
protected  boolean Visible
          True if the bot can see the flag.
 
Fields inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FlagInfo
PROTOTYPE, SimTime
 
Constructor Summary
FlagInfoMessage()
          Parameter-less contructor for the message.
FlagInfoMessage(FlagInfoMessage original)
          Cloning constructor from the full message.
FlagInfoMessage(UnrealId Id, Location Location, UnrealId Holder, java.lang.Integer Team, boolean Reachable, boolean Visible, java.lang.String State)
          Creates new instance of the message FlagInfo.
 
Method Summary
 UnrealId getHolder()
          Id of player/bot holding the flag.
 UnrealId getId()
          An unique Id for this flag, assigned by the game.
 FlagInfoLocal getLocal()
           
 Location getLocation()
          An absolute location of the flag (Sent if we can actually see the flag).
 FlagInfoShared getShared()
           
 java.lang.String getState()
          Represents the state the flag is in.
 FlagInfoStatic getStatic()
           
 java.lang.Integer getTeam()
          The owner team of this flag.
 ITeamId getTeamId()
           
 boolean isReachable()
          True if the bot can run here directly, false otherwise.
 boolean isVisible()
          True if the bot can see the flag.
protected  void setTeamId(ITeamId TeamId)
          Used by Yylex to slip corretn TeamId.
 java.lang.String toHtmlString()
           
 java.lang.String toString()
           
 IWorldObjectUpdateResult<IWorldObject> update(IWorldObject object)
           
 
Methods inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FlagInfo
createDisappearEvent, getSimTime, setSimTime
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface cz.cuni.amis.pogamut.base.communication.translator.event.IWorldChangeEvent
getSimTime
 

Field Detail

TeamId

protected ITeamId TeamId

Id

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


Location

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


Holder

protected UnrealId Holder
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).


Team

protected java.lang.Integer Team
The owner team of this flag.


Reachable

protected boolean Reachable
True if the bot can run here directly, false otherwise.


Visible

protected boolean Visible
True if the bot can see the flag.


State

protected java.lang.String State
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

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


FlagInfoMessage

public FlagInfoMessage(UnrealId Id,
                       Location Location,
                       UnrealId Holder,
                       java.lang.Integer Team,
                       boolean Reachable,
                       boolean Visible,
                       java.lang.String State)
Creates new instance of the message FlagInfo. Synchronous message. FlagInfo contains all info about the flag in the CTF game mode. Is not sent in other game types. Corresponding GameBots message is FLG.

Parameters:
Id - An unique Id for this flag, assigned by the game.
Location - An absolute location of the flag (Sent if we can actually see the flag).
Holder - 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).
Team - The owner team of this flag.
Reachable - True if the bot can run here directly, false otherwise.
Visible - True if the bot can see the flag.
State - 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!).

FlagInfoMessage

public FlagInfoMessage(FlagInfoMessage original)
Cloning constructor from the full message.

Parameters:
original -
Method Detail

setTeamId

protected void setTeamId(ITeamId TeamId)
Used by Yylex to slip corretn TeamId.


getTeamId

public ITeamId getTeamId()

getId

public UnrealId getId()
Description copied from class: FlagInfo
An unique Id for this flag, assigned by the game.

Specified by:
getId in interface IWorldObjectUpdatedEvent
Specified by:
getId in interface IWorldObject
Specified by:
getId in class FlagInfo
Returns:

getLocation

public Location getLocation()
Description copied from class: FlagInfo
An absolute location of the flag (Sent if we can actually see the flag).

Specified by:
getLocation in class FlagInfo

getHolder

public UnrealId getHolder()
Description copied from class: FlagInfo
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 FlagInfo

getTeam

public java.lang.Integer getTeam()
Description copied from class: FlagInfo
The owner team of this flag.

Specified by:
getTeam in class FlagInfo

isReachable

public boolean isReachable()
Description copied from class: FlagInfo
True if the bot can run here directly, false otherwise.

Specified by:
isReachable in class FlagInfo

isVisible

public boolean isVisible()
Description copied from class: FlagInfo
True if the bot can see the flag.

Specified by:
isVisible in interface IViewable
Specified by:
isVisible in class FlagInfo
Returns:
True if the object is visible; false otherwise.

getState

public java.lang.String getState()
Description copied from class: FlagInfo
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 FlagInfo

getLocal

public FlagInfoLocal getLocal()
Specified by:
getLocal in interface ICompositeWorldObject

getShared

public FlagInfoShared getShared()
Specified by:
getShared in interface ICompositeWorldObject

getStatic

public FlagInfoStatic getStatic()
Specified by:
getStatic in interface ICompositeWorldObject

update

public IWorldObjectUpdateResult<IWorldObject> update(IWorldObject object)
Specified by:
update in interface IWorldObjectUpdatedEvent

toString

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

toHtmlString

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