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

YarnBindingLoader

Registers Yarn command and function bindings with a dialogue runner. Configure bindings in the inspector to connect Yarn commands to methods on scene nodes.
class_name YarnBindingLoader
extends Node

Inherits from Node

#Properties

#auto_find_runner

var auto_find_runner: bool = true

Type bool

#auto_register

var auto_register: bool = true

Type bool

#bindings

var bindings: Array[YarnCommandBinding] = []

Type Array[YarnCommandBinding]

#dialogue_runner

auto-discovers sibling/parent if not set
var dialogue_runner: YarnDialogueRunner

Type YarnDialogueRunner

#unregister_on_exit

var unregister_on_exit: bool = true

Type bool

#verbose

var verbose: bool = false

Type bool

#Signals

#binding_failed

signal binding_failed(binding: YarnCommandBinding, reason: String)

Parameters

#bindings_registered

signal bindings_registered()

#Methods

#add_binding(String, int, Node, String, int)

param_count is only used for functions; commands determine it at runtime.
func add_binding(yarn_name: String, type: int, target: Node, method: String, param_count: int = 0) -> bool

Parameters

  • yarn_nameString
  • typeint
  • targetNode
  • methodString
  • param_countint

Returns bool

#get_debug_info()

func get_debug_info() -> String

Returns String

#get_registered_count()

func get_registered_count() -> int

Returns int

#has_binding(String)

func has_binding(yarn_name: String) -> bool

Parameters

  • yarn_nameString

Returns bool

#register_all()

Safe to call multiple times - already registered bindings are skipped.
func register_all() -> void

#register_binding(YarnCommandBinding)

func register_binding(binding: YarnCommandBinding) -> bool

Parameters

Returns bool

#remove_binding(String)

func remove_binding(yarn_name: String) -> void

Parameters

  • yarn_nameString

#unregister_all()

func unregister_all() -> void

Generated from Yarn Spinner for Godot GDScript 3.3.