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

Class Reachable

java.lang.Object

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

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

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

All Implemented Interfaces:

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

public class Reachable
extends GBEvent
implements IWorldEvent, IWorldChangeEvent

Asynchronous message. A boolean result of a checkreach call. Corresponding GameBots message is RCH.

Field Summary

Fields

Modifier and Type	Field and Description
protected Location	From Exact location of bot at time of check.
protected String	Id An Id matching the one sent by client.
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected boolean	Reachable True if the bot can run here directly, false otherwise.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Location	getFrom() Exact location of bot at time of check.
String	getId() An Id matching the one sent by client.
long	getSimTime()
boolean	isReachable() True if the bot can run here directly, false otherwise.
String	toHtmlString()
String	toString()

Methods inherited from class cz.cuni.amis.pogamut.udk.communication.messages.GBEvent

getWorldEvent

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

Id

protected String Id

An Id matching the one sent by client. Allows bot to match answer with right querry.

Reachable

protected boolean Reachable

True if the bot can run here directly, false otherwise.

From

protected Location From

Exact location of bot at time of check.

Constructor Detail

Reachable

public Reachable(String Id,
         boolean Reachable,
         Location From)

Creates new instance of command Reachable. Asynchronous message. A boolean result of a checkreach call. Corresponding GameBots message for this command is .

Parameters:

Id - An Id matching the one sent by client. Allows bot to match answer with right querry.

Reachable - True if the bot can run here directly, false otherwise.

From - Exact location of bot at time of check.

Reachable

public Reachable(Reachable original)

Cloning constructor.

Reachable

public Reachable()

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

Method Detail

getId

public String getId()

An Id matching the one sent by client. Allows bot to match answer with right querry.

isReachable

public boolean isReachable()

True if the bot can run here directly, false otherwise.

getFrom

public Location getFrom()

Exact location of bot at time of check.

getSimTime

public long getSimTime()

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

Overrides:

getSimTime in class GBEvent

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()