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

YarnActionMarkupHandler.ShakeActionHandler

shakes the text container during [shake] markup.
class ShakeActionHandler extends YarnActionMarkupHandler

Inherits from YarnActionMarkupHandler

#Properties

#frequency

shakes per second
var frequency: float = 30.0

Type float

#intensity

shake intensity in pixels
var intensity: float = 3.0

Type float

#target

the control to shake
var target: Control

Type Control

#Methods

#on_character_will_appear(int, Variant, Variant)

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