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

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

All Implemented Interfaces:

cz.cuni.amis.pogamut.base.communication.translator.event.IWorldChangeEvent, cz.cuni.amis.pogamut.base.communication.worldview.event.IWorldEvent, cz.cuni.amis.pogamut.base.communication.worldview.object.IWorldObject, cz.cuni.amis.pogamut.base3d.worldview.object.ILocated, cz.cuni.amis.pogamut.base3d.worldview.object.ILocomotive, cz.cuni.amis.pogamut.base3d.worldview.object.IRotable, cz.cuni.amis.pogamut.base3d.worldview.object.IViewable, cz.cuni.amis.pogamut.multi.communication.worldview.object.ICompositeWorldObject, cz.cuni.amis.pogamut.unreal.communication.messages.gbinfomessages.IPlayer, IPerson, IGBViewable, cz.cuni.amis.utils.listener.Event

Direct Known Subclasses:

PlayerCompositeImpl, PlayerMessage

public abstract class Player
extends cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
implements cz.cuni.amis.pogamut.base.communication.worldview.event.IWorldEvent, cz.cuni.amis.pogamut.base.communication.translator.event.IWorldChangeEvent, cz.cuni.amis.pogamut.multi.communication.worldview.object.ICompositeWorldObject, IPerson, cz.cuni.amis.pogamut.unreal.communication.messages.gbinfomessages.IPlayer, IGBViewable

Abstract definition 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).

Nested Class Summary

static class	Player.ObjectDisappeared
static class	Player.PlayerUpdate

Field Summary

static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime

Constructor Summary

Player()
Parameter-less contructor for the message.

Method Summary

cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdatedEvent	createDisappearEvent() Creates an update event that has to update visibility to false.
abstract String	getAction() Atomic action this bot is doing (BDI).
abstract String	getAnim() For UE2.
abstract String	getBubble() For UE2.
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 cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId	getId() Unique Id of the player.
abstract String	getJmx() Exported just for control server.
abstract cz.cuni.amis.pogamut.base3d.worldview.object.Location	getLocation() An absolute location of the player within the map.
abstract String	getName() Human readable name of the player.
abstract cz.cuni.amis.pogamut.base3d.worldview.object.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.
abstract cz.cuni.amis.pogamut.base3d.worldview.object.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.
abstract boolean	isVisible() If the player is in the field of view of the bot.
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 java.lang.Object

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

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

getLocal, getShared, getStatic

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

Constructor Detail

Player

public Player()

Parameter-less contructor for the message.

Method Detail

getSimTime

public long getSimTime()

Simulation time in MILLI SECONDS !!!

Specified by:

getSimTime in interface cz.cuni.amis.pogamut.base.communication.translator.event.IWorldChangeEvent

Specified by:

getSimTime in interface cz.cuni.amis.pogamut.base.communication.worldview.event.IWorldEvent

Specified by:

getSimTime in interface cz.cuni.amis.pogamut.base.communication.worldview.object.IWorldObject

Specified by:

getSimTime in interface cz.cuni.amis.pogamut.unreal.communication.messages.gbinfomessages.IPlayer

setSimTime

protected void setSimTime(long SimTime)

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

getId

public abstract cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId getId()

Unique Id of the player.

Specified by:

getId in interface cz.cuni.amis.pogamut.base.communication.worldview.object.IWorldObject

Specified by:

getId in interface cz.cuni.amis.pogamut.unreal.communication.messages.gbinfomessages.IPlayer

getJmx

public abstract String getJmx()

Exported just for control server. Holds jmx address we need to connect to when we want to debug our bot.

getName

public abstract String getName()

Human readable name of the player.

Specified by:

getName in interface cz.cuni.amis.pogamut.unreal.communication.messages.gbinfomessages.IPlayer

Specified by:

getName in interface IPerson

getAction

public abstract String getAction()

Atomic action this bot is doing (BDI).

Specified by:

getAction in interface cz.cuni.amis.pogamut.unreal.communication.messages.gbinfomessages.IPlayer

isVisible

public abstract boolean isVisible()

If the player is in the field of view of the bot.

Specified by:

isVisible in interface cz.cuni.amis.pogamut.base3d.worldview.object.IViewable

Specified by:

isVisible in interface cz.cuni.amis.pogamut.unreal.communication.messages.gbinfomessages.IPlayer

getRotation

public abstract cz.cuni.amis.pogamut.base3d.worldview.object.Rotation getRotation()

Which direction the player is facing in absolute terms.

Specified by:

getRotation in interface cz.cuni.amis.pogamut.base3d.worldview.object.IRotable

Specified by:

getRotation in interface cz.cuni.amis.pogamut.unreal.communication.messages.gbinfomessages.IPlayer

getLocation

public abstract cz.cuni.amis.pogamut.base3d.worldview.object.Location getLocation()

An absolute location of the player within the map.

Specified by:

getLocation in interface cz.cuni.amis.pogamut.base3d.worldview.object.ILocated

Specified by:

getLocation in interface cz.cuni.amis.pogamut.unreal.communication.messages.gbinfomessages.IPlayer

getVelocity

public abstract cz.cuni.amis.pogamut.base3d.worldview.object.Velocity getVelocity()

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

Specified by:

getVelocity in interface cz.cuni.amis.pogamut.base3d.worldview.object.ILocomotive

Specified by:

getVelocity in interface cz.cuni.amis.pogamut.unreal.communication.messages.gbinfomessages.IPlayer

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.

Specified by:

getTeam in interface cz.cuni.amis.pogamut.unreal.communication.messages.gbinfomessages.IPlayer

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.

Specified by:

getWeapon in interface cz.cuni.amis.pogamut.unreal.communication.messages.gbinfomessages.IPlayer

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

Specified by:

getFiring in interface cz.cuni.amis.pogamut.unreal.communication.messages.gbinfomessages.IPlayer

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.

createDisappearEvent

public cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdatedEvent createDisappearEvent()

Description copied from interface: IGBViewable

Creates an update event that has to update visibility to false.

Specified by:

createDisappearEvent in interface IGBViewable

Returns:

toString

public String toString()

Overrides:

toString in class cz.cuni.amis.pogamut.base.communication.messages.InfoMessage

toHtmlString

public String toHtmlString()

Specified by:

toHtmlString in interface cz.cuni.amis.pogamut.unreal.communication.messages.gbinfomessages.IPlayer