cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands

Class GetPath

java.lang.Object

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

cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands.GetPath

public class GetPath
extends CommandMessage

Representation of the GameBots2004 command GETPATH. Get a path to a specified location or a navigation point. An ordered list of path nodes will be returned to you by IPTH messages.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	Id Message Id made up by you and echoed in response so you can match up response with query.
protected Location	Location Location you want to go to.
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected UnrealId	Target UnrealId of navigation point you want to find path to.

Constructor Summary

Constructors

Constructor and Description
GetPath() Creates new instance of command GetPath.
GetPath(GetPath original) Cloning constructor.
GetPath(String Id, UnrealId Target, Location Location) Creates new instance of command GetPath.

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Message Id made up by you and echoed in response so you can match up response with query.
Location	getLocation() Location you want to go to.
UnrealId	getTarget() UnrealId of navigation point you want to find path to.
GetPath	setId(String Id) Message Id made up by you and echoed in response so you can match up response with query.
GetPath	setLocation(Location Location) Location you want to go to.
GetPath	setTarget(UnrealId Target) UnrealId of navigation point you want to find path to.
String	toHtmlString()
String	toMessage()
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 String PROTOTYPE

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

See Also:

Constant Field Values

Id

protected String Id

Message Id made up by you and echoed in response so you can match up response with query.

Target

protected UnrealId Target

UnrealId of navigation point you want to find path to. Will be parsed BEFORE Location attribute. If supported, Location attribute won't be parsed. If the point does not exists, blank path will be returned.

Location

protected Location Location

Location you want to go to.

Constructor Detail

GetPath

public GetPath(String Id,
       UnrealId Target,
       Location Location)

Creates new instance of command GetPath. Get a path to a specified location or a navigation point. An ordered list of path nodes will be returned to you by IPTH messages. Corresponding GameBots message for this command is GETPATH.

Parameters:

Id - Message Id made up by you and echoed in response so you can match up response with query.

Target - UnrealId of navigation point you want to find path to. Will be parsed BEFORE Location attribute. If supported, Location attribute won't be parsed. If the point does not exists, blank path will be returned.

Location - Location you want to go to.

GetPath

public GetPath()

Creates new instance of command GetPath. Get a path to a specified location or a navigation point. An ordered list of path nodes will be returned to you by IPTH messages. Corresponding GameBots message for this command is GETPATH.

WARNING: this is empty-command constructor, you have to use setters to fill it up with data that should be sent to GameBots2004!

GetPath

public GetPath(GetPath original)

Cloning constructor.

Parameters:

original -

Method Detail

getId

public String getId()

Message Id made up by you and echoed in response so you can match up response with query.

setId

public GetPath setId(String Id)

Message Id made up by you and echoed in response so you can match up response with query.

getTarget

public UnrealId getTarget()

UnrealId of navigation point you want to find path to. Will be parsed BEFORE Location attribute. If supported, Location attribute won't be parsed. If the point does not exists, blank path will be returned.

setTarget

public GetPath setTarget(UnrealId Target)

UnrealId of navigation point you want to find path to. Will be parsed BEFORE Location attribute. If supported, Location attribute won't be parsed. If the point does not exists, blank path will be returned.

getLocation

public Location getLocation()

Location you want to go to.

setLocation

public GetPath setLocation(Location Location)

Location you want to go to.

toString

public String toString()

Overrides:

toString in class CommandMessage

toHtmlString

public String toHtmlString()

toMessage

public String toMessage()