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

YarnCommandBinding

Binds a Yarn command or function to a method on a node.
class_name YarnCommandBinding
extends Resource

Inherits from Resource

#Nested Types

#Properties

#description

Documentation only - not used at runtime.
var description: String = ""

Type String

#enabled

var enabled: bool = true

Type bool

#example

Documentation only - not used at runtime.
var example: String = ""

Type String

#method_name

Commands can return void or Signal. Functions must return a value.
var method_name: String = ""

Type String

#parameter_count

Only for FUNCTION type. The VM needs this to pop the right number of stack values.
var parameter_count: int = 0

Type int

#target_node

Resolved relative to the YarnBindingLoader node.
var target_node: NodePath

Type NodePath

#type

var type: int = 0

Type int

#yarn_name

The name used in Yarn scripts (snake_case).
var yarn_name: String = ""

Type String

#Methods

#get_configuration_warnings()

func get_configuration_warnings() -> PackedStringArray

Returns PackedStringArray

#is_valid()

func is_valid() -> bool

Returns bool

Generated from Yarn Spinner for Godot GDScript 3.3.