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

java.lang.Object
  cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.Vehicle
          cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.VehicleMessage

All Implemented Interfaces:

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

public class VehicleMessage
extends Vehicle
implements IWorldObjectUpdatedEvent, ICompositeWorldObjectUpdatedEvent

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

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.

Nested Class Summary

class	VehicleMessage.VehicleLocalMessage Implementation of the local part of the GameBots2004 message VEH, used to facade VEHMessage.
class	VehicleMessage.VehicleSharedMessage Implementation of the shared part of the GameBots2004 message VEH, used to facade VEHMessage.
class	VehicleMessage.VehicleStaticMessage Implementation of the static part of the GameBots2004 message VEH, used to facade VEHMessage.

Nested classes/interfaces inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.Vehicle

Vehicle.ObjectDisappeared, Vehicle.VehicleUpdate

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

IWorldObjectUpdatedEvent.DestroyWorldObject

Field Summary

protected Integer	Armor How much the vehicle has left.
protected boolean	Armor_Set Whether property 'Armor' was received from GB2004.
protected UnrealId	Driver Unique Id of the driver - if any.
protected boolean	Driver_Set Whether property 'Driver' was received from GB2004.
protected Integer	Health How much health the vehicle has left.
protected boolean	Health_Set Whether property 'Health' was received from GB2004.
protected UnrealId	Id Unique Id of the vehicle or vehicle part.
protected boolean	Id_Set Whether property 'Id' was received from GB2004.
protected Location	Location An absolute location of the vehicle within the map.
protected boolean	Location_Set Whether property 'Location' was received from GB2004.
protected Rotation	Rotation Which direction the vehicle is facing in absolute terms.
protected boolean	Rotation_Set Whether property 'Rotation' was received from GB2004.
protected Integer	Team What team the vehicle is on. 255 is no team. 0-3 are red, blue, green, gold in that order.
protected boolean	Team_Set Whether property 'Team' was received from GB2004.
protected ITeamId	TeamId
protected boolean	TeamLocked If the vehicle is locked just for its current team.
protected boolean	TeamLocked_Set Whether property 'TeamLocked' was received from GB2004.
protected String	Type Class of the vehicle.
protected boolean	Type_Set Whether property 'Type' was received from GB2004.
protected Velocity	Velocity Absolute velocity of the vehicle as a vector of movement per one game second.
protected boolean	Velocity_Set Whether property 'Velocity' was received from GB2004.
protected boolean	Visible If the vehicle 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.Vehicle

PROTOTYPE, SimTime

Constructor Summary

VehicleMessage()
Parameter-less contructor for the message.

VehicleMessage(UnrealId Id, Rotation Rotation, Location Location, Velocity Velocity, boolean Visible, Integer Team, Integer Health, Integer Armor, UnrealId Driver, boolean TeamLocked, String Type)
Creates new instance of the message Vehicle.

VehicleMessage(VehicleMessage original)
Cloning constructor from the full message.

Method Summary

Integer	getArmor() How much the vehicle has left.
UnrealId	getDriver() Unique Id of the driver - if any.
Integer	getHealth() How much health the vehicle has left.
UnrealId	getId() Unique Id of the vehicle or vehicle part.
VehicleLocal	getLocal()
ILocalWorldObjectUpdatedEvent	getLocalEvent()
Location	getLocation() An absolute location of the vehicle within the map.
Rotation	getRotation() Which direction the vehicle is facing in absolute terms.
VehicleShared	getShared()
ISharedWorldObjectUpdatedEvent	getSharedEvent()
VehicleStatic	getStatic()
IStaticWorldObjectUpdatedEvent	getStaticEvent()
Integer	getTeam() What team the vehicle is on. 255 is no team. 0-3 are red, blue, green, gold in that order.
ITeamId	getTeamId()
String	getType() Class of the vehicle.
Velocity	getVelocity() Absolute velocity of the vehicle as a vector of movement per one game second.
boolean	isTeamLocked() If the vehicle is locked just for its current team.
boolean	isVisible() If the vehicle is in the field of view of the bot.
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.Vehicle

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

Unique Id of the vehicle or vehicle part.

Id_Set

protected boolean Id_Set

Whether property 'Id' was received from GB2004.

Rotation

protected Rotation Rotation

Which direction the vehicle is facing in absolute terms.

Rotation_Set

protected boolean Rotation_Set

Whether property 'Rotation' was received from GB2004.

Location

protected Location Location

An absolute location of the vehicle within the map.

Location_Set

protected boolean Location_Set

Whether property 'Location' was received from GB2004.

Velocity

protected Velocity Velocity

Absolute velocity of the vehicle as a vector of movement per one game second.

Velocity_Set

protected boolean Velocity_Set

Whether property 'Velocity' was received from GB2004.

Visible

protected boolean Visible

If the vehicle is in the field of view of the bot.

Visible_Set

protected boolean Visible_Set

Whether property 'Visible' was received from GB2004.

Team

protected Integer Team

What team the vehicle is on. 255 is no team. 0-3 are red, blue, green, gold in that order.

