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:
99
docs/api/ESCSaveSettings.md
Normal file
99
docs/api/ESCSaveSettings.md
Normal file
@@ -0,0 +1,99 @@
|
||||
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||
|
||||
# ESCSaveSettings
|
||||
|
||||
**Extends:** [Resource](../Resource)
|
||||
|
||||
## Description
|
||||
|
||||
Resource holding game settings.
|
||||
|
||||
## Property Descriptions
|
||||
|
||||
### escoria\_version
|
||||
|
||||
```gdscript
|
||||
export var escoria_version: String = ""
|
||||
```
|
||||
|
||||
Version of ESCORIA Framework
|
||||
|
||||
### text\_lang
|
||||
|
||||
```gdscript
|
||||
export var text_lang: String = ""
|
||||
```
|
||||
|
||||
Language of displayed text
|
||||
|
||||
### voice\_lang
|
||||
|
||||
```gdscript
|
||||
export var voice_lang: String = ""
|
||||
```
|
||||
|
||||
Language of voice speech
|
||||
|
||||
### speech\_enabled
|
||||
|
||||
```gdscript
|
||||
export var speech_enabled: bool = false
|
||||
```
|
||||
|
||||
Whether speech is enabled
|
||||
|
||||
### master\_volume
|
||||
|
||||
```gdscript
|
||||
export var master_volume: float = 0
|
||||
```
|
||||
|
||||
Master volume (mix of music, voice and sfx)
|
||||
|
||||
### music\_volume
|
||||
|
||||
```gdscript
|
||||
export var music_volume: float = 0
|
||||
```
|
||||
|
||||
Volume of music only
|
||||
|
||||
### sfx\_volume
|
||||
|
||||
```gdscript
|
||||
export var sfx_volume: float = 0
|
||||
```
|
||||
|
||||
Volume of SFX only
|
||||
|
||||
### voice\_volume
|
||||
|
||||
```gdscript
|
||||
export var voice_volume: float = 0
|
||||
```
|
||||
|
||||
Voice volume only
|
||||
|
||||
### fullscreen
|
||||
|
||||
```gdscript
|
||||
export var fullscreen: bool = false
|
||||
```
|
||||
|
||||
True if game has to be fullscreen
|
||||
|
||||
### skip\_dialog
|
||||
|
||||
```gdscript
|
||||
export var skip_dialog: bool = true
|
||||
```
|
||||
|
||||
True if skipping dialogs is allowed
|
||||
|
||||
### rate\_shown
|
||||
|
||||
```gdscript
|
||||
export var rate_shown: bool = false
|
||||
```
|
||||
|
||||
FIXME: to be defined (achievements?)
|
||||
Reference in New Issue
Block a user