cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages
Class NavPointMessage.NavPointStaticMessage

java.lang.Object
  cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.NavPointStatic
          cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.NavPointMessage.NavPointStaticMessage

All Implemented Interfaces:

IWorldObject, IStaticWorldObject

Enclosing class:

NavPointMessage

public class NavPointMessage.NavPointStaticMessage
extends NavPointStatic

Implementation of the static part of the GameBots2004 message NAV, used to facade NAVMessage.

Complete message documentation: Synchronous message - however only NavPoints marking item pickup locations are exported synchronously. Other NavPoints are not exported synchronously at all, even if the bot can actually see them (but note that ALL NavPoints are exported in the handshake between bot and the server). Exporting NavPoints synchronously took a lot of UT server resources with limited information gain (in Pogamut there is now available visibility matrix holding static information which points can be seen from other points). NavPoint carries information about UT navigation point - location, paths and some additional information are stored there (if it is an ambush point, or sniper point, etc.).

Field Summary

Fields inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.NavPointStatic

SimTime

Constructor Summary

NavPointMessage.NavPointStaticMessage()

Method Summary

NavPointMessage.NavPointStaticMessage	clone()
int	getDomPointController() Exported if this NavPoint is a DominationPoint (for BotDoubleDomination game) - which team controls this point.
UnrealId	getId() A unique Id of this navigation point assigned by the game.
Map<UnrealId,NavPointNeighbourLink>	getIncomingEdges() Maps edge-ORIGINATES_FROM-navpoint-UnrealId to neighbour link, those are incoming edges (those edges that originates in different navpoint and ends here, do not use this to ask whether you can get to navpoint of specific unreal id, use OutgoingEdges instead).
UnrealId	getItem() Unique Id of the respawned item (the item respawns at this point).
ItemType	getItemClass() Class of the item (e.g. xWeapons.FlakCannonPickup).
Item	getItemInstance() If item should be present at this navpoint it's instance will be here.
javax.vecmath.Vector3d	getLiftOffset() Starting vector between MyLift location and LiftCenter location.
UnrealId	getMover() If this NavPoint is marking some mover, the mover id will be here.
Map<UnrealId,NavPointNeighbourLink>	getOutgoingEdges() Maps edge-LEADING_TO-navpoint-UnrealId to neighbour link, those are outgoing edges (those edges that originates in this navpoint going to another one, those you may usually travel).
String	getPreferedWeapon() Class of the weapon that should be prefered when using this point for AIMarker specified action.
Rotation	getRotation() If the type is AIMarker.
int	getTeamNumber() Will be sent if this is a player start.
boolean	isAIMarker() If this point is an AI marker - marks an interesting spot in the environment.
boolean	isDifferentFrom(IStaticWorldObject other)
boolean	isDomPoint() If this point marks a DominationPoint (for BotDoubleDomination game).
boolean	isDoor() If this point marks a door mover.
boolean	isInvSpot() If this is an inventory spot (item is respawned at this point).
boolean	isJumpDest() If this point marks a jump destination - some place that can be reached by some special jump.
boolean	isJumpPad() If this point marks a jump pad (a special device that causes the bot to jump high or far).
boolean	isJumpSpot() If this point marks a jump spot (a special device that causes the bot to jump high or far).
boolean	isLiftCenter() If this point marks a lift center (used to mark center of a lift mover, note that this point will be always moved with the lift).
boolean	isLiftExit() If this point marks a lift exit (used to mark exit point of a lift mover).
boolean	isLiftJumpExit() Boolean.
boolean	isNoDoubleJump() Boolean.
boolean	isPlayerStart() If this is a player start (players and/or bots are respawned at this point).
boolean	isRoamingSpot() Some ambush point, where is good chance to intercept approaching opponents.
boolean	isSnipingSpot() Point good for sniping.
boolean	isTeleporter() If this point marks a teleport.
String	toHtmlString()
String	toString()

Methods inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.NavPointStatic

getCompositeClass, getSimTime, setSimTime

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

Constructor Detail

NavPointMessage.NavPointStaticMessage

public NavPointMessage.NavPointStaticMessage()

Method Detail

clone

public NavPointMessage.NavPointStaticMessage clone()

Specified by:

clone in class NavPointStatic

getId

public UnrealId getId()

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

Specified by:

getId in interface IWorldObject

Specified by:

getId in class NavPointStatic

getItem

public UnrealId getItem()

Unique Id of the respawned item (the item respawns at this point). Not sent if point is not an inventory spot. Sent only in HandShake.

Specified by:

getItem in class NavPointStatic

getItemClass

public ItemType getItemClass()

Class of the item (e.g. xWeapons.FlakCannonPickup). Not sent if point is not an inventory spot. Sent only in HandShake.

Specified by:

getItemClass in class NavPointStatic

getMover

public UnrealId getMover()

If this NavPoint is marking some mover, the mover id will be here. Not sent if point is not a Door, a LiftCenter or a LiftExit. Sent only in HandShake.

Specified by:

getMover in class NavPointStatic

getLiftOffset

