Files
gymkhana-actions/docs/api/ChangeSceneCommand.md
Julian Murgia b4bf5b82d6 Event flags implementation (#382)
* Added event flags
* Added transition ESC command
* Also edited .gitignore to ignore .translation files
* docs: Automatic update of API docs

Co-authored-by: StraToN <StraToN@users.noreply.github.com>
2021-09-07 09:13:09 +02:00

1.1 KiB

ChangeSceneCommand

Extends: ESCBaseCommand < Node

Description

change_scene path [disable_automatic_transition] [run_events]

Loads a new scene, specified by "path".  The disable_automatic_transition is a boolean (default false) can be set to true to disable automatic transitions between scenes, to allow you to control your transitions manually using the transition command. The run_events variable is a boolean (default true) which you never want to set manually! It's there only to benefit save games, so they don't conflict with the scene's events.

@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) -> var

Run the command