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

YarnProgram

Represents a compiled yarn spinner program.
class_name YarnProgram
extends Resource

Inherits from Resource

#Nested Types

#Constants

#NODE_GROUP_HEADER

const NODE_GROUP_HEADER = "$Yarn.Internal.NodeGroup"

#NODE_GROUP_HUB_HEADER

const NODE_GROUP_HUB_HEADER = "$Yarn.Internal.NodeGroupHub"

#SMART_VARIABLE_TAG

const SMART_VARIABLE_TAG = "Yarn.SmartVariable"

#Properties

#initial_values

var initial_values: Dictionary = {}

Type Dictionary

#language_version

var language_version: int = 0

Type int

#line_metadata

var line_metadata: Dictionary = {}

Type Dictionary

#nodes

var nodes: Dictionary = {}

Type Dictionary

#program_name

var program_name: String = ""

Type String

#string_table

var string_table: Dictionary = {}

Type Dictionary

#Methods

#get_initial_value(String)

func get_initial_value(variable_name: String) -> Variant

Parameters

  • variable_nameString

Returns Variant

#get_line_ids_for_node(String)

func get_line_ids_for_node(node_name: String) -> PackedStringArray

Parameters

  • node_nameString

Returns PackedStringArray

#get_line_metadata(String)

func get_line_metadata(line_id: String) -> PackedStringArray

Parameters

  • line_idString

Returns PackedStringArray

#get_metadata_value(String, String)

Returns the value after tag_prefix, e.g. "shadow:other_line" -> "other_line".
func get_metadata_value(line_id: String, tag_prefix: String) -> String

Parameters

  • line_idString
  • tag_prefixString

Returns String

#get_node_names()

func get_node_names() -> PackedStringArray

Returns PackedStringArray

#get_node(String)

func get_node(node_name: String) -> YarnNode

Parameters

  • node_nameString

Returns YarnNode

#get_smart_variable_nodes()

func get_smart_variable_nodes() -> Array[YarnNode]

Returns Array[YarnNode]

#get_string(String)

func get_string(line_id: String) -> String

Parameters

  • line_idString

Returns String

#get_variable_kind(String)

func get_variable_kind(variable_name: String) -> int

Parameters

  • variable_nameString

Returns int

#has_initial_value(String)

func has_initial_value(variable_name: String) -> bool

Parameters

  • variable_nameString

Returns bool

#has_line_metadata(String)

func has_line_metadata(line_id: String) -> bool

Parameters

  • line_idString

Returns bool

#has_metadata_tag(String, String)

func has_metadata_tag(line_id: String, tag: String) -> bool

Parameters

  • line_idString
  • tagString

Returns bool

#has_node(String)

func has_node(node_name: String) -> bool

Parameters

  • node_nameString

Returns bool

#has_string(String)

func has_string(line_id: String) -> bool

Parameters

  • line_idString

Returns bool

#is_node_group_hub(String)

func is_node_group_hub(node_name: String) -> bool

Parameters

  • node_nameString

Returns bool

Generated from Yarn Spinner for Godot GDScript 3.3.