Files
gymkhana-actions/docs/api/ESCDialogsPlayer.md
Dennis Ploeger 90f880d090 Issue 315 (#341)
* feat: accept_input implemented

* feat: More fixes for accept_input and tests for it

* feat: play_snd implemented

* fix: Removed game_over and queue_animation commands

* docs: Automatic update of API docs

* fix: FIxes schedule_event command

* feat: Implemented slide and slide_block

* feat: Implemented turn_to

* docs: Automatic update of API docs

Co-authored-by: Dennis Ploeger <develop@dieploegers.de>
Co-authored-by: dploeger <dploeger@users.noreply.github.com>
2021-07-29 23:05:24 +02:00

81 lines
1.3 KiB
Markdown

<!-- 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, ui: String, line: String) -> var
```
A short one line dialog
#### Parameters
- character: Character that is talking
- ui: UI to use for the dialog
- line: Line to 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