cz.cuni.amis.pogamut.udk.communication.messages.gbinfomessages
Class TriggerUsed

java.lang.Object
  cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      cz.cuni.amis.pogamut.udk.communication.messages.GBEvent
          cz.cuni.amis.pogamut.udk.communication.messages.gbinfomessages.TriggerUsed

All Implemented Interfaces:

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

public class TriggerUsed
extends GBEvent
implements IWorldEvent, IWorldChangeEvent

Asynchronous message. Sent when the observed player tried to use an object. Corresponding GameBots message is TRGUSED.

Field Summary

static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected boolean	Success Whether the object was succesfully used
protected UnrealId	Target ID of the actor that was used.

Constructor Summary

TriggerUsed()
Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).

TriggerUsed(boolean Success, UnrealId Target)
Creates new instance of command TriggerUsed.

TriggerUsed(TriggerUsed original)
Cloning constructor.

Method Summary

long	getSimTime()
UnrealId	getTarget() ID of the actor that was used.
boolean	isSuccess() Whether the object was succesfully used
String	toHtmlString()
String	toString()

Methods inherited from class cz.cuni.amis.pogamut.udk.communication.messages.GBEvent

getWorldEvent

Methods inherited from class cz.cuni.amis.pogamut.base.communication.messages.InfoMessage

toJsonLiteral

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

Success

protected boolean Success

Whether the object was succesfully used

Target

protected UnrealId Target

ID of the actor that was used.

Constructor Detail

TriggerUsed

public TriggerUsed(boolean Success,
                   UnrealId Target)

Creates new instance of command TriggerUsed. Asynchronous message. Sent when the observed player tried to use an object. Corresponding GameBots message for this command is .

Parameters:

Success - Whether the object was succesfully used

Target - ID of the actor that was used.

TriggerUsed

public TriggerUsed(TriggerUsed original)

Cloning constructor.

TriggerUsed

public TriggerUsed()

Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).

Method Detail

isSuccess

public boolean isSuccess()

Whether the object was succesfully used

getTarget

public UnrealId getTarget()

ID of the actor that was used.

getSimTime

public long getSimTime()

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

Overrides:

getSimTime in class GBEvent

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()