Field in CompilationJob

Summary

The Library that contains declarations for functions.

public Library Library;

Struct in

Inherits from System.ValueType

Summary

An object that contains Yarn source code to compile, and instructions on how to compile it.

Remarks

Instances of this struct are used with to produce objects.

Enums

Fields

Methods

Structs

Method in

Summary

Creates a new using the contents of a collection of files.

Parameters

Returns

A new .

Method in

Summary

Creates a new using the contents of a collection of files.

Parameters

Returns

A new .

Field in

Summary

The structs that represent the content to parse..

Field in

Summary

The type of compilation to perform.

Field in

Summary

The declarations for variables.

Summary

Contains classes for compiling Yarn code.

Classes

Namespaces

Structs

Field in File

Summary

The source code of this file.

public string Source;

Field in File

Summary

The name of the file.

public string FileName;

Remarks

This may be a full path, or just the filename or anything in between. This is useful for diagnostics, and for attributing Line objects to their original source files.

Enumeration Member in Type

Summary

The compiler will do a full compilation, and generate a Program , function declaration set, and string table.

FullCompilation

Enumeration Member in Type

Summary

The compiler will derive only the variable and function declarations, and file tags, found in the script.

DeclarationsOnly

Enum in CompilationJob

Inherits from System.Enum

Summary

The type of compilation that the compiler will do.

public enum Type
{
    FullCompilation,
    DeclarationsOnly,
    StringsOnly
}

Members

Struct in CompilationJob

Inherits from System.ValueType

Summary

Represents the contents of a file to compile.

public struct File

Fields

Method in CompilationJob

Summary

Creates a new CompilationJob using the contents of a string.

public static CompilationJob CreateFromString(string fileName, string source, Library library = null)

Parameters

Returns

A new CompilationJob .

Struct in

Inherits from System.ValueType

Summary

The result of a compilation.

Remarks

Instances of this struct are produced as a result of supplying a to .

Properties

Property in

Summary

Property in

Summary

Gets the collection of objects that describe problems in the source code.

Remarks

If the compiler encounters errors while compiling source code, the it produces will have a value of null . To help figure out what the error is, users should consult the contents of this property.

Enumeration Member in

Summary

The compiler will generate a string table only.

Method in

Summary

Compiles Yarn code, as specified by a compilation job.

Parameters

Returns

The results of the compilation.

See Also

• : An object that contains Yarn source code to compile, and instructions on how to compile it.

• : The result of a compilation.

Property in

Summary

Gets a value indicating whether the compiler had to create line IDs for lines in the source code that lacked #line: tags.

Remarks

Every line is required to have a line ID. If a line doesn't have a line ID specified in the source code (via a #line: tag), the compiler will create one.

Implicit line IDs are guaranteed to remain the same between compilations when the source file does not change. If you want line IDs to remain the same when the source code may be modified in the future, add a #line: tag to the line. This may be done by hand, or added using the method.

Property in

Summary

Gets the compiled Yarn program that the produced.

Remarks

This value will be null if there were errors in the compilation. If this is the case, will contain information describing the errors.

It will also be null if the object's value was not .

Property in

Summary

Gets a dictionary mapping line IDs to StringInfo objects.

Remarks

The string table contains the extracted line text found in the provided source code. The keys of this dictionary are the line IDs for each line - either through explicit line tags indicated through the #line: tag, or implicitly-generated line IDs that the compiler added during compilation.

Class in

Inherits from Yarn.Compiler.YarnSpinnerParserBaseListener

Summary

Compiles Yarn code.

Methods

Property in

Summary

Method in

Summary

Flattens a tree of Antlr4.Runtime.Tree.IParseTree objects by recursively visiting their children, and converting them into a flat System.Collections.Generic.IEnumerable`1 .

Parameters

Returns

An System.Collections.Generic.IEnumerable`1 that contains a flattened version of the hierarchy rooted at node .

