Pardon our dust! Docs for Yarn Spinner for Unity 3.2 and Yarn Spinner for Godot C# are on docs.yarnspinner.dev (the old docs site). Docs for Yarn Spinner for Unity 3.3 (pre-release, out ASAP), Yarn Spinner for Godot GDScript and Yarn Spinner for Unreal Engine (work in progress) are on /docs/ (the new docs site).

YarnLineAdvancer

handles input for advancing dialogue lines. separates input handling from presentation.
class_name YarnLineAdvancer
extends Node

Inherits from Node

#Nested Types

#Properties

#advance_action

var advance_action: String = "ui_cancel"

Type String

#advance_key

var advance_key: int = 4194305

Type int

#block_input_one_frame

ignores hurry presses on the frame new content arrives
var block_input_one_frame: bool = true

Type bool

#cancel_dialogue_action

var cancel_dialogue_action: String = ""

Type String

#cancel_dialogue_key

var cancel_dialogue_key: int = 0

Type int

#combine_hurry_and_advance

pressing once hurries, twice advances
var combine_hurry_and_advance: bool = true

Type bool

#dialogue_runner

var dialogue_runner: YarnDialogueRunner

Type YarnDialogueRunner

#hurry_action

var hurry_action: String = "ui_accept"

Type String

#hurry_key

var hurry_key: int = 32

Type int

#input_mode

var input_mode: int = 1

Type int

#is_active

var is_active: bool = true

Type bool

#multi_press_to_skip

hurry presses on one line required to force-advance (0 = disabled)
var multi_press_to_skip: int = 0

Type int

#multi_press_window

var multi_press_window: float = 0.0

Type float

#option_hurry_action

var option_hurry_action: String = "ui_accept"

Type String

#option_hurry_key

var option_hurry_key: int = 32

Type int

#Signals

#advance_requested

signal advance_requested()

#dialogue_cancellation_requested

signal dialogue_cancellation_requested()

#hurry_up_requested

signal hurry_up_requested()

#option_hurry_up_requested

signal option_hurry_up_requested()

#Methods

#on_line_fully_revealed()

func on_line_fully_revealed() -> void

#on_line_presentation_ended()

func on_line_presentation_ended() -> void

#on_line_presentation_started()

func on_line_presentation_started() -> void

#request_advance()

func request_advance() -> void

#request_dialogue_cancellation()

func request_dialogue_cancellation() -> void

#request_hurry_up()

func request_hurry_up() -> void

#request_line_hurry_up()

func request_line_hurry_up() -> void

#request_next_line()

func request_next_line() -> void

#request_option_hurry_up()

func request_option_hurry_up() -> void

Generated from Yarn Spinner for Godot GDScript 3.3.