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

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

All Implemented Interfaces:

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

public class HearPickup
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event HRP.

Complete message documentation: Synchronous message - sent in synchronous batch (events are cached and then exported in the batch due to performance issues). You hear someone pick up an object from the ground. If the very same sound is exported repeatedly (same sound, same source), it won't be exported more than once per second.

Field Summary

protected double	Distance How far the noise source is.
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected Rotation	Rotation How should bot rotate if it would like to be in the direction of the pickuped actor
protected long	SimTime
protected UnrealId	Source Unique Id of an object picked up.
protected String	Type Class of the picked up actor.

Constructor Summary

HearPickup()
Parameter-less contructor for the message.

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

HearPickup(UnrealId Source, String Type, Rotation Rotation, double Distance)
Creates new instance of the message HearPickup.

Method Summary

double	getDistance() How far the noise source is.
Rotation	getRotation() How should bot rotate if it would like to be in the direction of the pickuped actor
long	getSimTime() Simulation time in MILLI SECONDS !!!
UnrealId	getSource() Unique Id of an object picked up.
String	getType() Class of the picked up actor.
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

Source

protected UnrealId Source

Unique Id of an object picked up.

Type

protected String Type

Class of the picked up actor.

Rotation

protected Rotation Rotation

How should bot rotate if it would like to be in the direction of the pickuped actor

Distance

protected double Distance

How far the noise source is.

Constructor Detail

HearPickup

public HearPickup()

Parameter-less contructor for the message.

HearPickup

public HearPickup(UnrealId Source,
                  String Type,
                  Rotation Rotation,
                  double Distance)

Creates new instance of the message HearPickup. Synchronous message - sent in synchronous batch (events are cached and then exported in the batch due to performance issues). You hear someone pick up an object from the ground. If the very same sound is exported repeatedly (same sound, same source), it won't be exported more than once per second. Corresponding GameBots message is HRP.

Parameters:

Source - Unique Id of an object picked up.

Type - Class of the picked up actor.

Rotation - How should bot rotate if it would like to be in the direction of the pickuped actor

Distance - How far the noise source is.

HearPickup

public HearPickup(HearPickup 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.

getSource

public UnrealId getSource()

Unique Id of an object picked up.

getType

public String getType()

Class of the picked up actor.

getRotation

public Rotation getRotation()

How should bot rotate if it would like to be in the direction of the pickuped actor

getDistance

public double getDistance()

How far the noise source is.

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()

Overrides:

toJsonLiteral in class InfoMessage