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

NodeDebugInfo

Contains debug information for a node in a Yarn file.
public class NodeDebugInfo

Inherits from System.Object

#Nested Types

  • LineInfo struct
    Contains positional information about an instruction.

#Constructors

#NodeDebugInfo(string?, string)

Initialises a new instance of the NodeDebugInfo class.
public NodeDebugInfo(string? fileName, string nodeName)

Parameters

  • fileNamestring
    The file that the node was defined in.
  • nodeNamestring
    The name of the node.

#Properties

#FileName

Gets or sets the file that this DebugInfo was produced from.
public string? FileName { get; internal set; }

Type String

#IsImplicit

Gets or sets a value indicating whether this node was created by the compiler.
public bool IsImplicit { get; internal set; }

Type Boolean

Nodes that exist in a .yarn file have an IsImplicit value of false. Nodes that are generated by the compiler include smart variable implementations, and node group 'hub' nodes.

#NodeName

Gets or sets the node that this DebugInfo was produced from.
public string NodeName { get; internal set; }

Type String

#Range

The range in the file in which the node appears.
public Range Range { get; internal set; }

Type Range

#Methods

#GetLineInfo(int)

Gets a LineInfo object that describes the specified instruction at the index instructionNumber.
public LineInfo GetLineInfo(int instructionNumber)

Parameters

  • instructionNumberint
    The index of the instruction to retrieve information for.

Returns LineInfo: A LineInfo object that describes the position of the instruction.

Exceptions

  • System.ArgumentOutOfRangeException
    Thrown when instructionNumber is less than zero, or greater than the number of instructions present in the node.

Generated from Yarn Spinner for Unity 3.3.