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

Class SetCamera

java.lang.Object

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

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

public class SetCamera
extends CommandMessage

Representation of the GameBots2004 command FORCECAM. Sets input player to be a camera (he want be able to control himself). This player/camera can be controlled by MoveCamera command. Also sets camera location and rotation.

Field Summary

Fields

Modifier and Type	Field and Description
protected UnrealId	Id UnrealId of the player we want to set as a camera.
protected Location	Location Initial location of this camera.
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected Boolean	Release True to release this player from camera mode.
protected Rotation	Rotation Initial rotation of this camera.

Constructor Summary

Constructors

Constructor and Description
SetCamera() Creates new instance of command SetCamera.
SetCamera(SetCamera original) Cloning constructor.
SetCamera(UnrealId Id, Location Location, Rotation Rotation, Boolean Release) Creates new instance of command SetCamera.

Method Summary

Methods

Modifier and Type	Method and Description
UnrealId	getId() UnrealId of the player we want to set as a camera.
Location	getLocation() Initial location of this camera.
Rotation	getRotation() Initial rotation of this camera.
Boolean	isRelease() True to release this player from camera mode.
SetCamera	setId(UnrealId Id) UnrealId of the player we want to set as a camera.
SetCamera	setLocation(Location Location) Initial location of this camera.
SetCamera	setRelease(Boolean Release) True to release this player from camera mode.
SetCamera	setRotation(Rotation Rotation) Initial rotation of this camera.
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 UnrealId Id

UnrealId of the player we want to set as a camera.

Location

protected Location Location

Initial location of this camera.

Rotation

protected Rotation Rotation

Initial rotation of this camera.

Release

protected Boolean Release

True to release this player from camera mode.

Constructor Detail

SetCamera

public SetCamera(UnrealId Id,
         Location Location,
         Rotation Rotation,
         Boolean Release)

Creates new instance of command SetCamera. Sets input player to be a camera (he want be able to control himself). This player/camera can be controlled by MoveCamera command. Also sets camera location and rotation. Corresponding GameBots message for this command is FORCECAM.

Parameters:

Id - UnrealId of the player we want to set as a camera.

Location - Initial location of this camera.

Rotation - Initial rotation of this camera.

Release - True to release this player from camera mode.

SetCamera

public SetCamera()

Creates new instance of command SetCamera. Sets input player to be a camera (he want be able to control himself). This player/camera can be controlled by MoveCamera command. Also sets camera location and rotation. Corresponding GameBots message for this command is FORCECAM.

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

SetCamera

public SetCamera(SetCamera original)

Cloning constructor.

Parameters:

original -

Method Detail

getId

public UnrealId getId()

UnrealId of the player we want to set as a camera.

setId

public SetCamera setId(UnrealId Id)

UnrealId of the player we want to set as a camera.

getLocation

public Location getLocation()

Initial location of this camera.

setLocation

public SetCamera setLocation(Location Location)

Initial location of this camera.

getRotation

public Rotation getRotation()

Initial rotation of this camera.

setRotation

public SetCamera setRotation(Rotation Rotation)

Initial rotation of this camera.

isRelease

public Boolean isRelease()

True to release this player from camera mode.

setRelease

public SetCamera setRelease(Boolean Release)

True to release this player from camera mode.

toString

public String toString()

Overrides:

toString in class CommandMessage

toHtmlString

public String toHtmlString()

toMessage

public String toMessage()