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

YarnSmartVariableEvaluator

Evaluates smart variables declared in Yarn scripts at runtime.
class_name YarnSmartVariableEvaluator
extends RefCounted

Inherits from RefCounted

Smart variables are declared in Yarn scripts using expressions (e.g., <<declare $is_powerful = $strength > 50>>). They are compiled into bytecode nodes tagged "Yarn.SmartVariable" and re-evaluated each time they are accessed.

#Methods

#attach_to_storage(YarnVariableStorage)

func attach_to_storage(storage: YarnVariableStorage) -> void

Parameters

#get_smart_variable_names()

Returns names of all smart variables declared in the program.
func get_smart_variable_names() -> PackedStringArray

Returns PackedStringArray

#is_smart_variable(String)

Returns true if the variable is a smart variable declared in the program.
func is_smart_variable(variable_name: String) -> bool

Parameters

  • variable_nameString

Returns bool

#set_program_context(YarnProgram, YarnLibrary)

func set_program_context(program: YarnProgram, library: YarnLibrary) -> void

Parameters

#try_evaluate_from_program(String, YarnProgram, YarnLibrary)

Returns {found: bool, value: Variant}.
func try_evaluate_from_program(variable_name: String, program: YarnProgram, library: YarnLibrary) -> Dictionary

Parameters

Returns Dictionary

#try_get_smart_variable(String)

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

Parameters

  • variable_nameString

Returns Dictionary

Generated from Yarn Spinner for Godot GDScript 3.3.