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

YarnVirtualMachine

Stack-based VM that executes compiled Yarn bytecode.
class_name YarnVirtualMachine
extends RefCounted

Inherits from RefCounted

#Nested Types

#Constants

#NO_OPTION_SELECTED

const NO_OPTION_SELECTED = -1

#NODE_GROUP_HEADER

const NODE_GROUP_HEADER = "$Yarn.Internal.NodeGroup"

#NODE_GROUP_HUB_HEADER

const NODE_GROUP_HUB_HEADER = "$Yarn.Internal.NodeGroupHub"

#SALIENCY_COMPLEXITY_HEADER

const SALIENCY_COMPLEXITY_HEADER = "$Yarn.Internal.ContentSaliencyComplexity"

#SALIENCY_VARIABLES_HEADER

const SALIENCY_VARIABLES_HEADER = "$Yarn.Internal.ContentSaliencyVariables"

#TRACKING_VARIABLE_HEADER

const TRACKING_VARIABLE_HEADER = "$Yarn.Internal.TrackingVariable"

#VISITING_VARIABLE_PREFIX

const VISITING_VARIABLE_PREFIX = "$Yarn.Internal.Visiting."

#Properties

#current_state

var current_state: int = 0

Type int

#last_error

var last_error: String = ""

Type String

#max_call_stack_depth

var max_call_stack_depth: int = 0

Type int

#max_instructions_per_step

var max_instructions_per_step: int = 0

Type int

#program

var program: YarnProgram

Type YarnProgram

#saliency_strategy

var saliency_strategy: YarnSaliencyStrategy

Type YarnSaliencyStrategy

#variable_storage

var variable_storage: YarnVariableStorage

Type YarnVariableStorage

#verbose_logging

var verbose_logging: bool = false

Type bool

#Signals

#command_handler

signal command_handler(command_text: String)

Parameters

  • command_textString

#dialogue_complete_handler

signal dialogue_complete_handler()

#line_handler

signal line_handler(line: YarnLine)

Parameters

#node_complete_handler

signal node_complete_handler(node_name: String)

Parameters

  • node_nameString

#node_start_handler

signal node_start_handler(node_name: String)

Parameters

  • node_nameString

#options_handler

signal options_handler(options: Array[YarnOption])

Parameters

#prepare_for_lines_handler

Emitted before lines are shown so assets can be pre-loaded.
signal prepare_for_lines_handler(line_ids: PackedStringArray)

Parameters

  • line_idsPackedStringArray

#Methods

#continue_dialogue()

func continue_dialogue() -> void

#generate_visit_variable_name(String)

static func generate_visit_variable_name(node_name: String) -> String

Parameters

  • node_nameString

Returns String

#get_all_headers(String)

func get_all_headers(node_name: String) -> Array[Dictionary]

Parameters

  • node_nameString

Returns Array[Dictionary]

#get_all_node_names()

func get_all_node_names() -> PackedStringArray

Returns PackedStringArray

#get_current_node_name()

func get_current_node_name() -> String

Returns String

#get_effective_saliency_strategy()

func get_effective_saliency_strategy() -> YarnSaliencyStrategy

Returns YarnSaliencyStrategy

#get_header_value(String, String)

func get_header_value(node_name: String, header_name: String) -> String

Parameters

  • node_nameString
  • header_nameString

Returns String

#get_headers(String)

func get_headers(node_name: String) -> Dictionary

Parameters

  • node_nameString

Returns Dictionary

#get_saliency_options_for_node_group(String)

func get_saliency_options_for_node_group(node_group_name: String) -> Array

Parameters

  • node_group_nameString

Returns Array

#get_string_id_for_node(String)

func get_string_id_for_node(node_name: String) -> String

Parameters

  • node_nameString

Returns String

#get_visit_count(String)

func get_visit_count(node_name: String) -> int

Parameters

  • node_nameString

Returns int

#has_error()

func has_error() -> bool

Returns bool

#has_header(String, String)

func has_header(node_name: String, header_name: String) -> bool

Parameters

  • node_nameString
  • header_nameString

Returns bool

#has_salient_content(String)

func has_salient_content(node_group_name: String) -> bool

Parameters

  • node_group_nameString

Returns bool

#has_visited_node(String)

func has_visited_node(node_name: String) -> bool

Parameters

  • node_nameString

Returns bool

#is_continuing()

func is_continuing() -> bool

Returns bool

#is_node_group(String)

func is_node_group(node_name: String) -> bool

Parameters

  • node_nameString

Returns bool

#is_running()

func is_running() -> bool

Returns bool

#is_waiting_for_input()

func is_waiting_for_input() -> bool

Returns bool

#reset_visit_tracking()

func reset_visit_tracking() -> void

#set_library(YarnLibrary)

func set_library(library: YarnLibrary) -> void

Parameters

#set_node(String)

func set_node(node_name: String) -> bool

Parameters

  • node_nameString

Returns bool

#set_saliency_strategy(YarnSaliencyStrategy)

func set_saliency_strategy(strategy: YarnSaliencyStrategy) -> void

Parameters

#set_selected_option(int)

Pushes destination + true flag onto stack for the JUMP_IF_FALSE / POP / PEEK_AND_JUMP sequence that the compiler emits after SHOW_OPTIONS.
func set_selected_option(option_index: int) -> void

Parameters

  • option_indexint

#signal_content_complete()

func signal_content_complete() -> void

#stop()

func stop() -> void

#unload_all()

func unload_all() -> void

Generated from Yarn Spinner for Godot GDScript 3.3.