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

Package class diagram package MoverMessage
java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.Mover
          extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.MoverMessage
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.ILocated, cz.cuni.amis.pogamut.base3d.worldview.object.ILocomotive, 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 MoverMessage
extends Mover
implements cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdatedEvent, cz.cuni.amis.pogamut.multi.communication.translator.event.ICompositeWorldObjectUpdatedEvent

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

Complete message documentation: Synchronous message. Movers can be doors, elevators, or any other chunk of architecture that can move. They generally need to be either run into, or activated by shooting or pressing a button. We are working on ways to provide bots with more of the information they need to deal with movers appropriately.


Nested Class Summary
 class MoverMessage.MoverLocalMessage
          Implementation of the local part of the GameBots2004 message MOV, used to facade MOVMessage.
 class MoverMessage.MoverSharedMessage
          Implementation of the shared part of the GameBots2004 message MOV, used to facade MOVMessage.
 class MoverMessage.MoverStaticMessage
          Implementation of the static part of the GameBots2004 message MOV, used to facade MOVMessage.
 
Nested classes/interfaces inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.Mover
Mover.MoverUpdate, Mover.ObjectDisappeared
 
Field Summary
protected  cz.cuni.amis.pogamut.base3d.worldview.object.Location BasePos
          Base position of the mover.
protected  boolean BasePos_Set
          Whether property 'BasePos' was received from GB2004.
protected  cz.cuni.amis.pogamut.base3d.worldview.object.Location BaseRot
          Base rotation of the mover.
protected  boolean BaseRot_Set
          Whether property 'BaseRot' was received from GB2004.
protected  boolean DamageTrig
          True if the mover needs to be shot to be activated.
protected  boolean DamageTrig_Set
          Whether property 'DamageTrig' was received from GB2004.
protected  double DelayTime
          Delay before starting to open (or before lift starts to move).
protected  boolean DelayTime_Set
          Whether property 'DelayTime' was received from GB2004.
protected  cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId Id
          A unique Id of this mover assigned by the game.
protected  boolean Id_Set
          Whether property 'Id' was received from GB2004.
protected  boolean IsMoving
          Does the mover move right now?
protected  boolean IsMoving_Set
          Whether property 'IsMoving' was received from GB2004.
protected  cz.cuni.amis.pogamut.base3d.worldview.object.Location Location
          Location of the mover.
protected  boolean Location_Set
          Whether property 'Location' was received from GB2004.
protected  double MoveTime
          How long the mover moves, when it becomes triggered, before it stops.
protected  boolean MoveTime_Set
          Whether property 'MoveTime' was received from GB2004.
protected  cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId NavPointMarker
          Navigation point marking this mover.
protected  boolean NavPointMarker_Set
          Whether property 'NavPointMarker' was received from GB2004.
protected  double OpenTime
          How long the mover stands still when it reaches its destination position.
protected  boolean OpenTime_Set
          Whether property 'OpenTime' was received from GB2004.
protected  String State
          Name of the state Mover is currently in.
protected  boolean State_Set
          Whether property 'State' was received from GB2004.
protected  cz.cuni.amis.pogamut.multi.agent.ITeamId TeamId
           
protected  String Type
          String class of the mover.
protected  boolean Type_Set
          Whether property 'Type' was received from GB2004.
protected  cz.cuni.amis.pogamut.base3d.worldview.object.Velocity Velocity
          Velocity vector.
protected  boolean Velocity_Set
          Whether property 'Velocity' was received from GB2004.
protected  boolean Visible
          If the mover is in the field of view of the bot.
protected  boolean Visible_Set
          Whether property 'Visible' was received from GB2004.
 
Fields inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.Mover
PROTOTYPE, SimTime
 
Constructor Summary
MoverMessage()
          Parameter-less contructor for the message.
MoverMessage(MoverMessage original)
          Cloning constructor from the full message.
MoverMessage(cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId Id, cz.cuni.amis.pogamut.base3d.worldview.object.Location Location, boolean Visible, boolean DamageTrig, String Type, boolean IsMoving, cz.cuni.amis.pogamut.base3d.worldview.object.Velocity Velocity, double MoveTime, double OpenTime, cz.cuni.amis.pogamut.base3d.worldview.object.Location BasePos, cz.cuni.amis.pogamut.base3d.worldview.object.Location BaseRot, double DelayTime, String State, cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId NavPointMarker)
          Creates new instance of the message Mover.
 
