gymkhana-actions/docs/api/avatar_dialog_player.gd.md

avatar_dialog_player.gd

Extends: Popup

Description

A dialog GUI showing a dialog box and character portraits

Property Descriptions

current_character

export var current_character = ""

• Setter: set_current_character

The currently speaking character

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 = 1

The time to wait before the dialog is finished

avatar_node

var avatar_node

The node holding the avatar

name_node

var name_node

The node holding the player name

text_node

var text_node

The node showing the text

tween

var tween

The tween node for text animations

Method Descriptions

set_current_character

func set_current_character(name: String)

Switch the current character

Parameters

• name: The name of the current character

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