This contains the source code documentation of the class subsystem_Input.

subsystem_Input

Inherits: DialogicSubsystem

Subsystem that handles input, Auto-Advance, and skipping.

Description

This subsystem can be accessed via GDScript: Dialogic.Inputs.

Properties

Name	Type	Default
input_block_timer	Timer	`new()`
action_was_consumed	bool	`false`
input_was_mouse_input	bool	`false`
auto_skip	DialogicAutoSkip	`null`
auto_advance	DialogicAutoAdvance	`null`
manual_advance	DialogicManualAdvance	`null`

Methods

Returns	Method
void	clear_game_state ( `_clear_flag`: int = `0` )
void	pause ( )
void	resume ( )
void	post_install ( )
void	handle_input ( )
bool	is_input_pressed ( `event`: InputEvent, `exact`: bool = `false` )
void	handle_node_gui_input ( `event`: InputEvent )
bool	is_input_blocked ( )
void	block_input ( `time`: float = `0.1` )
void	stop_timers ( )
void	start_autoskip_timer ( )
void	effect_input ( `_text_node`: Control, `skipped`: bool, `_argument`: String )
void	effect_noskip ( `text_node`: Control, `skipped`: bool, `argument`: String )
void	effect_autoadvance ( `_text_node`: Control, `_skipped`: bool, `argument`: String )

Signals

signal dialogic_action_priority ( )

No description available.

signal dialogic_action ( )

No description available.

signal autoskip_timer_finished ( )

Whenever the Auto-Skip timer finishes, this signal is emitted. Configure Auto-Skip settings via auto_skip.

Property Descriptions

var input_block_timer = new()

var action_was_consumed = false

var input_was_mouse_input = false

var auto_skip = null

var auto_advance = null

var manual_advance = null

Method Descriptions

func clear_game_state ( _clear_flag: int = 0 ) ⇒ void

No description available.

func pause ( ) ⇒ void

No description available.

func resume ( ) ⇒ void

No description available.

func post_install ( ) ⇒ void

No description available.

func handle_input ( ) ⇒ void

No description available.

func is_input_pressed ( event: InputEvent, exact: bool = false ) ⇒ bool

No description available.

func handle_node_gui_input ( event: InputEvent ) ⇒ void

This is called from the gui_input of the InputCatcher and DialogText nodes

func is_input_blocked ( ) ⇒ bool

No description available.

func block_input ( time: float = 0.1 ) ⇒ void

No description available.

func stop_timers ( ) ⇒ void

No description available.

func start_autoskip_timer ( ) ⇒ void

This method will advance the timeline based on Auto-Skip settings. The state, whether Auto-Skip is enabled, is ignored.

func effect_input ( _text_node: Control, skipped: bool, _argument: String ) ⇒ void

No description available.

func effect_noskip ( text_node: Control, skipped: bool, argument: String ) ⇒ void

No description available.

func effect_autoadvance ( _text_node: Control, _skipped: bool, argument: String ) ⇒ void

No description available.