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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, Event

public class Trigger
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event TRG.

Complete message documentation: Asynchronous message. When we trigger some trigger. TODO: Experiment message.

Field Summary

protected java.lang.String	Actor Should be the trigger we have triggered.
protected UnrealId	EventInstigator Should be the Id of the player who triggered this (ourself?).
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime

Constructor Summary

Trigger()
Parameter-less contructor for the message.

Trigger(java.lang.String Actor, UnrealId EventInstigator)
Creates new instance of the message Trigger.

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

Method Summary

java.lang.String	getActor() Should be the trigger we have triggered.
UnrealId	getEventInstigator() Should be the Id of the player who triggered this (ourself?).
long	getSimTime() Returns the simulation time when the event has occurred.
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

Actor

protected java.lang.String Actor

Should be the trigger we have triggered.

EventInstigator

protected UnrealId EventInstigator

Should be the Id of the player who triggered this (ourself?).

Constructor Detail

Trigger

public Trigger()

Parameter-less contructor for the message.

Trigger

public Trigger(java.lang.String Actor,
               UnrealId EventInstigator)

Creates new instance of the message Trigger. Asynchronous message. When we trigger some trigger. TODO: Experiment message. Corresponding GameBots message is TRG.

Parameters:

Actor - Should be the trigger we have triggered.

EventInstigator - Should be the Id of the player who triggered this (ourself?).

Trigger

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

getActor

public java.lang.String getActor()

Should be the trigger we have triggered.

getEventInstigator

public UnrealId getEventInstigator()

Should be the Id of the player who triggered this (ourself?).

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()