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

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

public class Trace
extends CommandMessage

Representation of the GameBots2004 command TRACE. Will send a ray from specified location to specified destination, responds with TRC message. TRACE uses Trace function - slower then FastTrace function, but provides more information about collision.

Field Summary

protected Location	From Origin point of the ray.
protected java.lang.String	Id Message Id made up by you and echoed in response so you can match up response with query.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected Location	To Target point of the ray.
protected java.lang.Boolean	TraceActors When true it means that all actors will be traced – for example players, bots, monsters, items etc.

Constructor Summary

Trace()
Creates new instance of command Trace.

Trace(java.lang.String Id, Location From, Location To, java.lang.Boolean TraceActors)
Creates new instance of command Trace.

Trace(Trace original)
Cloning constructor.

Method Summary

Location	getFrom() Origin point of the ray.
java.lang.String	getId() Message Id made up by you and echoed in response so you can match up response with query.
Location	getTo() Target point of the ray.
java.lang.Boolean	isTraceActors() When true it means that all actors will be traced – for example players, bots, monsters, items etc.
Trace	setFrom(Location From) Origin point of the ray.
Trace	setId(java.lang.String Id) Message Id made up by you and echoed in response so you can match up response with query.
Trace	setTo(Location To) Target point of the ray.
Trace	setTraceActors(java.lang.Boolean TraceActors) When true it means that all actors will be traced – for example players, bots, monsters, items etc.
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.

From

protected Location From

Origin point of the ray. If you won't support From attribute, current bot location will be taken as From.

To

protected Location To

Target point of the ray.

TraceActors

protected java.lang.Boolean TraceActors

When true it means that all actors will be traced – for example players, bots, monsters, items etc. in a game. With TraceActors false we trace just level geometry.

Constructor Detail

Trace

public Trace(java.lang.String Id,
             Location From,
             Location To,
             java.lang.Boolean TraceActors)

Creates new instance of command Trace. Will send a ray from specified location to specified destination, responds with TRC message. TRACE uses Trace function - slower then FastTrace function, but provides more information about collision. Corresponding GameBots message for this command is TRACE.

Parameters:

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

From - Origin point of the ray. If you won't support From attribute, current bot location will be taken as From.

To - Target point of the ray.

TraceActors - When true it means that all actors will be traced – for example players, bots, monsters, items etc. in a game. With TraceActors false we trace just level geometry.

Trace

public Trace()

Creates new instance of command Trace. Will send a ray from specified location to specified destination, responds with TRC message. TRACE uses Trace function - slower then FastTrace function, but provides more information about collision. Corresponding GameBots message for this command is TRACE.

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

Trace

public Trace(Trace 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 Trace setId(java.lang.String Id)

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

getFrom

public Location getFrom()

Origin point of the ray. If you won't support From attribute, current bot location will be taken as From.

setFrom

public Trace setFrom(Location From)

Origin point of the ray. If you won't support From attribute, current bot location will be taken as From.

getTo

public Location getTo()

Target point of the ray.

setTo

public Trace setTo(Location To)

Target point of the ray.

isTraceActors

public java.lang.Boolean isTraceActors()

When true it means that all actors will be traced – for example players, bots, monsters, items etc. in a game. With TraceActors false we trace just level geometry.

setTraceActors

public Trace setTraceActors(java.lang.Boolean TraceActors)

When true it means that all actors will be traced – for example players, bots, monsters, items etc. in a game. With TraceActors false we trace just level geometry.

toString

public java.lang.String toString()

Overrides:

toString in class CommandMessage

toHtmlString

public java.lang.String toHtmlString()

toMessage

public java.lang.String toMessage()