Files
gymkhana-actions/docs/api/ESCDialogsPlayer.md
Dennis Ploeger 1f28fdc8f3 feat: Implemented all dialog features. Fixes #345 (#376)
Co-authored-by: Dennis Ploeger <develop@dieploegers.de>
Co-authored-by: dploeger <dploeger@users.noreply.github.com>
2021-08-27 08:15:52 +02:00

1.2 KiB

ESCDialogsPlayer

Extends: ResourcePreloader

Description

Escoria dialog player

Property Descriptions

is_speaking

var is_speaking

Wether the player is currently speaking

Method Descriptions

say

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

func finish_fast() -> void

Called when a dialog line is skipped

start_dialog_choices

func start_dialog_choices(dialog: ESCDialog)

Display a list of choices

Parameters

  • dialog: The dialog to start

play_dialog_option_chosen

func play_dialog_option_chosen(option: ESCDialogOption)

Called when an option was chosen and emits the option_chosen signal

Parameters

  • option: Option, that 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