Method Summary
 cz.cuni.amis.pogamut.base3d.worldview.object.Location getBasePos()
          Base position of the mover.
 cz.cuni.amis.pogamut.base3d.worldview.object.Location getBaseRot()
          Base rotation of the mover.
 double getDelayTime()
          Delay before starting to open (or before lift starts to move).
 cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId getId()
          A unique Id of this mover assigned by the game.
 MoverLocal getLocal()
           
 cz.cuni.amis.pogamut.multi.communication.translator.event.ILocalWorldObjectUpdatedEvent getLocalEvent()
           
 cz.cuni.amis.pogamut.base3d.worldview.object.Location getLocation()
          Location of the mover.
 double getMoveTime()
          How long the mover moves, when it becomes triggered, before it stops.
 cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId getNavPointMarker()
          Navigation point marking this mover.
 double getOpenTime()
          How long the mover stands still when it reaches its destination position.
 MoverShared getShared()
           
 cz.cuni.amis.pogamut.multi.communication.translator.event.ISharedWorldObjectUpdatedEvent getSharedEvent()
           
 String getState()
          Name of the state Mover is currently in.
 MoverStatic getStatic()
           
 cz.cuni.amis.pogamut.multi.communication.translator.event.IStaticWorldObjectUpdatedEvent getStaticEvent()
           
 cz.cuni.amis.pogamut.multi.agent.ITeamId getTeamId()
           
 String getType()
          String class of the mover.
 cz.cuni.amis.pogamut.base3d.worldview.object.Velocity getVelocity()
          Velocity vector.
 boolean isDamageTrig()
          True if the mover needs to be shot to be activated.
 boolean isIsMoving()
          Does the mover move right now?
 boolean isVisible()
          If the mover is in the field of view of the bot.
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.Mover
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
A unique Id of this mover assigned by the game.


Id_Set

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


Location

protected cz.cuni.amis.pogamut.base3d.worldview.object.Location Location
Location of the mover.


Location_Set

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


Visible

protected boolean Visible
If the mover is in the field of view of the bot.


Visible_Set

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


DamageTrig

protected boolean DamageTrig
True if the mover needs to be shot to be activated.


DamageTrig_Set

protected boolean DamageTrig_Set
Whether property 'DamageTrig' was received from GB2004.


Type

protected String Type
String class of the mover.


Type_Set

protected boolean Type_Set
Whether property 'Type' was received from GB2004.


IsMoving

protected boolean IsMoving
Does the mover move right now?


IsMoving_Set

protected boolean IsMoving_Set
Whether property 'IsMoving' was received from GB2004.


Velocity

protected cz.cuni.amis.pogamut.base3d.worldview.object.Velocity Velocity
Velocity vector.


Velocity_Set

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


MoveTime

protected double MoveTime
How long the mover moves, when it becomes triggered, before it stops.


MoveTime_Set

protected boolean MoveTime_Set
Whether property 'MoveTime' was received from GB2004.


OpenTime

protected double OpenTime
How long the mover stands still when it reaches its destination position. After this time, the mover returns back to its initial position.


OpenTime_Set

protected boolean OpenTime_Set
Whether property 'OpenTime' was received from GB2004.


BasePos

protected cz.cuni.amis.pogamut.base3d.worldview.object.Location BasePos
Base position of the mover.


BasePos_Set

protected boolean BasePos_Set
Whether property 'BasePos' was received from GB2004.


BaseRot

protected cz.cuni.amis.pogamut.base3d.worldview.object.Location BaseRot
Base rotation of the mover.


BaseRot_Set

protected boolean BaseRot_Set
Whether property 'BaseRot' was received from GB2004.


DelayTime

protected double DelayTime
Delay before starting to open (or before lift starts to move).


DelayTime_Set

protected boolean DelayTime_Set
Whether property 'DelayTime' was received from GB2004.


State

protected String State
Name of the state Mover is currently in. Can be used to determine the type of the mover.


State_Set

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


NavPointMarker

protected cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId NavPointMarker
Navigation point marking this mover. We can parse this Id to get information about type of the mover. Marker Id contains "lift" string if it is a lift, "door" string if it is a door, etc.


NavPointMarker_Set

protected boolean NavPointMarker_Set
Whether property 'NavPointMarker' was received from GB2004.

Constructor Detail

MoverMessage

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


MoverMessage

