SetActiveCommand

Extends: ESCBaseCommand

Description

set_active(object: String, active: Boolean)

Changes the “active” state of the object. Inactive objects are invisible in the room.

Parameters

Name

Type

Description

Required?

object

String

Global ID of the object whose active state should change.

yes

active

Boolean

Whether the object should be marked as active (true) or inactive (false). object* Global ID of the object active* Whether object should be active. active can be true or false.

yes

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.