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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, Event

public class NavPointNeighbourLink
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event INGP.

Complete message documentation: Info batch message. Start with SNGP, ends with ENGP. Sent for each INAV message at the beginning of the communication. Holds information about NavPoint neighbours. This way the reachability graph can be exported from UT2004. You should interpret this as a DIRECTED EDGE of the navpoint GRAPH that describes the the edge from FromNavPoint to ToNavPoint.

Field Summary

protected double	CalculatedGravityZ TODO: mystery how to interpret
protected int	CollisionH Maximum collision height of the path between navigation points.
protected int	CollisionR Maximum collision radius of the path between navigation points.
protected int	Flags Holds information about the path from the NavPoint to its neighbour that is represented by this message.
protected boolean	ForceDoubleJump Whether you need to double jump to get to the neighbour navpoint.
protected NavPoint	FromNavPoint Start of the link (edge), where the link originates.
protected UnrealId	Id Unique Id of the NavPoint the link is leading to (end of the link).
protected Vector3d	NeededJump TODO: mystery how to interpret
protected boolean	NeverImpactJump TODO: mystery how to interpret
protected boolean	NoLowGrav TODO: mystery how to interpret
protected boolean	OnlyTranslocator Whether the translocator is the only way how to traverse this navigation edge.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime
protected NavPoint	ToNavPoint End of the link (edge), where the link ends.
protected java.lang.String	TranslocTargetTag TODO: mystery - we haven't figure it out so far.
protected double	TranslocZOffset TODO: mystery - we haven't figure it out so far.

Constructor Summary

NavPointNeighbourLink()
Parameter-less contructor for the message.

NavPointNeighbourLink(NavPointNeighbourLink original)
Cloning constructor from the full message.

NavPointNeighbourLink(NavPointNeighbourLink orig, NavPoint from, NavPoint to)
Use to fill missing fields of the Item when creating MapObtained event before INIT command is requested.

NavPointNeighbourLink(UnrealId Id, int Flags, int CollisionR, int CollisionH, double TranslocZOffset, java.lang.String TranslocTargetTag, boolean OnlyTranslocator, boolean ForceDoubleJump, Vector3d NeededJump, boolean NeverImpactJump, boolean NoLowGrav, double CalculatedGravityZ, NavPoint FromNavPoint, NavPoint ToNavPoint)
Creates new instance of the message NavPointNeighbourLink.

Method Summary

double	getCalculatedGravityZ() TODO: mystery how to interpret
int	getCollisionH() Maximum collision height of the path between navigation points.
int	getCollisionR() Maximum collision radius of the path between navigation points.
int	getFlags() Holds information about the path from the NavPoint to its neighbour that is represented by this message.
NavPoint	getFromNavPoint() Start of the link (edge), where the link originates.
UnrealId	getId() Unique Id of the NavPoint the link is leading to (end of the link).
Vector3d	getNeededJump() TODO: mystery how to interpret
long	getSimTime() Returns the simulation time when the event has occurred.
NavPoint	getToNavPoint() End of the link (edge), where the link ends.
java.lang.String	getTranslocTargetTag() TODO: mystery - we haven't figure it out so far.
double	getTranslocZOffset() TODO: mystery - we haven't figure it out so far.
boolean	isForceDoubleJump() Whether you need to double jump to get to the neighbour navpoint.
boolean	isNeverImpactJump() TODO: mystery how to interpret
boolean	isNoLowGrav() TODO: mystery how to interpret
boolean	isOnlyTranslocator() Whether the translocator is the only way how to traverse this navigation edge.
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

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

Field Detail

PROTOTYPE

public static final java.lang.String PROTOTYPE

Example how the message looks like - used during parser tests.

See Also:

Constant Field Values

SimTime

protected long SimTime

Id

protected UnrealId Id

Unique Id of the NavPoint the link is leading to (end of the link). Always identical to ToNavPoint.getStringId().

Flags

protected int Flags

Holds information about the path from the NavPoint to its neighbour that is represented by this message. TODO: see reachspecs on UnrealWiki.

CollisionR

protected int CollisionR

Maximum collision radius of the path between navigation points. Bot bigger then this cannot use this path.

CollisionH

protected int CollisionH

Maximum collision height of the path between navigation points. Bot bigger then this cannot use this path.

TranslocZOffset

protected double TranslocZOffset

TODO: mystery - we haven't figure it out so far. Can be: a) z-coord of the translocator target b) translocator z-force for the translocator shot

TranslocTargetTag

protected java.lang.String TranslocTargetTag

TODO: mystery - we haven't figure it out so far. Can be: where you should appear when successfully translocated or where to aim at

OnlyTranslocator

protected boolean OnlyTranslocator

Whether the translocator is the only way how to traverse this navigation edge.

ForceDoubleJump

protected boolean ForceDoubleJump

Whether you need to double jump to get to the neighbour navpoint.

NeededJump

protected Vector3d NeededJump

TODO: mystery how to interpret

NeverImpactJump

protected boolean NeverImpactJump

TODO: mystery how to interpret

