CameraSetPosBlockCommand
Extends: ESCCameraBaseCommand
Description
camera_set_pos_block(time: Number, x: Integer, y: Integer)
Moves the camera to the given absolute position over a time period. Blocks until the command completes.
Make sure the coordinates are reachable if camera limits have been configured.
Parameters
time: Number of seconds the transition should take
x: Target X coordinate
y: Target Y coordinate
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 |
|
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 |
|
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.