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

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

All Implemented Interfaces:

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

public class InteractedUsableObject
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event IUO.

Complete message documentation: Asynchronous message. Sent when the observed player interacts with usable object.

Field Summary

protected String	Action Name of the action performed.
protected Location	Location Location of the usable object.
protected String	Name Name of the usable object.
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime
protected int	UOEvent Code of the action performed.

Constructor Summary

InteractedUsableObject()
Parameter-less contructor for the message.

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

InteractedUsableObject(String Name, Location Location, int UOEvent, String Action)
Creates new instance of the message InteractedUsableObject.

Method Summary

String	getAction() Name of the action performed.
Location	getLocation() Location of the usable object.
String	getName() Name of the usable object.
long	getSimTime() Simulation time in MILLI SECONDS !!!
int	getUOEvent() Code of the action performed.
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

Name

protected String Name

Name of the usable object.

Location

protected Location Location

Location of the usable object.

UOEvent

protected int UOEvent

Code of the action performed.

Action

protected String Action

Name of the action performed.

Constructor Detail

InteractedUsableObject

public InteractedUsableObject()

Parameter-less contructor for the message.

InteractedUsableObject

public InteractedUsableObject(String Name,
                              Location Location,
                              int UOEvent,
                              String Action)

Creates new instance of the message InteractedUsableObject. Asynchronous message. Sent when the observed player interacts with usable object. Corresponding GameBots message is IUO.

Parameters:

Name - Name of the usable object.

Location - Location of the usable object.

UOEvent - Code of the action performed.

Action - Name of the action performed.

InteractedUsableObject

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

getName

public String getName()

Name of the usable object.

getLocation

public Location getLocation()

Location of the usable object.

getUOEvent

public int getUOEvent()

Code of the action performed.

getAction

public String getAction()

Name of the action performed.

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()

Overrides:

toJsonLiteral in class InfoMessage