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

Package class diagram package BombInfoMessage
java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.BombInfo
          extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.BombInfoMessage
All Implemented Interfaces:
cz.cuni.amis.pogamut.base.communication.translator.event.IWorldChangeEvent, cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdatedEvent, cz.cuni.amis.pogamut.base.communication.worldview.event.IWorldEvent, cz.cuni.amis.pogamut.base.communication.worldview.object.IWorldObject, cz.cuni.amis.pogamut.base3d.worldview.object.IViewable, cz.cuni.amis.pogamut.multi.communication.translator.event.ICompositeWorldObjectUpdatedEvent, cz.cuni.amis.pogamut.multi.communication.worldview.object.ICompositeWorldObject, IGBViewable, cz.cuni.amis.utils.listener.Event

public class BombInfoMessage
extends BombInfo
implements cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdatedEvent, cz.cuni.amis.pogamut.multi.communication.translator.event.ICompositeWorldObjectUpdatedEvent

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

Complete message documentation: Synchronous message. BombInfo contains all info about the bomb in the BotBombingRun game mode. Is not sent in other game types.


Nested Class Summary
 class BombInfoMessage.BombInfoLocalMessage
          Implementation of the local part of the GameBots2004 message BOM, used to facade BOMMessage.
 class BombInfoMessage.BombInfoSharedMessage
          Implementation of the shared part of the GameBots2004 message BOM, used to facade BOMMessage.
 class BombInfoMessage.BombInfoStaticMessage
          Implementation of the static part of the GameBots2004 message BOM, used to facade BOMMessage.
 
Nested classes/interfaces inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.BombInfo
BombInfo.BombInfoUpdate, BombInfo.ObjectDisappeared
 
Field Summary
protected  cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId Holder
          Id of player/bot holding the bomb.
protected  boolean Holder_Set
          Whether property 'Holder' was received from GB2004.
protected  Integer HolderTeam
          The team of the current holder (if any).
protected  boolean HolderTeam_Set
          Whether property 'HolderTeam' was received from GB2004.
protected  cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId Id
          An unique Id for this bomb, assigned by the game.
protected  boolean Id_Set
          Whether property 'Id' was received from GB2004.
