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

1.0 KiB

QueueResourceCommand

Extends: ESCBaseCommand < Node

Description

queue_resource path [front_of_queue]

Queues the load of a resource in a background thread. The path must be a full path inside your game, for example "res://scenes/next_scene.tscn". The "front_of_queue" parameter is optional (default value false), to put the resource in the front of the queue. Queued resources are cleared when a change scene happens (but after the scene is loaded, meaning you can queue resources that belong to the next scene).

@ESC

Method Descriptions

configure

func configure() -> ESCCommandArgumentDescriptor

Return the descriptor of the arguments of this command

validate

func validate(arguments: Array) -> bool

Validate wether the given arguments match the command descriptor

run

func run(command_params: Array) -> int

Run the command