Optimized Docs (#7)
Authored-by: Dennis Ploeger <develop@dieploegers.de>
This commit is contained in:
51
docs/api/ChangeSceneCommand.md
Normal file
51
docs/api/ChangeSceneCommand.md
Normal file
@@ -0,0 +1,51 @@
|
||||
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||
|
||||
# ChangeSceneCommand
|
||||
|
||||
**Extends:** [ESCBaseCommand](../ESCBaseCommand) < [Node](../Node)
|
||||
|
||||
## Description
|
||||
|
||||
`change_scene path run_events`
|
||||
|
||||
Loads a new scene, specified by "path". 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
|
||||
|
||||
## Property Descriptions
|
||||
|
||||
### readied\_scenes
|
||||
|
||||
```gdscript
|
||||
var readied_scenes: Array
|
||||
```
|
||||
|
||||
An array of scenes that have already been loaded
|
||||
|
||||
## Method Descriptions
|
||||
|
||||
### configure
|
||||
|
||||
```gdscript
|
||||
func configure() -> ESCCommandArgumentDescriptor
|
||||
```
|
||||
|
||||
Return the descriptor of the arguments of this command
|
||||
|
||||
### validate
|
||||
|
||||
```gdscript
|
||||
func validate(arguments: Array) -> bool
|
||||
```
|
||||
|
||||
Validate wether the given arguments match the command descriptor
|
||||
|
||||
### run
|
||||
|
||||
```gdscript
|
||||
func run(command_params: Array) -> var
|
||||
```
|
||||
|
||||
Run the command
|
||||
Reference in New Issue
Block a user