Team_Set

protected boolean Team_Set

Whether property 'Team' was received from GB2004.

Health

protected Integer Health

How much health the vehicle has left. Ranges from 0 to x, depending on the vehicle type.

Health_Set

protected boolean Health_Set

Whether property 'Health' was received from GB2004.

Armor

protected Integer Armor

How much the vehicle has left. Note: This may be 0 all the time. Maybe the vehicles are not supporting armor.

Armor_Set

protected boolean Armor_Set

Whether property 'Armor' was received from GB2004.

Driver

protected UnrealId Driver

Unique Id of the driver - if any.

Driver_Set

protected boolean Driver_Set

Whether property 'Driver' was received from GB2004.

TeamLocked

protected boolean TeamLocked

If the vehicle is locked just for its current team.

TeamLocked_Set

protected boolean TeamLocked_Set

Whether property 'TeamLocked' was received from GB2004.

Type

protected String Type

Class of the vehicle. If it is a car, turret etc.

Type_Set

protected boolean Type_Set

Whether property 'Type' was received from GB2004.

Constructor Detail

VehicleMessage

public VehicleMessage()

Parameter-less contructor for the message.

VehicleMessage

public VehicleMessage(UnrealId Id,
                      Rotation Rotation,
                      Location Location,
                      Velocity Velocity,
                      boolean Visible,
                      Integer Team,
                      Integer Health,
                      Integer Armor,
                      UnrealId Driver,
                      boolean TeamLocked,
                      String Type)

Creates new instance of the message Vehicle. 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. Corresponding GameBots message is VEH.

Parameters:

Id - Unique Id of the vehicle or vehicle part.

Rotation - Which direction the vehicle is facing in absolute terms.

Location - An absolute location of the vehicle within the map.

Velocity - Absolute velocity of the vehicle as a vector of movement per one game second.

Visible - If the vehicle is in the field of view of the bot.

Team - What team the vehicle is on. 255 is no team. 0-3 are red, blue, green, gold in that order.

Health - How much health the vehicle has left. Ranges from 0 to x, depending on the vehicle type.

Armor - How much the vehicle has left. Note: This may be 0 all the time. Maybe the vehicles are not supporting armor.

Driver - Unique Id of the driver - if any.

TeamLocked - If the vehicle is locked just for its current team.

Type - Class of the vehicle. If it is a car, turret etc.

VehicleMessage

public VehicleMessage(VehicleMessage 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: Vehicle

Unique Id of the vehicle or vehicle part.

Specified by:

getId in interface IWorldObjectUpdatedEvent

Specified by:

getId in interface IWorldObject

Specified by:

getId in interface ICompositeWorldObjectUpdatedEvent

Specified by:

getId in class Vehicle

getRotation

public Rotation getRotation()

Description copied from class: Vehicle

Which direction the vehicle is facing in absolute terms.

Specified by:

getRotation in interface IRotable

Specified by:

getRotation in class Vehicle

getLocation

public Location getLocation()

Description copied from class: Vehicle

An absolute location of the vehicle within the map.

Specified by:

getLocation in interface ILocated

Specified by:

getLocation in class Vehicle

getVelocity

public Velocity getVelocity()

Description copied from class: Vehicle

Absolute velocity of the vehicle as a vector of movement per one game second.

Specified by:

getVelocity in interface ILocomotive

Specified by:

getVelocity in class Vehicle

isVisible

public boolean isVisible()

Description copied from class: Vehicle

If the vehicle is in the field of view of the bot.

Specified by:

isVisible in interface IViewable

Specified by:

isVisible in class Vehicle

getTeam

public Integer getTeam()

Description copied from class: Vehicle

What team the vehicle is on. 255 is no team. 0-3 are red, blue, green, gold in that order.

Specified by:

getTeam in class Vehicle

getHealth

public Integer getHealth()

Description copied from class: Vehicle

How much health the vehicle has left. Ranges from 0 to x, depending on the vehicle type.

Specified by:

getHealth in class Vehicle

getArmor

public Integer getArmor()

Description copied from class: Vehicle

How much the vehicle has left. Note: This may be 0 all the time. Maybe the vehicles are not supporting armor.

Specified by:

getArmor in class Vehicle

getDriver

public UnrealId getDriver()

Description copied from class: Vehicle

Unique Id of the driver - if any.

Specified by:

getDriver in class Vehicle

isTeamLocked

public boolean isTeamLocked()

Description copied from class: Vehicle

If the vehicle is locked just for its current team.

Specified by:

isTeamLocked in class Vehicle

getType

public String getType()

Description copied from class: Vehicle

Class of the vehicle. If it is a car, turret etc.

Specified by:

getType in class Vehicle

getLocal

public VehicleLocal getLocal()

Specified by:

getLocal in interface ICompositeWorldObject

getShared

public VehicleShared getShared()

Specified by:

getShared in interface ICompositeWorldObject

getStatic

public VehicleStatic 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 Vehicle

toHtmlString

public String toHtmlString()

Overrides:

toHtmlString in class Vehicle