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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, Event

public class EnteredVehicle
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event ENTERED.

Complete message documentation: Asynchronous message. Sent as a response to ENTER command. Sent if the ENTER command was successfull. Means we are now driving the vehicle. Beware! When in vehicle just command RUNTO with Target specified works for move commands. Any other move commands will cause vehicle to got straight ahead. Also it is not possible to control speed or steering at this moment. Everything is done automaticaly by RUNTO with Target specified.

Field Summary

protected UnrealId	Id Id of the vehicle entered.
protected Location	Location Location of the vehicle.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime
protected java.lang.String	Type Type of the vehicle entered.

Constructor Summary

EnteredVehicle()
Parameter-less contructor for the message.

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

EnteredVehicle(UnrealId Id, java.lang.String Type, Location Location)
Creates new instance of the message EnteredVehicle.

Method Summary

UnrealId	getId() Id of the vehicle entered.
Location	getLocation() Location of the vehicle.
long	getSimTime() Returns the simulation time when the event has occurred.
java.lang.String	getType() Type of the vehicle entered.
protected void	setSimTime(long SimTime) Used by Yylex to slip correct time of the object or programmatically.
java.lang.String	toHtmlString()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROTOTYPE

public static final java.lang.String PROTOTYPE

Example how the message looks like - used during parser tests.

See Also:

Constant Field Values

SimTime

protected long SimTime

Id

protected UnrealId Id

Id of the vehicle entered.

Type

protected java.lang.String Type

Type of the vehicle entered. What kind of turret or car.

Location

protected Location Location

Location of the vehicle.

Constructor Detail

EnteredVehicle

public EnteredVehicle()

Parameter-less contructor for the message.

EnteredVehicle

public EnteredVehicle(UnrealId Id,
                      java.lang.String Type,
                      Location Location)

Creates new instance of the message EnteredVehicle. Asynchronous message. Sent as a response to ENTER command. Sent if the ENTER command was successfull. Means we are now driving the vehicle. Beware! When in vehicle just command RUNTO with Target specified works for move commands. Any other move commands will cause vehicle to got straight ahead. Also it is not possible to control speed or steering at this moment. Everything is done automaticaly by RUNTO with Target specified. Corresponding GameBots message is ENTERED.

Parameters:

Id - Id of the vehicle entered.

Type - Type of the vehicle entered. What kind of turret or car.

Location - Location of the vehicle.

EnteredVehicle

public EnteredVehicle(EnteredVehicle original)

Cloning constructor from the full message.

Parameters:

original -

Method Detail

getSimTime

public long getSimTime()

Description copied from interface: IWorldEvent

Returns the simulation time when the event has occurred.

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

Returns:

timestamp

setSimTime

protected void setSimTime(long SimTime)

Used by Yylex to slip correct time of the object or programmatically.

getId

public UnrealId getId()

Id of the vehicle entered.

getType

public java.lang.String getType()

Type of the vehicle entered. What kind of turret or car.

getLocation

public Location getLocation()

Location of the vehicle.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()