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

StringInfo

Information about a string. Stored inside a string table, which is produced from the Compiler.
public struct StringInfo : IEquatable<StringInfo>

Inherits from System.ValueType

Implements System.IEquatable{Yarn.Compiler.StringInfo}

You do not create instances of this class yourself. They are generated by the Compiler.

#Fields

#fileName

The name of the file this string was found in.
public string fileName;

Type String

#isImplicitTag

Indicates whether this string's line ID was implicitly generated.
public bool isImplicitTag;

Type Boolean

Implicitly generated line IDs are not guaranteed to remain the same across multiple compilations. To ensure that a line ID remains the same, you must define it by adding a line tag to the line.

#lineNumber

The line number at which this string was found in the file.
public int lineNumber;

Type Int32

#metadata

The metadata (i.e. hashtags) associated with this string.
public string[] metadata;
This array will contain any hashtags associated with this string besides the #line: hashtag.

#nodeName

The name of the node that this string was found in.
public string nodeName;

Type String

#shadowLineID

The ID of the line that this line is shadowing, or null if this line is not shadowing another line.
public string? shadowLineID;

Type String

#text

The original text of the string.
public string? text;

Type String

This field is null if shadowLineID is not null.

#Methods

#Equals(object)

public override bool Equals(object obj)

Parameters

  • objobject

Returns Boolean

#Equals(StringInfo)

public bool Equals(StringInfo other)

Parameters

Returns Boolean

#GetHashCode()

public override int GetHashCode()

Returns Int32

#ToString()

public override string ToString()

Returns String

Generated from Yarn Spinner for Unity 3.3.