protected  cz.cuni.amis.pogamut.base3d.worldview.object.Location Location
          An absolute location of the bomb (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 bomb is in.
protected  boolean State_Set
          Whether property 'State' was received from GB2004.
protected  cz.cuni.amis.pogamut.multi.agent.ITeamId TeamId
           
protected  cz.cuni.amis.pogamut.base3d.worldview.object.Velocity Velocity
          Current velocity of the bomb.
protected  boolean Velocity_Set
          Whether property 'Velocity' was received from GB2004.
protected  boolean Visible
          True if the bot can see the bomb.
protected  boolean Visible_Set
          Whether property 'Visible' was received from GB2004.
 
Fields inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.BombInfo
PROTOTYPE, SimTime
 
Constructor Summary
BombInfoMessage()
          Parameter-less contructor for the message.
BombInfoMessage(BombInfoMessage original)
          Cloning constructor from the full message.
BombInfoMessage(cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId Id, cz.cuni.amis.pogamut.base3d.worldview.object.Velocity Velocity, cz.cuni.amis.pogamut.base3d.worldview.object.Location Location, cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId Holder, Integer HolderTeam, boolean Visible, String State)
          Creates new instance of the message BombInfo.
 
Method Summary
 cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId getHolder()
          Id of player/bot holding the bomb.
 Integer getHolderTeam()
          The team of the current holder (if any).
 cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId getId()
          An unique Id for this bomb, assigned by the game.
 BombInfoLocal getLocal()
           
 cz.cuni.amis.pogamut.multi.communication.translator.event.ILocalWorldObjectUpdatedEvent getLocalEvent()
           
 cz.cuni.amis.pogamut.base3d.worldview.object.Location getLocation()
          An absolute location of the bomb (Sent if we can actually see the flag).
 BombInfoShared getShared()
           
 cz.cuni.amis.pogamut.multi.communication.translator.event.ISharedWorldObjectUpdatedEvent getSharedEvent()
           
 String getState()
          Represents the state the bomb is in.
 BombInfoStatic getStatic()
           
 cz.cuni.amis.pogamut.multi.communication.translator.event.IStaticWorldObjectUpdatedEvent getStaticEvent()
           
 cz.cuni.amis.pogamut.multi.agent.ITeamId getTeamId()
           
 cz.cuni.amis.pogamut.base3d.worldview.object.Velocity getVelocity()
          Current velocity of the bomb.
 boolean isVisible()
          True if the bot can see the bomb.
protected  void setTeamId(cz.cuni.amis.pogamut.multi.agent.ITeamId TeamId)
          Used by Yylex to slip corretn TeamId.
 String toHtmlString()
           
 String toString()
           
 cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdateResult<cz.cuni.amis.pogamut.base.communication.worldview.object.IWorldObject> update(cz.cuni.amis.pogamut.base.communication.worldview.object.IWorldObject object)
           
 
Methods inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.BombInfo
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 cz.cuni.amis.pogamut.multi.agent.ITeamId TeamId

Id

protected cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId Id
An unique Id for this bomb, assigned by the game.


Id_Set

protected boolean Id_Set
Whether property 'Id' was received from GB2004.


Velocity

protected cz.cuni.amis.pogamut.base3d.worldview.object.Velocity Velocity
Current velocity of the bomb. TODO not sure if this actually does smthing


Velocity_Set

protected boolean Velocity_Set
Whether property 'Velocity' was received from GB2004.


Location

protected cz.cuni.amis.pogamut.base3d.worldview.object.Location Location
An absolute location of the bomb (Sent if we can actually see the flag).


Location_Set

protected boolean Location_Set
Whether property 'Location' was received from GB2004.


Holder

protected cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId Holder
Id of player/bot holding the bomb. (Sent if we can actually see the bomb and the bomb is being carried, or if the bomb is being carried by us).


Holder_Set

protected boolean Holder_Set
Whether property 'Holder' was received from GB2004.


HolderTeam

protected Integer HolderTeam
The team of the current holder (if any).


HolderTeam_Set

protected boolean HolderTeam_Set
Whether property 'HolderTeam' was received from GB2004.


Visible

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


Visible_Set

protected boolean Visible_Set
Whether property 'Visible' was received from GB2004.


State

protected String State
Represents the state the bomb is in. Can be "Held", "Dropped" or "Home".


State_Set

protected boolean State_Set
Whether property 'State' was received from GB2004.

Constructor Detail

BombInfoMessage

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


BombInfoMessage

public BombInfoMessage(cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId Id,
                       cz.cuni.amis.pogamut.base3d.worldview.object.Velocity Velocity,
                       cz.cuni.amis.pogamut.base3d.worldview.object.Location Location,
                       cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId Holder,
                       Integer HolderTeam,
                       boolean Visible,
                       String State)
Creates new instance of the message BombInfo. Synchronous message. BombInfo contains all info about the bomb in the BotBombingRun game mode. Is not sent in other game types. Corresponding GameBots message is BOM.

Parameters:
Id - An unique Id for this bomb, assigned by the game.
Velocity - Current velocity of the bomb. TODO not sure if this actually does smthing
Location - An absolute location of the bomb (Sent if we can actually see the flag).
Holder - Id of player/bot holding the bomb. (Sent if we can actually see the bomb and the bomb is being carried, or if the bomb is being carried by us).
HolderTeam - The team of the current holder (if any).
Visible - True if the bot can see the bomb.
State - Represents the state the bomb is in. Can be "Held", "Dropped" or "Home".

BombInfoMessage

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

Parameters:
original -
Method Detail

setTeamId

protected void setTeamId(cz.cuni.amis.pogamut.multi.agent.ITeamId TeamId)
Used by Yylex to slip corretn TeamId.


getTeamId

public cz.cuni.amis.pogamut.multi.agent.ITeamId getTeamId()

getId

public cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId getId()
Description copied from class: BombInfo
An unique Id for this bomb, assigned by the game.

Specified by:
getId in interface cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdatedEvent
Specified by:
getId in interface cz.cuni.amis.pogamut.base.communication.worldview.object.IWorldObject
Specified by:
getId in interface cz.cuni.amis.pogamut.multi.communication.translator.event.ICompositeWorldObjectUpdatedEvent
Specified by:
getId in class BombInfo

getVelocity

public cz.cuni.amis.pogamut.base3d.worldview.object.Velocity getVelocity()
Description copied from class: BombInfo
Current velocity of the bomb. TODO not sure if this actually does smthing

Specified by:
getVelocity in class BombInfo

getLocation

public cz.cuni.amis.pogamut.base3d.worldview.object.Location getLocation()
Description copied from class: BombInfo
An absolute location of the bomb (Sent if we can actually see the flag).

Specified by:
getLocation in class BombInfo

getHolder

public cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId getHolder()
Description copied from class: BombInfo
Id of player/bot holding the bomb. (Sent if we can actually see the bomb and the bomb is being carried, or if the bomb is being carried by us).

Specified by:
getHolder in class BombInfo

getHolderTeam

public Integer getHolderTeam()
Description copied from class: BombInfo
The team of the current holder (if any).

Specified by:
getHolderTeam in class BombInfo

isVisible

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

Specified by:
isVisible in interface cz.cuni.amis.pogamut.base3d.worldview.object.IViewable
Specified by:
isVisible in class BombInfo

getState

public String getState()
Description copied from class: BombInfo
Represents the state the bomb is in. Can be "Held", "Dropped" or "Home".

Specified by:
getState in class BombInfo

getLocal

public BombInfoLocal getLocal()
Specified by:
getLocal in interface cz.cuni.amis.pogamut.multi.communication.worldview.object.ICompositeWorldObject

getShared

public BombInfoShared getShared()
Specified by:
getShared in interface cz.cuni.amis.pogamut.multi.communication.worldview.object.ICompositeWorldObject

getStatic

public BombInfoStatic getStatic()
Specified by:
getStatic in interface cz.cuni.amis.pogamut.multi.communication.worldview.object.ICompositeWorldObject

update

public cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdateResult<cz.cuni.amis.pogamut.base.communication.worldview.object.IWorldObject> update(cz.cuni.amis.pogamut.base.communication.worldview.object.IWorldObject object)
Specified by:
update in interface cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdatedEvent

getLocalEvent

public cz.cuni.amis.pogamut.multi.communication.translator.event.ILocalWorldObjectUpdatedEvent getLocalEvent()
Specified by:
getLocalEvent in interface cz.cuni.amis.pogamut.multi.communication.translator.event.ICompositeWorldObjectUpdatedEvent

getSharedEvent

public cz.cuni.amis.pogamut.multi.communication.translator.event.ISharedWorldObjectUpdatedEvent getSharedEvent()
Specified by:
getSharedEvent in interface cz.cuni.amis.pogamut.multi.communication.translator.event.ICompositeWorldObjectUpdatedEvent

getStaticEvent

public cz.cuni.amis.pogamut.multi.communication.translator.event.IStaticWorldObjectUpdatedEvent getStaticEvent()
Specified by:
getStaticEvent in interface cz.cuni.amis.pogamut.multi.communication.translator.event.ICompositeWorldObjectUpdatedEvent

toString

public String toString()
Overrides:
toString in class BombInfo

toHtmlString

public String toHtmlString()
Overrides:
toHtmlString in class BombInfo


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