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).

YarnPauseEventProcessor

display-time handler for [pause] markup tags in typewriter presentation. integers are milliseconds ([pause=500/]), floats are seconds ([pause=0.5/]), no value defaults to 1000ms. self-closing tag marking a point in the text.
class_name YarnPauseEventProcessor
extends YarnActionMarkupHandler

Inherits from YarnActionMarkupHandler

#Constants

#DEFAULT_PAUSE_DURATION_MS

const DEFAULT_PAUSE_DURATION_MS = 1000.0

#Methods

#get_all_pauses()

func get_all_pauses() -> Dictionary

Returns Dictionary

#get_pause_duration_ms(int)

func get_pause_duration_ms(position: int) -> float

Parameters

  • positionint

Returns float

#get_pause_duration(int)

returns the pause duration at a position in seconds.
func get_pause_duration(position: int) -> float

Parameters

  • positionint

Returns float

#has_pause_at(int)

func has_pause_at(position: int) -> bool

Parameters

  • positionint

Returns bool

#on_character_will_appear(int, Variant, Variant)

returns a signal if there is a pause at this character position.
func on_character_will_appear(character_index: int, line: Variant, cancellation_token: Variant = null) -> Signal

Parameters

  • character_indexint
  • lineVariant
  • cancellation_tokenVariant

Returns Signal

#on_line_display_begin(Variant, Control)

func on_line_display_begin(line: Variant, text_control: Control = null) -> void

Parameters

  • lineVariant
  • text_controlControl

#on_line_display_complete()

func on_line_display_complete() -> void

#on_line_will_dismiss()

func on_line_will_dismiss() -> void

#on_prepare_for_line(Variant, Control)

func on_prepare_for_line(line: Variant, text_control: Control = null) -> void

Parameters

  • lineVariant
  • text_controlControl

Generated from Yarn Spinner for Godot GDScript 3.3.