This contains the source code documentation of the class subsystem_Choices.

subsystem_Choices

Subsystem that manages showing and activating of choices.

Properties

Name	Type	Default
last_question_info	Dictionary	`{}`
reveal_delay	float	`0.0`
reveal_by_input	bool	`false`
block_delay	float	`0.2`
autofocus_first_choice	bool	`true`
use_input_action	bool	`false`
default_false_behaviour	int	`0`
hotkey_behaviour	int	`0`

Methods

Returns	Method
void	clear_game_state ( `_clear_flag`: int = `0` )
void	post_install ( )
void	hide_all_choices ( )
Dictionary	get_current_question_info ( )
void	show_current_question ( `instant`: bool = `true` )
void	focus_choice ( `button_index`: int )
void	select_choice ( `button_index`: int )
void	select_focused_choice ( )
DialogicNode_ChoiceButton	get_choice_button ( `button_index`: int )
Array	get_current_choice_indexes ( )
bool	is_question ( `index`: int )

Constants

const HIDE = 0

No description available.

const DISABLE = 1

No description available.

const NONE = 0

No description available.

const NUMBERS = 1

No description available.

Signals

signal choice_selected ( info: Dictionary )

Emitted when a choice button was pressed. Info includes the keys 'button_index', 'text', 'event_index'.

signal question_shown ( info: Dictionary )

Emitted when a set of choices is reached and shown. Info includes the keys 'choices' (an array of dictionaries with infos on all the choices).

Property Descriptions

var last_question_info = {}

Contains information on the latest question.

var reveal_delay = 0.0

var reveal_by_input = false

var block_delay = 0.2

var autofocus_first_choice = true

var use_input_action = false

var default_false_behaviour = 0

var hotkey_behaviour = 0

Method Descriptions

func clear_game_state ( _clear_flag: int = 0 ) ⇒ void

No description available.

func post_install ( ) ⇒ void

No description available.

func hide_all_choices ( ) ⇒ void

Hides all choice buttons.

func get_current_question_info ( ) ⇒ Dictionary

Collects information on all the choices of the current question. The result is a dictionary like this: {'choices': [ {'event_index':10, 'button_index':1, 'disabled':false, 'text':"My Choice", 'visible':true}, {'event_index':15, 'button_index':2, 'disabled':false, 'text':"My Choice2", 'visible':true}, ]

func show_current_question ( instant: bool = true ) ⇒ void

Lists all current choices and shows buttons.

func focus_choice ( button_index: int ) ⇒ void

No description available.

func select_choice ( button_index: int ) ⇒ void

No description available.

func select_focused_choice ( ) ⇒ void

No description available.

func get_choice_button ( button_index: int ) ⇒ DialogicNode_ChoiceButton

No description available.

func get_current_choice_indexes ( ) ⇒ Array

Returns the indexes of the choice events related to the current question.