CameraSetTargetBlockCommand

Description

camera_set_target_block(time: Number, object: String)

Configures the camera to follow the specified target object (ESCItem) as it moves around the current room. The transition to focus on the object will happen over a time period. Blocks until the command completes.

The camera will move as close as it can if camera limits have been configured and the object is at coordinates that are not reachable.

Parameters

time: Number of seconds the transition should take to move the camera to follow object
object: Global ID of the target object

For more details see: https://docs.escoria-framework.org/camera

Members

Methods

configure

func configure() -> ESCCommandArgumentDescriptor

The descriptor of the arguments of this command.

Parameters

None.

Returns

Returns the descriptor of the arguments of this command. The argument descriptor for this command. (ESCCommandArgumentDescriptor)

validate

func validate(arguments: Array) -> Variant

Validates whether the given arguments match the command descriptor.

Parameters

Name	Type	Description	Required?
arguments	`Array`	The arguments to validate.	yes

Returns

Returns True if the arguments are valid, false otherwise. (bool)

run

func run(command_params: Array) -> int

Runs the command.

Parameters

Name	Type	Description	Required?
command_params	`Array`	The parameters for the command.	yes

Returns

Returns the execution result code. (int)

interrupt

func interrupt() -> void

Function called when the command is interrupted.

Parameters

None.

Returns

Returns nothing.