Issue 377 (#383)

* feat: Implements speech fixes #377

* docs: Automatic update of API docs

* chore: Updated speech translation.

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-09-06 08:52:16 +02:00
committed by GitHub
parent 3dc779311c
commit c8958e7454
54 changed files with 279 additions and 85 deletions

View File

@@ -1,6 +1,6 @@
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
# ESCBackgroundMusic
# ESCMusicPlayer
**Extends:** [Control](../Control)
@@ -13,7 +13,7 @@ Background music player
### global\_id
```gdscript
export var global_id: String = "bg_music"
export var global_id: String = "_music"
```
Global id of the background music player

View File

@@ -13,7 +13,7 @@ A manager for ESC objects
### RESERVED\_OBJECTS
```gdscript
const RESERVED_OBJECTS: Array = ["bg_music","bg_sound"]
const RESERVED_OBJECTS: Array = ["_music","_sound","_speech"]
```
## Property Descriptions

View File

@@ -66,13 +66,13 @@ export var sfx_volume: float = 0
 Volume of SFX only
### voice\_volume
### speech\_volume
```gdscript
export var voice_volume: float = 0
export var speech_volume: float = 0
```
Voice volume only
Speech volume only
### fullscreen

View File

@@ -1,6 +1,6 @@
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
# ESCBackgroundSound
# ESCSoundPlayer
**Extends:** [Control](../Control)
@@ -13,7 +13,7 @@ Background sound player
### global\_id
```gdscript
export var global_id: String = "bg_sound"
export var global_id: String = "_sound"
```
Global id of the background sound player

View File

@@ -0,0 +1,34 @@
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
# ESCSpeechPlayer
**Extends:** [Control](../Control)
## Description
Speech player
## Property Descriptions
### global\_id
```gdscript
export var global_id: String = "_speech"
```
Global id of the background music player
## Method Descriptions
### set\_state
```gdscript
func set_state(p_state: String, p_force: bool = false) -> void
```
Set the state of this player
#### Parameters
- p_state: New state to use
- p_force: Override the existing state even if the stream is still playing

View File

@@ -9,7 +9,7 @@
`play_snd file [player]`
Plays the sound specificed with the "file" parameter on the sound player
`player`, without blocking. (player defaults to bg_sound)
`player`, without blocking. (player defaults to _sound)
@ESC

View File

@@ -10,7 +10,7 @@
Change the sound playing on `player` to `sound` with optional looping if
`loop` is true.
Valid players are "bg_music" and "bg_sound".
Valid players are "_music" and "_sound".
Aside from paths to sound or music files, the values *off* and *default*.
*default* is the default value.
are also valid for `sound`

View File

@@ -34,14 +34,6 @@ var wait_level
The Escoria context currently in wait state
### bg\_music
```gdscript
var bg_music
```
Reference to the ESCBackgroundMusic node
### scene\_transition
```gdscript