Files
gymkhana-actions/docs/api/ESCDialogsPlayer.md
Dennis Ploeger 58d880101d Optimized Docs (#7)
Authored-by: Dennis Ploeger <develop@dieploegers.de>
2021-06-22 23:06:20 +02:00

1.4 KiB

ESCDialogsPlayer

Extends: ResourcePreloader

Description

Escoria dialog player

Property Descriptions

is_speaking

var is_speaking

Wether the player is currently speaking

Method Descriptions

preload_resources

func preload_resources(path: String) -> void

Preload the dialog UI resources

Parameters

  • path: Path where the actual dialog UI resources are located

say

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

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

play_dialog_option_chosen

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