Fix command docs, automate API doc generation (#327)

Co-authored-by: Dennis Ploeger <develop@dieploegers.de>
Co-authored-by: dploeger <dploeger@users.noreply.github.com>
This commit is contained in:
Dennis Ploeger
2021-07-27 16:05:14 +02:00
committed by GitHub
parent 43dc217359
commit 604cccb56d
25 changed files with 575 additions and 161 deletions

View File

@@ -13,7 +13,7 @@ A manager for ESC objects
### RESERVED\_OBJECTS
```gdscript
const RESERVED_OBJECTS: Array = ["bg_music"]
const RESERVED_OBJECTS: Array = ["bg_music","bg_sound"]
```
## Property Descriptions
@@ -38,7 +38,7 @@ Register the object in the manager
#### Parameters
- object: Obejct to register
- object: Object to register
- force: Register the object, even if it has already been registered
### has
@@ -62,6 +62,11 @@ func get_object(global_id: String) -> ESCObject
Get the object from the object registry
#### Parameters
- global_id: The global id of the object to retrieve
**Returns** The retrieved object, or null if not found
### unregister\_object
```gdscript
@@ -72,4 +77,16 @@ Remove an object from the registry
#### Parameters
- object: The object to unregister
- object: The object to unregister
### save\_game
```gdscript
func save_game(p_savegame: ESCSaveGame) -> void
```
Insert data to save into savegame.
#### Parameters
- p_savegame: The savegame resource