Constructor in

Summary

Field in Declaration

Summary

The string used for SourceFileName if the Declaration was found outside of a Yarn source file.

public const string ExternalDeclaration = "(External)";

Property in Declaration

Summary

Gets the default value of this Declaration , if no value has been specified in code or is available from a Dialogue 's IVariableStorage .

public IConvertible DefaultValue { get; internal set; }

Method in Declaration

Summary

public override int GetHashCode()

Method in Declaration

Summary

public override string ToString()

Property in Declaration

Summary

Get or sets a value indicating whether this Declaration was implicitly inferred from usage.

public bool IsImplicit { get; internal set; }

Property in Declaration

Summary

Gets the name of this Declaration.

public string Name { get; internal set; }

Method in Compiler

Summary

public static string GetLineIDForNodeName(string name)

Parameters

Method in Declaration

Summary

Creates a new instance of the Declaration class, using the given name and default value. The ReturnType of the new instance will be configured based on the type of defaultValue , and the DeclarationType will be Type.Variable . All other properties will be their default values.

public static Declaration CreateVariable(string name, Yarn.IType type, IConvertible defaultValue, string description = null)

Parameters

Returns

A new instance of the Declaration class.

Method in Compiler

Summary

Gets the text of the documentation comments that either immediately precede context , or are on the same line as context .

public static string GetDocumentComments(CommonTokenStream tokens, ParserRuleContext context, bool allowCommentsAfter = true)

Remarks

