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

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

All Implemented Interfaces:

IWorldObject, ISharedWorldObject, Cloneable

Direct Known Subclasses:

PlayerMessage.PlayerSharedMessage, PlayerSharedImpl

public abstract class PlayerShared
extends InfoMessage
implements ISharedWorldObject

Abstract definition of the shared part of the GameBots2004 message PLR.

Complete message documentation: Synchronous message. Contains information about other players in the game, like their current velocity, position, weapon and reachability. Only reports those players that are visible. (within field of view and not occluded).

Field Summary

static cz.cuni.amis.utils.token.Token	ActionPropertyToken
static cz.cuni.amis.utils.token.Token	AnimPropertyToken
static cz.cuni.amis.utils.token.Token	BubblePropertyToken
static cz.cuni.amis.utils.token.Token	CrouchedPropertyToken
static cz.cuni.amis.utils.token.Token	EmotCenterPropertyToken
static cz.cuni.amis.utils.token.Token	EmotLeftPropertyToken
static cz.cuni.amis.utils.token.Token	EmotRightPropertyToken
static cz.cuni.amis.utils.token.Token	FiringPropertyToken
static cz.cuni.amis.utils.token.Token	LocationPropertyToken
static cz.cuni.amis.utils.token.Token	NamePropertyToken
static cz.cuni.amis.utils.token.Token	RotationPropertyToken
static Set<cz.cuni.amis.utils.token.Token>	SharedPropertyTokens
protected long	SimTime
static cz.cuni.amis.utils.token.Token	TeamPropertyToken
static cz.cuni.amis.utils.token.Token	VelocityPropertyToken
static cz.cuni.amis.utils.token.Token	WeaponPropertyToken

Constructor Summary

PlayerShared()
Parameter-less contructor for the message.

Method Summary

abstract PlayerShared	clone()
abstract String	getAction() Atomic action this bot is doing (BDI).
abstract String	getAnim() For UE2.
abstract String	getBubble() For UE2.
Class	getCompositeClass()
abstract String	getEmotCenter() For UE2.
abstract String	getEmotLeft() For UE2.
abstract String	getEmotRight() For UE2.
abstract int	getFiring() 0 means is not firing, 1 - firing in primary mode, 2 - firing in secondary mode (alt firing).
abstract UnrealId	getId() Unique Id of the player.
abstract Location	getLocation() An absolute location of the player within the map.
abstract String	getName() Human readable name of the player.
abstract Rotation	getRotation() Which direction the player is facing in absolute terms.
long	getSimTime() Simulation time in MILLI SECONDS !!!
abstract int	getTeam() What team the player is on. 255 is no team. 0-3 are red, blue, green, gold in that order.
abstract Velocity	getVelocity() Absolute velocity of the player as a vector of movement per one game second.
abstract String	getWeapon() Class of the weapon the player is holding.
abstract boolean	isCrouched() True if the bot is crouched.
protected void	setSimTime(long SimTime) Used by Yylex to slip correct time of the object or programmatically.
String	toHtmlString()
String	toString()

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

toJsonLiteral

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface cz.cuni.amis.pogamut.multi.communication.worldview.object.ISharedWorldObject

getProperties, getProperty

Field Detail

SimTime

protected long SimTime

NamePropertyToken

public static final cz.cuni.amis.utils.token.Token NamePropertyToken

ActionPropertyToken

public static final cz.cuni.amis.utils.token.Token ActionPropertyToken

RotationPropertyToken

public static final cz.cuni.amis.utils.token.Token RotationPropertyToken

LocationPropertyToken

public static final cz.cuni.amis.utils.token.Token LocationPropertyToken

VelocityPropertyToken

public static final cz.cuni.amis.utils.token.Token VelocityPropertyToken

TeamPropertyToken

public static final cz.cuni.amis.utils.token.Token TeamPropertyToken

WeaponPropertyToken

public static final cz.cuni.amis.utils.token.Token WeaponPropertyToken

CrouchedPropertyToken

public static final cz.cuni.amis.utils.token.Token CrouchedPropertyToken

FiringPropertyToken

public static final cz.cuni.amis.utils.token.Token FiringPropertyToken

EmotLeftPropertyToken

public static final cz.cuni.amis.utils.token.Token EmotLeftPropertyToken

EmotCenterPropertyToken

public static final cz.cuni.amis.utils.token.Token EmotCenterPropertyToken

EmotRightPropertyToken

public static final cz.cuni.amis.utils.token.Token EmotRightPropertyToken

BubblePropertyToken

public static final cz.cuni.amis.utils.token.Token BubblePropertyToken

AnimPropertyToken

public static final cz.cuni.amis.utils.token.Token AnimPropertyToken

SharedPropertyTokens

public static final Set<cz.cuni.amis.utils.token.Token> SharedPropertyTokens

Constructor Detail

PlayerShared

public PlayerShared()

Parameter-less contructor for the message.

Method Detail

getSimTime

public long getSimTime()

Simulation time in MILLI SECONDS !!!

Specified by:

getSimTime in interface IWorldObject

Specified by:

getSimTime in interface ISharedWorldObject

setSimTime

protected void setSimTime(long SimTime)

Used by Yylex to slip correct time of the object or programmatically.

clone

public abstract PlayerShared clone()

Specified by:

clone in interface ISharedWorldObject

Overrides:

clone in class Object

getCompositeClass

public Class getCompositeClass()

Specified by:

getCompositeClass in interface ISharedWorldObject

getId

public abstract UnrealId getId()

Unique Id of the player.

Specified by:

getId in interface IWorldObject

getName

public abstract String getName()

Human readable name of the player.

getAction

public abstract String getAction()

Atomic action this bot is doing (BDI).

getRotation

public abstract Rotation getRotation()

Which direction the player is facing in absolute terms.

getLocation

public abstract Location getLocation()

An absolute location of the player within the map.

getVelocity

public abstract Velocity getVelocity()

Absolute velocity of the player as a vector of movement per one game second.

getTeam

public abstract int getTeam()

What team the player is on. 255 is no team. 0-3 are red, blue, green, gold in that order.

getWeapon

public abstract String getWeapon()

Class of the weapon the player is holding. Weapon strings to look for include: "AssaultRifle", "ShieldGun", "FlakCannon", "BioRifle", "ShockRifle", "LinkGun", "SniperRifle", "RocketLauncher", "Minigun", "LightingGun", "Translocator". TODO: Look if this is all.

isCrouched

public abstract boolean isCrouched()

True if the bot is crouched.

getFiring

public abstract int getFiring()

0 means is not firing, 1 - firing in primary mode, 2 - firing in secondary mode (alt firing).

getEmotLeft

public abstract String getEmotLeft()

For UE2. Holds left emoticon of the bot, "None" means none set.

getEmotCenter

public abstract String getEmotCenter()

For UE2. Holds center emoticon of the bot, "None" means none set.

getEmotRight

public abstract String getEmotRight()

For UE2. Holds right emoticon of the bot, "None" means none set.

getBubble

public abstract String getBubble()

For UE2. Holds the bubble of the emoticon of the bot, "None" means none set.

getAnim

public abstract String getAnim()

For UE2. Current played animation of the bot.

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()