YarnLibrary
class_name YarnLibrary
extends RefCountedInherits from RefCounted
#Nested Types
#Constants
#COMPILER_DECLARATIONS
const COMPILER_DECLARATIONS = Array[Dictionary]([{"name": "visited", "parameters": [...], "returnType": "bool"}, {"name": "visited_count", "parameters": [...], "returnType": "number"}, {"name": "has_any_content", "parameters": [...], "returnType": "bool"}, {"name": "abs", "parameters": [...], "returnType": "number"}, {"name": "sign", "parameters": [...], "returnType": "number"}, {"name": "clamp", "parameters": [...], "returnType": "number"}, {"name": "lerp", "parameters": [...], "returnType": "number"}, {"name": "inverse_lerp", "parameters": [...], "returnType": "number"}, {"name": "smoothstep", "parameters": [...], "returnType": "number"}, {"name": "pow", "parameters": [...], "returnType": "number"}, {"name": "sqrt", "parameters": [...], "returnType": "number"}, {"name": "wrap", "parameters": [...], "returnType": "number"}, {"name": "mod", "parameters": [...], "returnType": "number"}, {"name": "plural", "parameters": [...], "returnType": "string", "variadicParameterType": "string"}, {"name": "ordinal", "parameters": [...], "returnType": "string", "variadicParameterType": "string"}, {"name": "length", "parameters": [...], "returnType": "number"}, {"name": "uppercase", "parameters": [...], "returnType": "string"}, {"name": "lowercase", "parameters": [...], "returnType": "string"}])#FUNCTION_ERROR
const FUNCTION_ERROR = &"__yarn_function_error__"#Methods
#call_function(String, Array, YarnVirtualMachine)
func call_function(func_name: String, stack: Array, vm: YarnVirtualMachine) -> VariantParameters
func_nameStringstackArray
Returns Variant
#cleanup_stale_targets()
func cleanup_stale_targets() -> void#dispatch_command(String, Node)
func dispatch_command(command_text: String, dialogue_runner: Node) -> DictionaryParameters
command_textStringdialogue_runnerNode
Returns Dictionary
#find_command_target(String)
func find_command_target(target_name: String) -> NodeParameters
target_nameString
Returns Node
#get_function_param_count(String)
func get_function_param_count(func_name: String) -> intParameters
func_nameString
Returns int
#has_command(String)
func has_command(command_name: String) -> boolParameters
command_nameString
Returns bool
#has_function(String)
func has_function(func_name: String) -> boolParameters
func_nameString
Returns bool
#has_instance_command(String)
func has_instance_command(command_name: String) -> boolParameters
command_nameString
Returns bool
#is_function_error(Variant)
static func is_function_error(value: Variant) -> boolParameters
valueVariant
Returns bool
#parse_bool(String)
static func parse_bool(text: String) -> DictionaryParameters
textString
Returns Dictionary
#parse_int32(String)
static func parse_int32(text: String) -> DictionaryParameters
textString
Returns Dictionary
#parse_single(String)
static func parse_single(text: String) -> DictionaryParameters
textString
Returns Dictionary
#register_command_target(String, Node)
func register_command_target(target_name: String, target: Node) -> voidParameters
target_nameStringtargetNode
#register_command(String, Callable, PackedStringArray)
func give(item: String, count: int, loud: bool) receives a real int and bool from <<give sword 3 true>>. Supported: String, int, float, bool, Vector2, Vector3, Color, and Node-derived classes (resolved by node name). A value that can't convert is a command error, not a silent default. Use a NAMED method for this — GDScript lambdas carry no parameter metadata, so lambda handlers receive raw strings.func register_command(command_name: String, callable: Callable, param_names: PackedStringArray = []) -> voidParameters
command_nameStringcallableCallableparam_namesPackedStringArray
#register_function(String, Callable, int)
func register_function(func_name: String, callable: Callable, param_count: int = -1) -> voidParameters
func_nameStringcallableCallableparam_countint
#register_instance_command(String, Script, String)
func register_instance_command(command_name: String, target_class: Script, method_name: String = "") -> voidParameters
command_nameStringtarget_classScriptmethod_nameString
#report_function_error(String)
func report_function_error(message: String) -> voidParameters
messageString
#set_program(YarnProgram)
#set_target_root(Node)
func set_target_root(root: Node) -> voidParameters
rootNode
#set_virtual_machine(YarnVirtualMachine)
#set_vm_context(YarnSaliencyStrategy, YarnVariableStorage)
func set_vm_context(strategy: YarnSaliencyStrategy, storage: YarnVariableStorage) -> voidParameters
strategyYarnSaliencyStrategystorageYarnVariableStorage
#take_function_error()
func take_function_error() -> StringReturns String
#unregister_command_target(String)
func unregister_command_target(target_name: String) -> voidParameters
target_nameString
#unregister_command(String)
func unregister_command(command_name: String) -> voidParameters
command_nameString
#unregister_function(String)
func unregister_function(func_name: String) -> voidParameters
func_nameString
#unregister_instance_command(String)
func unregister_instance_command(command_name: String) -> voidParameters
command_nameString
Generated from Yarn Spinner for Godot GDScript 3.3.