NoLowGrav

protected boolean NoLowGrav

TODO: mystery how to interpret

CalculatedGravityZ

protected double CalculatedGravityZ

TODO: mystery how to interpret

FromNavPoint

protected NavPoint FromNavPoint

Start of the link (edge), where the link originates.

ToNavPoint

protected NavPoint ToNavPoint

End of the link (edge), where the link ends.

Constructor Detail

NavPointNeighbourLink

public NavPointNeighbourLink()

Parameter-less contructor for the message.

NavPointNeighbourLink

public NavPointNeighbourLink(UnrealId Id,
                             int Flags,
                             int CollisionR,
                             int CollisionH,
                             double TranslocZOffset,
                             java.lang.String TranslocTargetTag,
                             boolean OnlyTranslocator,
                             boolean ForceDoubleJump,
                             Vector3d NeededJump,
                             boolean NeverImpactJump,
                             boolean NoLowGrav,
                             double CalculatedGravityZ,
                             NavPoint FromNavPoint,
                             NavPoint ToNavPoint)

Creates new instance of the message NavPointNeighbourLink. Info batch message. Start with SNGP, ends with ENGP. Sent for each INAV message at the beginning of the communication. Holds information about NavPoint neighbours. This way the reachability graph can be exported from UT2004. You should interpret this as a DIRECTED EDGE of the navpoint GRAPH that describes the the edge from FromNavPoint to ToNavPoint. Corresponding GameBots message is INGP.

Parameters:

Id - Unique Id of the NavPoint the link is leading to (end of the link). Always identical to ToNavPoint.getStringId().

Flags - Holds information about the path from the NavPoint to its neighbour that is represented by this message. TODO: see reachspecs on UnrealWiki.

CollisionR - Maximum collision radius of the path between navigation points. Bot bigger then this cannot use this path.

CollisionH - Maximum collision height of the path between navigation points. Bot bigger then this cannot use this path.

TranslocZOffset - TODO: mystery - we haven't figure it out so far. Can be: a) z-coord of the translocator target b) translocator z-force for the translocator shot

TranslocTargetTag - TODO: mystery - we haven't figure it out so far. Can be: where you should appear when successfully translocated or where to aim at

OnlyTranslocator - Whether the translocator is the only way how to traverse this navigation edge.

ForceDoubleJump - Whether you need to double jump to get to the neighbour navpoint.

NeededJump - TODO: mystery how to interpret

NeverImpactJump - TODO: mystery how to interpret

NoLowGrav - TODO: mystery how to interpret

CalculatedGravityZ - TODO: mystery how to interpret

FromNavPoint - Start of the link (edge), where the link originates.

ToNavPoint - End of the link (edge), where the link ends.

NavPointNeighbourLink

public NavPointNeighbourLink(NavPointNeighbourLink original)

Cloning constructor from the full message.

Parameters:

original -

NavPointNeighbourLink

public NavPointNeighbourLink(NavPointNeighbourLink orig,
                             NavPoint from,
                             NavPoint to)

Use to fill missing fields of the Item when creating MapObtained event before INIT command is requested.

Method Detail

getSimTime

public long getSimTime()

Description copied from interface: IWorldEvent

Returns the simulation time when the event has occurred.

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

Returns:

timestamp

setSimTime

protected void setSimTime(long SimTime)

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

getId

public UnrealId getId()

Unique Id of the NavPoint the link is leading to (end of the link). Always identical to ToNavPoint.getStringId().

getFlags

public int getFlags()

Holds information about the path from the NavPoint to its neighbour that is represented by this message. TODO: see reachspecs on UnrealWiki.

getCollisionR

public int getCollisionR()

Maximum collision radius of the path between navigation points. Bot bigger then this cannot use this path.

getCollisionH

public int getCollisionH()

Maximum collision height of the path between navigation points. Bot bigger then this cannot use this path.

getTranslocZOffset

public double getTranslocZOffset()

TODO: mystery - we haven't figure it out so far. Can be: a) z-coord of the translocator target b) translocator z-force for the translocator shot

getTranslocTargetTag

public java.lang.String getTranslocTargetTag()

TODO: mystery - we haven't figure it out so far. Can be: where you should appear when successfully translocated or where to aim at

isOnlyTranslocator

public boolean isOnlyTranslocator()

Whether the translocator is the only way how to traverse this navigation edge.

isForceDoubleJump

public boolean isForceDoubleJump()

Whether you need to double jump to get to the neighbour navpoint.

getNeededJump

public Vector3d getNeededJump()

TODO: mystery how to interpret

isNeverImpactJump

public boolean isNeverImpactJump()

TODO: mystery how to interpret

isNoLowGrav

public boolean isNoLowGrav()

TODO: mystery how to interpret

getCalculatedGravityZ

public double getCalculatedGravityZ()

TODO: mystery how to interpret

getFromNavPoint

public NavPoint getFromNavPoint()

Start of the link (edge), where the link originates.

getToNavPoint

public NavPoint getToNavPoint()

End of the link (edge), where the link ends.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()