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

Package class diagram package VehicleShared
java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.VehicleShared
All Implemented Interfaces:
IWorldObject, ILocated, ILocomotive, IRotable, ISharedWorldObject, Cloneable
Direct Known Subclasses:
VehicleMessage.VehicleSharedMessage, VehicleSharedImpl

public abstract class VehicleShared
extends InfoMessage
implements ISharedWorldObject, ILocated, ILocomotive, IRotable

Abstract definition of the shared part of the GameBots2004 message VEH.

Complete message documentation: Synchronous message. Holds vehicles we see. Id for vehicles doesn't work, so this message is without Id. We can join vehicles by ENTER command if we are close enough - ussually 100 ut units or less. Note: Vehicle support is in aplha testing right now.


Field Summary
static cz.cuni.amis.utils.token.Token ArmorPropertyToken
           
static cz.cuni.amis.utils.token.Token DriverPropertyToken
           
static cz.cuni.amis.utils.token.Token HealthPropertyToken
           
static cz.cuni.amis.utils.token.Token LocationPropertyToken
           
static cz.cuni.amis.utils.token.Token RotationPropertyToken
           
static Set<cz.cuni.amis.utils.token.Token> SharedPropertyTokens
           
protected  long SimTime
           
static cz.cuni.amis.utils.token.Token TeamLockedPropertyToken
           
static cz.cuni.amis.utils.token.Token TeamPropertyToken
           
static cz.cuni.amis.utils.token.Token VelocityPropertyToken
           
 
Constructor Summary
VehicleShared()
          Parameter-less contructor for the message.
 
Method Summary
abstract  VehicleShared clone()
           
abstract  Integer getArmor()
          How much the vehicle has left.
 Class getCompositeClass()
           
abstract  UnrealId getDriver()
          Unique Id of the driver - if any.
abstract  Integer getHealth()
          How much health the vehicle has left.
abstract  UnrealId getId()
          Unique Id of the vehicle or vehicle part.
abstract  Location getLocation()
          An absolute location of the vehicle within the map.
abstract  Rotation getRotation()
          Which direction the vehicle is facing in absolute terms.
 long getSimTime()
          Simulation time in MILLI SECONDS !!!
abstract  Integer getTeam()
          What team the vehicle is on. 255 is no team. 0-3 are red, blue, green, gold in that order.
abstract  Velocity getVelocity()
          Absolute velocity of the vehicle as a vector of movement per one game second.
abstract  boolean isTeamLocked()
          If the vehicle is locked just for its current team.
protected  void setSimTime(long SimTime)
          Used by Yylex to slip correct time of the object or programmatically.
 String toHtmlString()
           
 String toString()
           
 
Methods inherited from class cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
toJsonLiteral
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface cz.cuni.amis.pogamut.multi.communication.worldview.object.ISharedWorldObject
getProperties, getProperty
 

Field Detail

SimTime

protected long SimTime

RotationPropertyToken

public static final cz.cuni.amis.utils.token.Token RotationPropertyToken

LocationPropertyToken

public static final cz.cuni.amis.utils.token.Token LocationPropertyToken

VelocityPropertyToken

public static final cz.cuni.amis.utils.token.Token VelocityPropertyToken

TeamPropertyToken

public static final cz.cuni.amis.utils.token.Token TeamPropertyToken

HealthPropertyToken

public static final cz.cuni.amis.utils.token.Token HealthPropertyToken

ArmorPropertyToken

public static final cz.cuni.amis.utils.token.Token ArmorPropertyToken

DriverPropertyToken

public static final cz.cuni.amis.utils.token.Token DriverPropertyToken

TeamLockedPropertyToken

public static final cz.cuni.amis.utils.token.Token TeamLockedPropertyToken

SharedPropertyTokens

public static final Set<cz.cuni.amis.utils.token.Token> SharedPropertyTokens
Constructor Detail

VehicleShared

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

Method Detail

getSimTime

public long getSimTime()
Simulation time in MILLI SECONDS !!!

Specified by:
getSimTime in interface IWorldObject
Specified by:
getSimTime in interface ISharedWorldObject

setSimTime

protected void setSimTime(long SimTime)
Used by Yylex to slip correct time of the object or programmatically.


clone

public abstract VehicleShared clone()
Specified by:
clone in interface ISharedWorldObject
Overrides:
clone in class Object

getCompositeClass

public Class getCompositeClass()
Specified by:
getCompositeClass in interface ISharedWorldObject

getId

public abstract UnrealId getId()
Unique Id of the vehicle or vehicle part.

Specified by:
getId in interface IWorldObject

getRotation

public abstract Rotation getRotation()
Which direction the vehicle is facing in absolute terms.

Specified by:
getRotation in interface IRotable

getLocation

public abstract Location getLocation()
An absolute location of the vehicle within the map.

Specified by:
getLocation in interface ILocated

getVelocity

public abstract Velocity getVelocity()
Absolute velocity of the vehicle as a vector of movement per one game second.

Specified by:
getVelocity in interface ILocomotive

getTeam

public abstract Integer getTeam()
What team the vehicle is on. 255 is no team. 0-3 are red, blue, green, gold in that order.


getHealth

public abstract Integer getHealth()
How much health the vehicle has left. Ranges from 0 to x, depending on the vehicle type.


getArmor

public abstract Integer getArmor()
How much the vehicle has left. Note: This may be 0 all the time. Maybe the vehicles are not supporting armor.


getDriver

public abstract UnrealId getDriver()
Unique Id of the driver - if any.


isTeamLocked

public abstract boolean isTeamLocked()
If the vehicle is locked just for its current team.


toString

public String toString()
Overrides:
toString in class InfoMessage

toHtmlString

public String toHtmlString()


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