Files
gymkhana-actions/docs/api/SetStateCommand.md
Dennis Ploeger 58d880101d Optimized Docs (#7)
Authored-by: Dennis Ploeger <develop@dieploegers.de>
2021-06-22 23:06:20 +02:00

834 B

SetStateCommand

Extends: ESCBaseCommand < Node

Description

set_state object state [immediate]

Changes the state of an object, and executes the state animation if present. The command can be used to change the appearance of an item or a player character. If immediate is set to true, the animation is run directly

@ESC

Method Descriptions

configure

func configure() -> ESCCommandArgumentDescriptor

Return the descriptor of the arguments of this command

validate

func validate(arguments: Array)

Validate wether the given arguments match the command descriptor

run

func run(command_params: Array) -> int

Run the command