YarnSpinner
yarn spinner singleton providing global access and utilities. autoloaded as "YarnSpinner" when the plugin is enabled.
class_name YarnSpinner
extends NodeInherits from Node
#Constants
#VERSION
const VERSION = "3.3"#Methods
#create_dialogue_runner(YarnProjectResource)
func create_dialogue_runner(project: YarnProjectResource = null) -> YarnDialogueRunnerParameters
projectYarnProjectResource
Returns YarnDialogueRunner
#get_global_commands()
func get_global_commands() -> DictionaryReturns Dictionary
#get_global_functions()
func get_global_functions() -> DictionaryReturns Dictionary
#get_saliency_strategy(String)
func get_saliency_strategy(name: String) -> YarnSaliencyStrategyParameters
nameString
Returns YarnSaliencyStrategy
#parse_command(String)
Utility: parse a yarn command string into name and arguments.
Returns:
Supports quoted arguments with spaces:
Returns:
{"name": "command_name", "args": ["arg1", "arg2"]}Supports quoted arguments with spaces:
<<give "magic sword">>func parse_command(command_text: String) -> DictionaryParameters
command_textString
Returns Dictionary
#register_command(String, Callable)
func register_command(command_name: String, callable: Callable) -> voidParameters
command_nameStringcallableCallable
#register_function(String, Callable, int)
func register_function(func_name: String, callable: Callable, param_count: int = -1) -> voidParameters
func_nameStringcallableCallableparam_countint
#register_saliency_strategy(String, YarnSaliencyStrategy)
func register_saliency_strategy(name: String, strategy: YarnSaliencyStrategy) -> voidParameters
nameStringstrategyYarnSaliencyStrategy
#unregister_command(String)
func unregister_command(command_name: String) -> voidParameters
command_nameString
#unregister_function(String)
func unregister_function(func_name: String) -> voidParameters
func_nameString
Generated from Yarn Spinner for Godot GDScript 3.3.