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

Node

A node of Yarn script, contained within a Program, and containing Yarn.Instructions.
public class Node

Inherits from Google.Protobuf.IMessage`1

Implements Google.Protobuf.IBufferMessage

#Fields

#NodeGroupHeader

The name of the header that indicates which node group a node belongs to.
public const string NodeGroupHeader = "$Yarn.Internal.NodeGroup";

Type String

#Properties

#ContentSaliencyConditionComplexityScore

Gets the content saliency condition complexity score for this node.
public int ContentSaliencyConditionComplexityScore { get; }

Type Int32

#ContentSaliencyConditionVariables

Gets an enumerable containing the names of variables that must be evaluated in order to determine whether this node can be selected as a piece of salient content.
public IEnumerable<string> ContentSaliencyConditionVariables { get; }

Type IEnumerable

The list of variables is stored in the header as a semicolon-delimited string.

#Headers

The headers present on this node.
public pbc::RepeatedField<global::Yarn.Header> Headers { get; }

Type RepeatedField

#Instructions

The list of instructions in this node.
public pbc::RepeatedField<global::Yarn.Instruction> Instructions { get; }

Type RepeatedField

#IsNodeGroupHub

Gets a value indicating whether this node is the 'hub' node for a node group.
public bool IsNodeGroupHub { get; }

Type Boolean

#Name

The name of this node.
public string Name { get; set; }

Type String

#NodeGroup

Gets the name of the node group that this node is a part of, or null if it is not part of a node group.
public string? NodeGroup { get; }

Type String

#Tags

Gets the collection of tags defined for this node, if any. If no tags are defined, returns an empty collection.
public IEnumerable<string> Tags { get; }

Type IEnumerable

#TrackingVariableName

Gets the name of the variable used for tracking the number of times this node has completed, or null if this node is not tracked.
public string? TrackingVariableName { get; }

Type String

#Methods

#ToString()

public override string ToString()

Returns String

Generated from Yarn Spinner for Unity 3.3.