cz.cuni.amis.pogamut.udk.communication.messages.gbinfomessages

Class PathList

java.lang.Object

cz.cuni.amis.pogamut.base.communication.messages.InfoMessage

cz.cuni.amis.pogamut.udk.communication.messages.gbinfomessages.PathList

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, cz.cuni.amis.utils.listener.Event

public class PathList
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Info batch message. A series of pathnodes in response to a GETPATH command from the client. Starts with SPTH, ends with EPTH. Represents some path in the map (sequence of traversable navigation points). Corresponding GameBots message is IPTH.

Field Summary

Fields

Modifier and Type	Field and Description
protected Location	Location Location of one navigation point in the path.
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected UnrealId	RouteId Unique Id of one navigation point in the path (well it should be navigation point - safer is to use location).

Constructor Summary

Constructors

Constructor and Description
PathList() Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).
PathList(PathList original) Cloning constructor.
PathList(UnrealId RouteId, Location Location) Creates new instance of command PathList.

Method Summary

Methods

Modifier and Type	Method and Description
Location	getLocation() Location of one navigation point in the path.
UnrealId	getRouteId() Unique Id of one navigation point in the path (well it should be navigation point - safer is to use location).
long	getSimTime()
String	toHtmlString()
String	toString()

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

toJsonLiteral

Methods inherited from class java.lang.Object

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

Field Detail

PROTOTYPE

public static final String PROTOTYPE

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

See Also:

Constant Field Values

RouteId

protected UnrealId RouteId

Unique Id of one navigation point in the path (well it should be navigation point - safer is to use location).

Location

protected Location Location

Location of one navigation point in the path.

Constructor Detail

PathList

public PathList(UnrealId RouteId,
        Location Location)

Creates new instance of command PathList. Info batch message. A series of pathnodes in response to a GETPATH command from the client. Starts with SPTH, ends with EPTH. Represents some path in the map (sequence of traversable navigation points). Corresponding GameBots message for this command is .

Parameters:

RouteId - Unique Id of one navigation point in the path (well it should be navigation point - safer is to use location).

Location - Location of one navigation point in the path.

PathList

public PathList(PathList original)

Cloning constructor.

PathList

public PathList()

Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).

Method Detail

getRouteId

public UnrealId getRouteId()

Unique Id of one navigation point in the path (well it should be navigation point - safer is to use location).

getLocation

public Location getLocation()

Location of one navigation point in the path.

getSimTime

public long getSimTime()

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()