Struct in Yarn.Compiler

Inherits from System.ValueType

Summary

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

public struct CompilationJob

Remarks

Instances of this struct are used with Compile(CompilationJob) to produce CompilationResult objects.

Enums

Fields

Methods

Properties

Structs

Field in

Summary

The type of compilation to perform.

Field in

Summary

The structs that represent the content to parse..

Field in

Summary

The that contains declarations for functions.

Method in

Summary

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

Parameters

Returns

A new .

Field in

Summary

The declarations for variables.

Method in CompilationJob

Summary

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

public static CompilationJob CreateFromFiles(params string[] paths)

Parameters

Returns

A new CompilationJob .

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, int languageVersion = Project.CurrentProjectFileVersion)

Parameters

Returns

A new CompilationJob .

Field in

Summary

The name of the file.

Remarks

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

Struct in

Inherits from System.ValueType

Summary

Represents the contents of a file to compile.

Fields

Property in

Summary

The collection of type declarations that should be imported and made available to the compiler, prior to compilation.

Property in

Summary

Gets or sets the version of the Yarn language.

Field in File

Summary

The source code of this file.

public string Source;

Enumeration Member in Type

Summary

Generate declarations only. This is equivalent to TypeCheck .

DeclarationsOnly = TypeCheck

Enumeration Member in Type

Summary

The compiler will generate a string table only.

StringsOnly

Enumeration Member in Type

Summary

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

TypeCheck

Enumeration Member in Type

Summary

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

FullCompilation

Enum in CompilationJob

Inherits from System.Enum

Summary

The type of compilation that the compiler will do.

public enum Type
{
    FullCompilation,
    TypeCheck,
    DeclarationsOnly = TypeCheck,
    StringsOnly
}

Members