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

YarnVariableStorage

Base class for variable storage in Yarn Spinner.
class_name YarnVariableStorage
extends Node

Inherits from Node

#Nested Types

#Properties

#smart_variable_evaluator

var smart_variable_evaluator: YarnSmartVariableEvaluator

Type YarnSmartVariableEvaluator

#Signals

#variable_changed

signal variable_changed(variable_name: String, new_value: Variant)

Parameters

  • variable_nameString
  • new_valueVariant

#Methods

#add_change_listener(String, Callable)

func add_change_listener(variable_name: String, listener: Callable) -> Callable

Parameters

  • variable_nameString
  • listenerCallable

Returns Callable

#add_global_change_listener(Callable)

func add_global_change_listener(listener: Callable) -> Callable

Parameters

  • listenerCallable

Returns Callable

#clear()

func clear() -> void

#crc32(String)

static func crc32(text: String) -> int

Parameters

  • textString

Returns int

#get_all_variable_names()

func get_all_variable_names() -> PackedStringArray

Returns PackedStringArray

#get_all_variables_typed()

func get_all_variables_typed() -> Dictionary

Returns Dictionary

#get_all_variables()

func get_all_variables() -> Dictionary

Returns Dictionary

#get_bool(String, bool)

func get_bool(variable_name: String, default_value: bool = false) -> bool

Parameters

  • variable_nameString
  • default_valuebool

Returns bool

#get_enum_value_or_default(String, Dictionary, int)

func get_enum_value_or_default(variable_name: String, enum_values: Dictionary, default_value: int = 0) -> int

Parameters

  • variable_nameString
  • enum_valuesDictionary
  • default_valueint

Returns int

#get_float(String, float)

func get_float(variable_name: String, default_value: float = 0.0) -> float

Parameters

  • variable_nameString
  • default_valuefloat

Returns float

#get_program()

func get_program() -> YarnProgram

Returns YarnProgram

#get_string(String, String)

func get_string(variable_name: String, default_value: String = "") -> String

Parameters

  • variable_nameString
  • default_valueString

Returns String

#get_value_or_default(String, Variant)

func get_value_or_default(variable_name: String, default_value: Variant = null) -> Variant

Parameters

  • variable_nameString
  • default_valueVariant

Returns Variant

#get_value(String)

Checks stored, then smart variables, then program initial values. Smart variables are checked before initial values because they are expression-based and should always re-evaluate.
func get_value(variable_name: String) -> Variant

Parameters

  • variable_nameString

Returns Variant

#get_variable_kind(String)

func get_variable_kind(variable_name: String) -> int

Parameters

  • variable_nameString

Returns int

#has_value(String)

func has_value(variable_name: String) -> bool

Parameters

  • variable_nameString

Returns bool

#is_yarn_type_compatible(Variant, Variant)

Returns true if two values have compatible Yarn types. int and float are both "number" and are considered compatible.
static func is_yarn_type_compatible(a: Variant, b: Variant) -> bool

Parameters

  • aVariant
  • bVariant

Returns bool

#register_change_listener(String, Callable)

Listener callable receives (variable_name: String, new_value: Variant, old_value: Variant).
func register_change_listener(variable_name: String, listener: Callable) -> void

Parameters

  • variable_nameString
  • listenerCallable

#register_global_listener(Callable)

Listener callable receives (variable_name: String, new_value: Variant, old_value: Variant).
func register_global_listener(listener: Callable) -> void

Parameters

  • listenerCallable

#set_all_variables_typed(Dictionary, Dictionary, Dictionary, bool)

func set_all_variables_typed(floats: Dictionary, strings: Dictionary, bools: Dictionary, clear_first: bool = true) -> void

Parameters

  • floatsDictionary
  • stringsDictionary
  • boolsDictionary
  • clear_firstbool

#set_all_variables(Dictionary)

func set_all_variables(variables: Dictionary) -> void

Parameters

  • variablesDictionary

#set_program(YarnProgram)

func set_program(program: YarnProgram) -> void

Parameters

#set_value(String, Variant)

func set_value(variable_name: String, value: Variant) -> void

Parameters

  • variable_nameString
  • valueVariant

#subscribe_bool(Node, String, Callable)

func subscribe_bool(owner: Node, variable_name: String, listener: Callable) -> int

Parameters

  • ownerNode
  • variable_nameString
  • listenerCallable

Returns int

#subscribe_float(Node, String, Callable)

func subscribe_float(owner: Node, variable_name: String, listener: Callable) -> int

Parameters

  • ownerNode
  • variable_nameString
  • listenerCallable

Returns int

#subscribe_int(Node, String, Callable)

func subscribe_int(owner: Node, variable_name: String, listener: Callable) -> int

Parameters

  • ownerNode
  • variable_nameString
  • listenerCallable

Returns int

#subscribe_string(Node, String, Callable)

func subscribe_string(owner: Node, variable_name: String, listener: Callable) -> int

Parameters

  • ownerNode
  • variable_nameString
  • listenerCallable

Returns int

#subscribe_typed(Node, String, Callable, int)

Listener receives only the new value, coerced to expected_type.
func subscribe_typed(owner: Node, variable_name: String, listener: Callable, expected_type: int) -> int

Parameters

  • ownerNode
  • variable_nameString
  • listenerCallable
  • expected_typeint

Returns int

#subscribe(Node, String, Callable)

Returns a subscription id. Automatically unsubscribes when owner is freed.
func subscribe(owner: Node, variable_name: String, listener: Callable) -> int

Parameters

  • ownerNode
  • variable_nameString
  • listenerCallable

Returns int

#try_get_bool(String)

Returns {found: bool, value: bool}.
func try_get_bool(variable_name: String) -> Dictionary

Parameters

  • variable_nameString

Returns Dictionary

#try_get_float(String)

Returns {found: bool, value: float}.
func try_get_float(variable_name: String) -> Dictionary

Parameters

  • variable_nameString

Returns Dictionary

#try_get_string(String)

Returns {found: bool, value: String}.
func try_get_string(variable_name: String) -> Dictionary

Parameters

  • variable_nameString

Returns Dictionary

#try_get_value(String)

Returns {found: bool, value: Variant}.
func try_get_value(variable_name: String) -> Dictionary

Parameters

  • variable_nameString

Returns Dictionary

#unregister_change_listener(String, Callable)

func unregister_change_listener(variable_name: String, listener: Callable) -> void

Parameters

  • variable_nameString
  • listenerCallable

#unregister_global_listener(Callable)

func unregister_global_listener(listener: Callable) -> void

Parameters

  • listenerCallable

#unsubscribe(int)

func unsubscribe(subscription_id: int) -> void

Parameters

  • subscription_idint

#validate_value_type(String, Variant)

Validate that value is a Yarn type (string, number, or bool). Returns true if the value is acceptable, false if it should be rejected.
func validate_value_type(variable_name: String, value: Variant) -> bool

Parameters

  • variable_nameString
  • valueVariant

Returns bool

#yarn_type_name(Variant)

Returns the Yarn type name for a value: "string", "number", "bool", or "unknown".
static func yarn_type_name(value: Variant) -> String

Parameters

  • valueVariant

Returns String

Generated from Yarn Spinner for Godot GDScript 3.3.