PopochiuDialog

Extends: Resource

Description

Property Descriptions

script_name

@export var script_name: String = ""

The identifier of the object used in scripts.

options

@export var options: Array[PopochiuDialogOption]
  • Setter: @options_setter

The array of PopochiuDialogOption to show on screen when the dialog is running.

Method Descriptions

queue_start

func queue_start() -> Callable

Starts this dialog, then [method _on_start] is called.[br][br] [i]This method is intended to be used inside a [method Popochiu.queue] of instructions.[/i]

start

func start() -> void

Starts this dialog, then [method _on_start] is called.

queue_stop

func queue_stop() -> Callable

Stops the dialog (which makes the menu with the options to disappear).[br][br] [i]This method is intended to be used inside a [method Popochiu.queue] of instructions.[/i]

stop

func stop() -> void

Stops the dialog (which makes the menu with the options to disappear).

turn_on_options

func turn_on_options(ids: Array) -> void

Enables each PopochiuDialogOption matches each of the values in the [param ids] array.

turn_off_options

func turn_off_options(ids: Array) -> void

Disables each PopochiuDialogOption matches each of the values in the [param ids] array.

turn_off_forever_options

func turn_off_forever_options(ids: Array) -> void

Disables [b]forever[/b] each [PopochiuDialogOption] which [member PopochiuDialogOption.id] matches each of the values in the [param ids] array.

on_save

func on_save() -> Dictionary

Use this to save custom data when saving the game. The returned [Dictionary] must contain only JSON supported types: [bool], [int], [float], [String].

on_load

func on_load(data: Dictionary) -> void

Called when the game is loaded. [param data] will have the same structure you defined for the returned [Dictionary] by [method _on_save].

get_option

func get_option(opt_id: String) -> PopochiuDialogOption

Returns the dilog option which [member PopochiuDialogOption.id] matches [param opt_id].

set_options

func set_options(value: Array[PopochiuDialogOption]) -> void