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

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

All Implemented Interfaces:

IWorldObject, ILocated, ILocomotive, ISharedWorldObject, java.lang.Cloneable

Direct Known Subclasses:

NavPointMessage.NavPointSharedMessage, NavPointSharedImpl

public abstract class NavPointShared
extends InfoMessage
implements ISharedWorldObject, ILocated, ILocomotive

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

Complete message documentation: Synchronous message. NavPoint carries information about UT navigation point - location, reachability... Also some item can be respawned at this point. Or some additional information can be stored here (if it is an ambush point, or sniper point..).

Field Summary

static Token	DoorOpenedPropertyToken
static Token	ItemSpawnedPropertyToken
static Token	LocationPropertyToken
static java.util.Set<Token>	SharedPropertyTokens
protected long	SimTime
static Token	VelocityPropertyToken

Constructor Summary

NavPointShared()
Parameter-less contructor for the message.

Method Summary

abstract NavPointShared	clone()
java.lang.Class	getCompositeClass()
abstract UnrealId	getId() A unique Id of this navigation point assigned by the game.
abstract Location	getLocation() Location of navigation point.
long	getSimTime() Returns world time when the object was seen/updated for the last time.
abstract Velocity	getVelocity() Velocity of the navigation point (if the navigation point is currently moving).
abstract boolean	isDoorOpened() True if this NavPoint is a Door and door is opened.
abstract boolean	isItemSpawned() True if the item is spawned at the point.
protected void	setSimTime(long SimTime) Used by Yylex to slip correct time of the object or programmatically.
java.lang.String	toHtmlString()
java.lang.String	toString()

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

LocationPropertyToken

public static final Token LocationPropertyToken

VelocityPropertyToken

public static final Token VelocityPropertyToken

ItemSpawnedPropertyToken

public static final Token ItemSpawnedPropertyToken

DoorOpenedPropertyToken

public static final Token DoorOpenedPropertyToken

SharedPropertyTokens

public static final java.util.Set<Token> SharedPropertyTokens

Constructor Detail

NavPointShared

public NavPointShared()

Parameter-less contructor for the message.

Method Detail

getSimTime

public long getSimTime()

Description copied from interface: ISharedWorldObject

Returns world time when the object was seen/updated for the last time.

The time suppose to be growing as the simulation carries on.

Always should be actual_timestamp >= any_prevously_recorded_timestamp,

object1.getLastSeenTime() > object2.getLastSeenTime() means that object1 last seen after object2

Specified by:

getSimTime in interface IWorldObject

Specified by:

getSimTime in interface ISharedWorldObject

Returns:

setSimTime

protected void setSimTime(long SimTime)

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

clone

public abstract NavPointShared clone()

Specified by:

clone in interface ISharedWorldObject

Overrides:

clone in class java.lang.Object

getCompositeClass

public java.lang.Class getCompositeClass()

Specified by:

getCompositeClass in interface ISharedWorldObject

getId

public abstract UnrealId getId()

A unique Id of this navigation point assigned by the game.

Specified by:

getId in interface IWorldObject

Returns:

getLocation

public abstract Location getLocation()

Location of navigation point.

Specified by:

getLocation in interface ILocated

Returns:

Current location of the object, represented as a point within the world's coordinates.

getVelocity

public abstract Velocity getVelocity()

Velocity of the navigation point (if the navigation point is currently moving). Not sent at the moment.

Specified by:

getVelocity in interface ILocomotive

Returns:

Current direction in which the object is moving and absolute velocity of the object within the world. The direction is represented as a vector within the world's coordinates. The size of velocity is represented by length of that vector.

isItemSpawned

public abstract boolean isItemSpawned()

True if the item is spawned at the point. Not sent if point is not an inventory spot.

isDoorOpened

public abstract boolean isDoorOpened()

True if this NavPoint is a Door and door is opened. Not sent if point is not a door.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()