public MoverMessage(cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId Id,
                    cz.cuni.amis.pogamut.base3d.worldview.object.Location Location,
                    boolean Visible,
                    boolean DamageTrig,
                    String Type,
                    boolean IsMoving,
                    cz.cuni.amis.pogamut.base3d.worldview.object.Velocity Velocity,
                    double MoveTime,
                    double OpenTime,
                    cz.cuni.amis.pogamut.base3d.worldview.object.Location BasePos,
                    cz.cuni.amis.pogamut.base3d.worldview.object.Location BaseRot,
                    double DelayTime,
                    String State,
                    cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId NavPointMarker)
Creates new instance of the message Mover. Synchronous message. Movers can be doors, elevators, or any other chunk of architecture that can move. They generally need to be either run into, or activated by shooting or pressing a button. We are working on ways to provide bots with more of the information they need to deal with movers appropriately. Corresponding GameBots message is MOV.

Parameters:
Id - A unique Id of this mover assigned by the game.
Location - Location of the mover.
Visible - If the mover is in the field of view of the bot.
DamageTrig - True if the mover needs to be shot to be activated.
Type - String class of the mover.
IsMoving - Does the mover move right now?
Velocity - Velocity vector.
MoveTime - How long the mover moves, when it becomes triggered, before it stops.
OpenTime - How long the mover stands still when it reaches its destination position. After this time, the mover returns back to its initial position.
BasePos - Base position of the mover.
BaseRot - Base rotation of the mover.
DelayTime - Delay before starting to open (or before lift starts to move).
State - Name of the state Mover is currently in. Can be used to determine the type of the mover.
NavPointMarker - Navigation point marking this mover. We can parse this Id to get information about type of the mover. Marker Id contains "lift" string if it is a lift, "door" string if it is a door, etc.

MoverMessage

public MoverMessage(MoverMessage 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: Mover
A unique Id of this mover 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 Mover

getLocation

public cz.cuni.amis.pogamut.base3d.worldview.object.Location getLocation()
Description copied from class: Mover
Location of the mover.

Specified by:
getLocation in interface cz.cuni.amis.pogamut.base3d.worldview.object.ILocated
Specified by:
getLocation in class Mover

isVisible

public boolean isVisible()
Description copied from class: Mover
If the mover is in the field of view of the bot.

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

isDamageTrig

public boolean isDamageTrig()
Description copied from class: Mover
True if the mover needs to be shot to be activated.

Specified by:
isDamageTrig in class Mover

getType

public String getType()
Description copied from class: Mover
String class of the mover.

Specified by:
getType in class Mover

isIsMoving

public boolean isIsMoving()
Description copied from class: Mover
Does the mover move right now?

Specified by:
isIsMoving in class Mover

getVelocity

public cz.cuni.amis.pogamut.base3d.worldview.object.Velocity getVelocity()
Description copied from class: Mover
Velocity vector.

Specified by:
getVelocity in interface cz.cuni.amis.pogamut.base3d.worldview.object.ILocomotive
Specified by:
getVelocity in class Mover

getMoveTime

public double getMoveTime()
Description copied from class: Mover
How long the mover moves, when it becomes triggered, before it stops.

Specified by:
getMoveTime in class Mover

getOpenTime

public double getOpenTime()
Description copied from class: Mover
How long the mover stands still when it reaches its destination position. After this time, the mover returns back to its initial position.

Specified by:
getOpenTime in class Mover

getBasePos

public cz.cuni.amis.pogamut.base3d.worldview.object.Location getBasePos()
Description copied from class: Mover
Base position of the mover.

Specified by:
getBasePos in class Mover

getBaseRot

public cz.cuni.amis.pogamut.base3d.worldview.object.Location getBaseRot()
Description copied from class: Mover
Base rotation of the mover.

Specified by:
getBaseRot in class Mover

getDelayTime

public double getDelayTime()
Description copied from class: Mover
Delay before starting to open (or before lift starts to move).

Specified by:
getDelayTime in class Mover

getState

public String getState()
Description copied from class: Mover
Name of the state Mover is currently in. Can be used to determine the type of the mover.

Specified by:
getState in class Mover

getNavPointMarker

public cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId getNavPointMarker()
Description copied from class: Mover
Navigation point marking this mover. We can parse this Id to get information about type of the mover. Marker Id contains "lift" string if it is a lift, "door" string if it is a door, etc.

Specified by:
getNavPointMarker in class Mover

getLocal

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

getShared

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

getStatic

public MoverStatic 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 Mover

toHtmlString

public String toHtmlString()
Overrides:
toHtmlString in class Mover


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