Optimized Docs (#7)

Authored-by: Dennis Ploeger <develop@dieploegers.de>
This commit is contained in:
Dennis Ploeger
2021-06-22 23:06:20 +02:00
committed by GitHub
parent d5a0022b7b
commit 58d880101d
111 changed files with 6362 additions and 801 deletions

View File

@@ -0,0 +1,80 @@
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
# ESCDialogsPlayer
**Extends:** [ResourcePreloader](../ResourcePreloader)
## Description
Escoria dialog player
## Property Descriptions
### is\_speaking
```gdscript
var is_speaking
```
Wether the player is currently speaking
## Method Descriptions
### preload\_resources
```gdscript
func preload_resources(path: String) -> void
```
Preload the dialog UI resources
#### Parameters
- path: Path where the actual dialog UI resources are located
### say
```gdscript
func say(character: String, params: Dictionary) -> var
```
A short one line dialog
#### Parameters
- character: Character that is talking
- params: A dictionary of parameters. Currently only "line" is supported and
holds the line the character should say
### finish\_fast
```gdscript
func finish_fast() -> void
```
Called when a dialog line is skipped
### start\_dialog\_choices
```gdscript
func start_dialog_choices(dialog: ESCDialog)
```
Display a list of choices
### play\_dialog\_option\_chosen
```gdscript
func play_dialog_option_chosen(option: ESCDialogOption)
```
Called when an option was chosen
## Signals
- signal option_chosen(option): Emitted when an answer as chosem
##### Parameters
- option: The dialog option that was chosen
- signal dialog_line_finished(): Emitted when a dialog line was finished