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

NodeMetadata

contains metadata about a node extracted during compilation for use by language server features this is different from nodedebuginfo which is for instruction level debugging
public class NodeMetadata

Inherits from System.Object

#Properties

#BodyEndLine

zero based line number where the node body ends (at or before three equals signs)
public int BodyEndLine { get; set; }

Type Int32

#BodyStartLine

zero based line number where the node body starts (after second three dashes)
public int BodyStartLine { get; set; }

Type Int32

#CharacterNames

character names found in dialogue lines within this node extracted from lines matching the pattern charactername: dialogue
public List<string> CharacterNames { get; set; }

Type List

#CommandCalls

all command names called within this node (excludes flow control like if/else/endif)
public List<string> CommandCalls { get; set; }

Type List

#FunctionCalls

all function names called within this node
public List<string> FunctionCalls { get; set; }

Type List

#HeaderStartLine

zero based line number where the node header starts (first three dashes)
public int HeaderStartLine { get; set; }

Type Int32

#Jumps

all jump and detour destinations referenced from this node
public List<JumpInfo> Jumps { get; set; }

Type List

#NodeGroup

the node group name (equals sourceTitle when when: headers exist, null otherwise)
public string? NodeGroup { get; set; }

Type String

#NodeGroupComplexity

complexity score for node groups or negative one if not part of a group calculated by the compiler based on when clauses
public int NodeGroupComplexity { get; set; }

Type Int32

#OptionCount

number of shortcut options in this node
public int OptionCount { get; set; }

Type Int32

#Options

detailed information about each shortcut option in this node includes text, conditions, and grouping for visual display
public List<OptionInfo> Options { get; set; }

Type List

#PreviewText

preview text from the first few lines of dialogue in the node used for quick previews in ui
public string PreviewText { get; set; }

Type String

#SourceTitle

the original title as written in source (before any rewriting by NodeGroupVisitor)
public string? SourceTitle { get; set; }

Type String

#Subtitle

the subtitle of the node (optional)
public string? Subtitle { get; set; }

Type String

#Tags

tags from the node tags header
public List<string> Tags { get; set; }

Type List

#Title

the title of the node
public string Title { get; set; }

Type String

#TitleLine

zero based line number where the title declaration is (title: nodename)
public int TitleLine { get; set; }

Type Int32

#UniqueTitle

the rewritten unique title (e.g. "Meeting.happy" or "Meeting.checksum"), set by NodeGroupVisitor
public string? UniqueTitle { get; set; }

Type String

#Uri

the file uri where this node is defined
public string Uri { get; set; }

Type String

#VariableReferences

all variable names referenced within this node
public List<string> VariableReferences { get; set; }

Type List

Generated from Yarn Spinner for Unity 3.3.