Documentation comments begin with a triple-slash ( /// ), and are used to describe variable declarations. If documentation comments precede a declaration (that is, they're not on the same line as the declaration), then they may span multiple lines, as long as each line begins with a triple-slash.

Parameters

Returns

The text of the documentation comments.

Class in Yarn.Compiler

Inherits from System.Object

Summary

public class Declaration

Constructors

Fields

Methods

Properties

Method in Declaration

Summary

public override bool Equals(object obj)

Parameters

Property in

Summary

Property in

Summary

Gets the name of the file in which this Declaration was found.

Remarks

If this was not found in a Yarn source file, this will be .

Class in

Inherits from System.Object

Summary

Constructors

Enums

Fields

Methods

Property in

Summary

Gets a string describing the purpose of this .

Property in

Summary

The line number at which this Declaration was found in the source file.

Remarks

If this was not found in a Yarn source file, this will be -1.

Field in

Summary

Property in

Summary

Gets the name of the node in which this Declaration was found.

Remarks

If this was not found in a Yarn source file, this will be null .

Field in

Summary

Field in

Summary

Field in

Summary

Property in Declaration

Summary

Gets the line number at which this Declaration was found in the node indicated by SourceNodeName .

public int SourceNodeLine { get; internal set; }

Remarks

If this Declaration was not found in a Yarn source file, this will be -1.

Field in Diagnostic

Summary

public string Message = "(internal error: no message provided)";

Enumeration Member in DiagnosticSeverity

Summary

Error

Method in Diagnostic

Summary

public override string ToString()

Method in Diagnostic

Summary

public override int GetHashCode()

Method in FileParseResult

Summary

public override int GetHashCode()

Enumeration Member in DiagnosticSeverity

Summary

Info

Constructor in Diagnostic

Summary

public Diagnostic(string fileName, string message, DiagnosticSeverity severity = DiagnosticSeverity.Error)

Parameters

Constructor in Diagnostic

Summary

public Diagnostic(string fileName, ParserRuleContext context, string message, DiagnosticSeverity severity = DiagnosticSeverity.Error)

Parameters

Constructor in Diagnostic

Summary

public Diagnostic(string message, DiagnosticSeverity severity = DiagnosticSeverity.Error)

Parameters

Constructor in Diagnostic

Summary

public Diagnostic(string fileName, int line, int column, string message, DiagnosticSeverity severity = DiagnosticSeverity.Error)

Parameters

Method in Diagnostic

Summary

public override bool Equals(object obj)

Parameters

Enum in Diagnostic

Inherits from System.Enum

Summary

public enum DiagnosticSeverity
{
    Error,
    Warning,
    Info
}

Members

Struct in Yarn.Compiler

Inherits from System.ValueType

Summary

Contains the result of parsing a single file of source code.

public struct FileParseResult

Remarks

This class provides only syntactic information about a parse - that is, it provides access to the parse tree, and the stream of tokens used to produce that parse tree.

Constructors

Methods

Properties

Constructor in FileParseResult

Summary

Initializes a new instance of the FileParseResult struct.

public FileParseResult(string name, IParseTree tree, CommonTokenStream tokens)

Parameters

Field in

Summary

Enumeration Member in

Summary

Constructor in

Summary

Initializes a new instance of the class.

Parameters

Property in

Summary

The name of the file.

Class in

Inherits from Antlr4.Runtime.Lexer

Summary

A Lexer subclass that detects newlines and generates indent and dedent tokens accordingly.

Constructors

Methods

Properties

Structs

Method in

Summary

Property in

Summary

The tokens extracted from the file.

Property in

Summary

The parse tree extracted from the file.

Struct in

Inherits from System.ValueType

Summary

A warning emitted during lexing.

Fields

Method in

Summary

Parameters

Property in

Summary

Gets the collection of warnings determined during lexing.

Field in

Summary

The name of the file this string was found in.

Field in

Summary

The metadata (i.e. hashtags) associated with this string.

Remarks

This array will contain any hashtags associated with this string besides the #line: hashtag.

Field in

Summary

The token associated with the warning.

Method in StringInfo

Summary

public override string ToString()

Field in StringInfo

Summary

The line number at which this string was found in the file.

public int lineNumber;

Field in StringInfo

Summary

The original text of the string.

public string text;

Field in StringInfo

Summary

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

public string nodeName;

Field in StringInfo

Summary

Indicates whether this string's line ID was implicitly generated.

public bool isImplicitTag;

Remarks

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.

Struct in Yarn.Compiler

Inherits from System.ValueType

Summary

Information about a string. Stored inside a string table, which is produced from the Compiler.

public struct StringInfo

Remarks

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

Fields

Methods

Class in Yarn.Compiler

Inherits from System.Object

Summary

Utility methods for working with line tags.

public static class Utility

Methods

Method in Utility

Summary

Parses a string of Yarn source code, and produces a FileParseResult and (if there were any problems) a collection of diagnostics.

public static (FileParseResult, IEnumerable<Diagnostic>) ParseSource(string source)

Parameters

Returns

A tuple containing a FileParseResult that stores the parse tree and tokens, and a collection of Diagnostic objects that describe problems in the source code.

Method in Utility

Summary

Given Yarn source code, adds line tags to the ends of all lines that need one and do not already have one.

public static string AddTagsToLines(string contents, ICollection<string> existingLineTags = null)

Remarks

This method ensures that it does not generate line tags that are already present in the file, or present in the existingLineTags collection.

Line tags are added to any line of source code that contains user-visible text: lines, options, and shortcut options.

Parameters

Returns

The modified source code, with line tags added.

Method in Utility

Summary

Generates a Yarn script that contains a node that declares variables.

public static string GenerateYarnFileWithDeclarations(
    IEnumerable<Yarn.Compiler.Declaration> declarations,
    string title = "Program",
    IEnumerable<string> tags = null,
    IDictionary<string, string> headers = null)

Remarks

This method is intended to be called by tools that let the user manage variable declarations. Such tools can read the existing variable declarations in from a script (by compiling the script with the CompilationType value set to DeclarationsOnly ), allow the user to make changes, and then write the changes to disk by calling this method and saving the results.

Parameters

Returns

A string containing a Yarn script that declares the specified variables.

Field in Warning

Summary

The message associated with the warning.

public string Message;