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

java.lang.Object
  cz.cuni.amis.pogamut.base.communication.messages.CommandMessage
      cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands.CheckReachability

public class CheckReachability
extends CommandMessage

Representation of the GameBots2004 command CHECKREACH. Check to see if you can move directly to a destination without hitting an obstruction, falling in a pit, etc. Responding with RCH message.

Field Summary

protected java.lang.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 java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected UnrealId	Target The unique Id of a player/object/nav point/whatever.

Constructor Summary

CheckReachability()
Creates new instance of command CheckReachability.

CheckReachability(CheckReachability original)
Cloning constructor.

CheckReachability(java.lang.String Id, UnrealId Target, Location Location)
Creates new instance of command CheckReachability.

Method Summary

java.lang.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() The unique Id of a player/object/nav point/whatever.
CheckReachability	setId(java.lang.String Id) Message Id made up by you and echoed in response so you can match up response with query.
CheckReachability	setLocation(Location Location) Location you want to go to.
CheckReachability	setTarget(UnrealId Target) The unique Id of a player/object/nav point/whatever.
java.lang.String	toHtmlString()
java.lang.String	toMessage()
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

Id

protected java.lang.String Id

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

Target

protected UnrealId Target

The unique Id of a player/object/nav point/whatever.

Location

protected Location Location

Location you want to go to. Normal location rules. Only used if no Target is sent.

Constructor Detail

CheckReachability

public CheckReachability(java.lang.String Id,
                         UnrealId Target,
                         Location Location)

Creates new instance of command CheckReachability. Check to see if you can move directly to a destination without hitting an obstruction, falling in a pit, etc. Responding with RCH message. Corresponding GameBots message for this command is CHECKREACH.

Parameters:

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

Target - The unique Id of a player/object/nav point/whatever.

Location - Location you want to go to. Normal location rules. Only used if no Target is sent.

CheckReachability

public CheckReachability()

Creates new instance of command CheckReachability. Check to see if you can move directly to a destination without hitting an obstruction, falling in a pit, etc. Responding with RCH message. Corresponding GameBots message for this command is CHECKREACH.

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

CheckReachability

public CheckReachability(CheckReachability original)

Cloning constructor.

Parameters:

original -

Method Detail

getId

public java.lang.String getId()

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

setId

public CheckReachability setId(java.lang.String Id)

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

getTarget

public UnrealId getTarget()

The unique Id of a player/object/nav point/whatever.

setTarget

public CheckReachability setTarget(UnrealId Target)

The unique Id of a player/object/nav point/whatever.

getLocation

public Location getLocation()

Location you want to go to. Normal location rules. Only used if no Target is sent.

setLocation

public CheckReachability setLocation(Location Location)

Location you want to go to. Normal location rules. Only used if no Target is sent.

toString

public java.lang.String toString()

Overrides:

toString in class CommandMessage

toHtmlString

public java.lang.String toHtmlString()

toMessage

public java.lang.String toMessage()