ESCDialog

Description

Represents a dialog in Escoria.

Members

avatar

var avatar: String

Avatar used in the dialog, if any.

timeout

var timeout: int

Timeout until the timeout_option option is selected. Use 0 for no timeout.

timeout_option

var timeout_option: int

The dialog option to select when timeout is reached.

authored_options_count

var authored_options_count: int

Total number of options authored in this dialog, including currently hidden options.

options

var options: Array

A list of ESCDialogOptions.

Methods

is_valid

func is_valid() -> bool

True iff the dialog and its settings are valid.

Parameters

None.

Returns

Returns true iff the dialog and its settings are valid. (bool)

get_timeout_option

func get_timeout_option() -> ESCDialogOption

Returns the currently visible option configured as the timeout default, if any.

Parameters

None.

Returns

Returns the currently visible timeout option as an ESCDialogOption, or null if the configured option is not visible.

run

func run() -> Variant

Run this dialog. TODO: Although this method overrides its parent version, the return type here does NOT match the parent’s signature. Consider either changing the parent’s return type to be a Variant, or doing something to ensure greater consistency.

Parameters

None.

Returns

Returns the ESCDialogOption chosen by the player. (Variant)