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

Class ObjectSelected

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.ObjectSelected

All Implemented Interfaces:

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

public class ObjectSelected
extends GBEvent
implements IWorldEvent, IWorldChangeEvent

Asynchronous message. Player selected an object in the environment in PlayerMousing state (by pressing ALT + SHIFT to switch to this state). Corresponding GameBots message is SEL.

Field Summary

Fields

Modifier and Type	Field and Description
protected Location	ObjectHitLocation Location of the hit point that we have selected this actor through.
protected UnrealId	ObjectId Id of the actor the player selected (actors include other players or bots and other physical objects that can block your path and even level geometry actors).
protected Location	ObjectLocation Location of the actor the player selected.
protected UnrealId	PlayerId Unique Id of the player that this event is for.
protected String	PlayerName Name of the player that this event is for.
static String	PROTOTYPE Example how the message looks like - used during parser tests.

Constructor Summary

Constructors

Constructor and Description
ObjectSelected() Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).
ObjectSelected(ObjectSelected original) Cloning constructor.
ObjectSelected(UnrealId PlayerId, String PlayerName, UnrealId ObjectId, Location ObjectLocation, Location ObjectHitLocation) Creates new instance of command ObjectSelected.

Method Summary

Methods

Modifier and Type	Method and Description
Location	getObjectHitLocation() Location of the hit point that we have selected this actor through.
UnrealId	getObjectId() Id of the actor the player selected (actors include other players or bots and other physical objects that can block your path and even level geometry actors).
Location	getObjectLocation() Location of the actor the player selected.
UnrealId	getPlayerId() Unique Id of the player that this event is for.
String	getPlayerName() Name of the player that this event is for.
long	getSimTime()
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

PlayerId

protected UnrealId PlayerId

Unique Id of the player that this event is for.

PlayerName

protected String PlayerName

Name of the player that this event is for.

ObjectId

protected UnrealId ObjectId

Id of the actor the player selected (actors include other players or bots and other physical objects that can block your path and even level geometry actors). Will be "None" if nothing was selected (or actor was deselected).

ObjectLocation

protected Location ObjectLocation

Location of the actor the player selected. Sent only if some object selected.

ObjectHitLocation

protected Location ObjectHitLocation

Location of the hit point that we have selected this actor through. Sent only if some object selected.

Constructor Detail

ObjectSelected

public ObjectSelected(UnrealId PlayerId,
              String PlayerName,
              UnrealId ObjectId,
              Location ObjectLocation,
              Location ObjectHitLocation)

Creates new instance of command ObjectSelected. Asynchronous message. Player selected an object in the environment in PlayerMousing state (by pressing ALT + SHIFT to switch to this state). Corresponding GameBots message for this command is .

Parameters:

PlayerId - Unique Id of the player that this event is for.

PlayerName - Name of the player that this event is for.

ObjectId - Id of the actor the player selected (actors include other players or bots and other physical objects that can block your path and even level geometry actors). Will be "None" if nothing was selected (or actor was deselected).

ObjectLocation - Location of the actor the player selected. Sent only if some object selected.

ObjectHitLocation - Location of the hit point that we have selected this actor through. Sent only if some object selected.

ObjectSelected

public ObjectSelected(ObjectSelected original)

Cloning constructor.

ObjectSelected

public ObjectSelected()

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

Method Detail

getPlayerId

public UnrealId getPlayerId()

Unique Id of the player that this event is for.

getPlayerName

public String getPlayerName()

Name of the player that this event is for.

getObjectId

public UnrealId getObjectId()

Id of the actor the player selected (actors include other players or bots and other physical objects that can block your path and even level geometry actors). Will be "None" if nothing was selected (or actor was deselected).

getObjectLocation

public Location getObjectLocation()

Location of the actor the player selected. Sent only if some object selected.

getObjectHitLocation

public Location getObjectHitLocation()

Location of the hit point that we have selected this actor through. Sent only if some object selected.

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()