AnimCommand

Description

anim(object: String, name: String[, reverse: Boolean])

Executes the animation specified in “name” on “object” without blocking. The next command in the event will be executed immediately after the animation is started.

Parameters

Name	Type	Description	Required?
object	`String`	Global ID of the object with the animation	yes
name	`String`	Name of the animation to start on the object.	yes
reverse	`Boolean`	Plays the animation in reverse when true	no

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.