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

DiagnosticDescriptor.DiagnosticDescriptor1

Describes a diagnostic message with a unique code and template.
public sealed class DiagnosticDescriptor1 : DiagnosticDescriptor

Inherits from Yarn.Compiler.DiagnosticDescriptor

This class ensures that diagnostic codes and their descriptions are always paired correctly, preventing typos and mismatches. All diagnostics should be created using the predefined descriptors in this class.

#Methods

#Create(string, Antlr4.Runtime.IToken, string)

public Diagnostic Create(string sourceFile, Antlr4.Runtime.IToken token, string message);

Parameters

  • messagestring
    The value to use for the first parameter in this diagnostic's message.
  • sourceFilestring
  • tokenAntlr4.Runtime.IToken

Returns Diagnostic

#Create(string, Antlr4.Runtime.ParserRuleContext, string)

public Diagnostic Create(string sourceFile, Antlr4.Runtime.ParserRuleContext context, string message);

Parameters

  • messagestring
    The value to use for the first parameter in this diagnostic's message.
  • sourceFilestring
  • contextAntlr4.Runtime.ParserRuleContext

Returns Diagnostic

#Create(string, Range, string)

Creates a new Diagnostic using this descriptor.
public Diagnostic Create(string sourceFile, Range range, string message);

Parameters

  • sourceFilestring
    The name of the file in which this error occurred.
  • The range of the file associated with this error.
  • args(unknown)
    The arguments to use when composing the diagnostic's message.
  • messagestring
    The value to use for the first parameter in this diagnostic's message.

Returns Diagnostic: The diagnostic.

#Create(string, string)

Creates a new Diagnostic using this descriptor.
public Diagnostic Create(string sourceFile, string message);

Parameters

  • sourceFilestring
    The name of the file in which this error occurred.
  • args(unknown)
    The arguments to use when composing the diagnostic's message.
  • messagestring
    The value to use for the first parameter in this diagnostic's message.

Returns Diagnostic: The diagnostic.

Generated from Yarn Spinner for Unity 3.3.