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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, cz.cuni.amis.utils.listener.Event

public class SeeVolume
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event SVL.

Complete message documentation: UT3 specific synchronous message - sent in synchronous batch (events are cached and then exported in the batch due to performance issues). Message containing information about the navpoints laying in a deployed volume.

Field Summary

protected UnrealId	Id Unique ID of actor making the noise - may be other player or some other object in the game.
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime
protected ItemType	Type Type of this volume (e.g.
protected boolean	Visible If this navpoint is visible.

Constructor Summary

SeeVolume()
Parameter-less contructor for the message.

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

SeeVolume(UnrealId Id, boolean Visible, ItemType Type)
Creates new instance of the message SeeVolume.

Method Summary

UnrealId	getId() Unique ID of actor making the noise - may be other player or some other object in the game.
long	getSimTime() Simulation time in MILLI SECONDS !!!
ItemType	getType() Type of this volume (e.g.
boolean	isVisible() If this navpoint is visible.
protected void	setSimTime(long SimTime) Used by Yylex to slip correct time of the object or programmatically.
String	toHtmlString()
String	toJsonLiteral()
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 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

Unique ID of actor making the noise - may be other player or some other object in the game.

Visible

protected boolean Visible

If this navpoint is visible.

Type

protected ItemType Type

Type of this volume (e.g. SlowVolume, etc.)

Constructor Detail

SeeVolume

public SeeVolume()

Parameter-less contructor for the message.

SeeVolume

public SeeVolume(UnrealId Id,
                 boolean Visible,
                 ItemType Type)

Creates new instance of the message SeeVolume. UT3 specific synchronous message - sent in synchronous batch (events are cached and then exported in the batch due to performance issues). Message containing information about the navpoints laying in a deployed volume. Corresponding GameBots message is SVL.

Parameters:

Id - Unique ID of actor making the noise - may be other player or some other object in the game.

Visible - If this navpoint is visible.

Type - Type of this volume (e.g. SlowVolume, etc.)

SeeVolume

public SeeVolume(SeeVolume original)

Cloning constructor from the full message.

Parameters:

original -

Method Detail

getSimTime

public long getSimTime()

Simulation time in MILLI SECONDS !!!

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

setSimTime

protected void setSimTime(long SimTime)

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

getId

public UnrealId getId()

Unique ID of actor making the noise - may be other player or some other object in the game.

isVisible

public boolean isVisible()

If this navpoint is visible.

getType

public ItemType getType()

Type of this volume (e.g. SlowVolume, etc.)

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()

Overrides:

toJsonLiteral in class InfoMessage