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

Class FlagInfoMessage

java.lang.Object

cz.cuni.amis.pogamut.base.communication.messages.InfoMessage

cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FlagInfo

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldObjectUpdatedEvent, IWorldEvent, IWorldObject, IViewable, ICompositeWorldObjectUpdatedEvent, ICompositeWorldObject, IGBViewable, cz.cuni.amis.utils.listener.Event

public class FlagInfoMessage
extends FlagInfo
implements IWorldObjectUpdatedEvent, ICompositeWorldObjectUpdatedEvent

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

Nested Classes

Modifier and Type	Class and Description
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

Nested classes/interfaces inherited from interface cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdatedEvent

IWorldObjectUpdatedEvent.DestroyWorldObject

Field Summary

Fields

Modifier and Type	Field and Description
protected UnrealId	Holder Id of player/bot holding the flag.
protected boolean	Holder_Set Whether property 'Holder' was received from GB2004.
protected UnrealId	Id An unique Id for this flag, assigned by the game.
protected boolean	Id_Set Whether property 'Id' was received from GB2004.
protected Location	Location An absolute location of the flag (Sent if we can actually see the flag).
protected boolean	Location_Set Whether property 'Location' was received from GB2004.
protected String	State Represents the state the flag is in.
protected boolean	State_Set Whether property 'State' was received from GB2004.
protected Integer	Team The owner team of this flag.
protected boolean	Team_Set Whether property 'Team' was received from GB2004.
protected ITeamId	TeamId
protected boolean	Visible True if the bot can see the flag.
protected boolean	Visible_Set Whether property 'Visible' was received from GB2004.

Fields inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FlagInfo

PROTOTYPE, SimTime

Constructor Summary

Constructors

Constructor and Description
FlagInfoMessage() Parameter-less contructor for the message.
FlagInfoMessage(FlagInfoMessage original) Cloning constructor from the full message.
FlagInfoMessage(UnrealId Id, Location Location, UnrealId Holder, Integer Team, boolean Visible, String State) Creates new instance of the message FlagInfo.

Method Summary

Methods

Modifier and Type	Method and Description
UnrealId	getHolder() Id of player/bot holding the flag.
UnrealId	getId() An unique Id for this flag, assigned by the game.
FlagInfoLocal	getLocal()
ILocalWorldObjectUpdatedEvent	getLocalEvent()
Location	getLocation() An absolute location of the flag (Sent if we can actually see the flag).
FlagInfoShared	getShared()
ISharedWorldObjectUpdatedEvent	getSharedEvent()
String	getState() Represents the state the flag is in.
FlagInfoStatic	getStatic()
IStaticWorldObjectUpdatedEvent	getStaticEvent()
Integer	getTeam() The owner team of this flag.
ITeamId	getTeamId()
boolean	isVisible() True if the bot can see the flag.
protected void	setTeamId(ITeamId TeamId) Used by Yylex to slip corretn TeamId.
String	toHtmlString()
String	toString()
IWorldObjectUpdateResult<IWorldObject>	update(IWorldObject object)

Methods inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FlagInfo

createDisappearEvent, getSimTime, setSimTime, toJsonLiteral

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.

Id_Set

protected boolean Id_Set

Whether property 'Id' was received from GB2004.

Location

protected Location Location

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

Location_Set

protected boolean Location_Set

Whether property 'Location' was received from GB2004.

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

Holder_Set

protected boolean Holder_Set

Whether property 'Holder' was received from GB2004.

Team

protected Integer Team

The owner team of this flag.

Team_Set

protected boolean Team_Set

Whether property 'Team' was received from GB2004.

Visible

protected boolean Visible

True if the bot can see the flag.

Visible_Set

protected boolean Visible_Set

Whether property 'Visible' was received from GB2004.

State

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

State_Set

protected boolean State_Set

Whether property 'State' was received from GB2004.

Constructor Detail

FlagInfoMessage

public FlagInfoMessage()

Parameter-less contructor for the message.

FlagInfoMessage

public FlagInfoMessage(UnrealId Id,
               Location Location,
               UnrealId Holder,
               Integer Team,
               boolean Visible,
               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.

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 interface ICompositeWorldObjectUpdatedEvent

Specified by:

getId in class FlagInfo

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 Integer getTeam()

Description copied from class: FlagInfo

The owner team of this flag.

Specified by:

getTeam 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

getState

public 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

getLocalEvent

public ILocalWorldObjectUpdatedEvent getLocalEvent()

Specified by:

getLocalEvent in interface ICompositeWorldObjectUpdatedEvent

getSharedEvent

public ISharedWorldObjectUpdatedEvent getSharedEvent()

Specified by:

getSharedEvent in interface ICompositeWorldObjectUpdatedEvent

getStaticEvent

public IStaticWorldObjectUpdatedEvent getStaticEvent()

Specified by:

getStaticEvent in interface ICompositeWorldObjectUpdatedEvent

toString

public String toString()

Overrides:

toString in class FlagInfo

toHtmlString

public String toHtmlString()

Overrides:

toHtmlString in class FlagInfo