public javax.vecmath.Vector3d getLiftOffset()

Starting vector between MyLift location and LiftCenter location. Not sent if point is not a LiftCenter. Sent only in HandShake.

Specified by:

getLiftOffset in class NavPointStatic

isLiftJumpExit

public boolean isLiftJumpExit()

Boolean. If we can/should exit the lift by a jump when near the destination place. Not sent if point is not a LiftExit. Sent only in HandShake.

Specified by:

isLiftJumpExit in class NavPointStatic

isNoDoubleJump

public boolean isNoDoubleJump()

Boolean. If we should or not use double jump when exiting lift with a jump. Not sent if point is not a LiftExit. Sent only in HandShake.

Specified by:

isNoDoubleJump in class NavPointStatic

isInvSpot

public boolean isInvSpot()

If this is an inventory spot (item is respawned at this point).

Specified by:

isInvSpot in class NavPointStatic

isPlayerStart

public boolean isPlayerStart()

If this is a player start (players and/or bots are respawned at this point).

Specified by:

isPlayerStart in class NavPointStatic

getTeamNumber

public int getTeamNumber()

Will be sent if this is a player start. In Team games (team deathmatch, capture the flag, domination) holds information about which team respawns at this player start spot. In non-team games will return 0!

Specified by:

getTeamNumber in class NavPointStatic

isDomPoint

public boolean isDomPoint()

If this point marks a DominationPoint (for BotDoubleDomination game).

Specified by:

isDomPoint in class NavPointStatic

getDomPointController

public int getDomPointController()

Exported if this NavPoint is a DominationPoint (for BotDoubleDomination game) - which team controls this point.

Specified by:

getDomPointController in class NavPointStatic

isDoor

public boolean isDoor()

If this point marks a door mover.

Specified by:

isDoor in class NavPointStatic

isLiftCenter

public boolean isLiftCenter()

If this point marks a lift center (used to mark center of a lift mover, note that this point will be always moved with the lift).

Specified by:

isLiftCenter in class NavPointStatic

isLiftExit

public boolean isLiftExit()

If this point marks a lift exit (used to mark exit point of a lift mover).

Specified by:

isLiftExit in class NavPointStatic

isAIMarker

public boolean isAIMarker()

If this point is an AI marker - marks an interesting spot in the environment. May be ambush point or sniping spot, etc.

Specified by:

isAIMarker in class NavPointStatic

isJumpSpot

public boolean isJumpSpot()

If this point marks a jump spot (a special device that causes the bot to jump high or far).

Specified by:

isJumpSpot in class NavPointStatic

isJumpPad

public boolean isJumpPad()

If this point marks a jump pad (a special device that causes the bot to jump high or far).

Specified by:

isJumpPad in class NavPointStatic

isJumpDest

public boolean isJumpDest()

If this point marks a jump destination - some place that can be reached by some special jump.

Specified by:

isJumpDest in class NavPointStatic

isTeleporter

public boolean isTeleporter()

If this point marks a teleport.

Specified by:

isTeleporter in class NavPointStatic

getRotation

public Rotation getRotation()

If the type is AIMarker. The rotation the bot should be facing, when doing the action specified by AIMarker. Sent only in HandShake.

Specified by:

getRotation in class NavPointStatic

isRoamingSpot

public boolean isRoamingSpot()

Some ambush point, where is good chance to intercept approaching opponents. Sent only in HandShake.

Specified by:

isRoamingSpot in class NavPointStatic

isSnipingSpot

public boolean isSnipingSpot()

Point good for sniping. Sent only in HandShake.

Specified by:

isSnipingSpot in class NavPointStatic

getItemInstance

public Item getItemInstance()

If item should be present at this navpoint it's instance will be here.

Specified by:

getItemInstance in class NavPointStatic

getOutgoingEdges

public Map<UnrealId,NavPointNeighbourLink> getOutgoingEdges()

Maps edge-LEADING_TO-navpoint-UnrealId to neighbour link, those are outgoing edges (those edges that originates in this navpoint going to another one, those you may usually travel).

Specified by:

getOutgoingEdges in class NavPointStatic

getIncomingEdges

public Map<UnrealId,NavPointNeighbourLink> getIncomingEdges()

Maps edge-ORIGINATES_FROM-navpoint-UnrealId to neighbour link, those are incoming edges (those edges that originates in different navpoint and ends here, do not use this to ask whether you can get to navpoint of specific unreal id, use OutgoingEdges instead).

Specified by:

getIncomingEdges in class NavPointStatic

getPreferedWeapon

public String getPreferedWeapon()

Class of the weapon that should be prefered when using this point for AIMarker specified action. Sent only in HandShake.

Specified by:

getPreferedWeapon in class NavPointStatic

isDifferentFrom

public boolean isDifferentFrom(IStaticWorldObject other)

Specified by:

isDifferentFrom in interface IStaticWorldObject

Overrides:

isDifferentFrom in class NavPointStatic

toString

public String toString()

Overrides:

toString in class NavPointStatic

toHtmlString

public String toHtmlString()

Overrides:

toHtmlString in class NavPointStatic