Files
gymkhana-actions/docs/api/floating_dialog_player.gd.md
2021-10-25 07:00:14 +00:00

1.4 KiB

floating_dialog_player.gd

Extends: RichTextLabel

Description

A dialog UI using a label above the head of the character

Property Descriptions

text_speed_per_character

export var text_speed_per_character = 0.1

The text speed per character for normal display

fast_text_speed_per_character

export var fast_text_speed_per_character = 0.25

The text speed per character if the dialog line is skipped

max_time_to_text_disappear

export var max_time_to_text_disappear = 2

The time to wait before the dialog is finished

current_character

var current_character

Current character speaking, to keep track of reference for animation purposes

tween

var tween

Tween node for text animation

text_node

var text_node

The node showing the text

Method Descriptions

say

func say(character: String, line: String)

Make a character say something

Parameters

  • character: The global id of the character speaking
  • line: Line to say

finish_fast

func finish_fast()

Called by the dialog player when the

Signals

  • signal dialog_line_started(): Signal emitted when a dialog line has started
  • signal dialog_line_finished(): Signal emitted when a dialog line has finished