All pages
Powered by GitBook
1 of 15

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

CompilationJob

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

Name
Description
Name
Description
Name
Description
Name
Description

The type of compilation that the compiler will do.

The type of compilation to perform.

The structs that represent the content to parse..

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

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

Represents the contents of a file to compile.

Fields

Methods

Structs

The that contains declarations for functions.

The declarations for variables.

Creates a new using the contents of a string.

Type
CompilationType
Files
File
CreateFromFiles(IEnumerable,Library)
CompilationJob
CreateFromFiles(string[])
CompilationJob
File

CompilationType

Field in

The type of compilation to perform.

Library
Library
VariableDeclarations
CreateFromString(string,string,Library)
CompilationJob
public Type CompilationType;

Summary

CompilationJob

Files

Field in

The structs that represent the content to parse..

public IEnumerable<File> Files;

Summary

CompilationJob
File

FullCompilation

Enumeration Member in

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

StringsOnly

Enumeration Member in

The compiler will generate a string table only.

FullCompilation

Summary

Type
Program
StringsOnly

Summary

Type

Library

Field in CompilationJob

Summary

The Library that contains declarations for functions.

public Library Library;

CreateFromFiles(IEnumerable<string>,Library)

Method in CompilationJob

Summary

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

public static CompilationJob CreateFromFiles(IEnumerable<string> paths, Library library = null)

Parameters

Name
Description

System.Collections.Generic.IEnumerable<string> paths

The paths to the files.

A new .

CreateFromString(string,string,Library)

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

Name
Description

string fileName

The name to assign to the compiled file.

A new .

CreateFromFiles(string[])

Method in CompilationJob

Summary

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

public static CompilationJob CreateFromFiles(params string[] paths)

Parameters

Name
Description

string[] paths

The paths to the files.

Returns

A new .

Type

Enum in

Inherits from System.Enum

The type of compilation that the compiler will do.

Name
Description

VariableDeclarations

Field in

The declarations for variables.

Source

Field in

The source code of this file.

FileName

Field in

The name of the file.

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.

Yarn.Library library

The Library containing functions to use for this compilation.

Returns

CompilationJob

string source

The text to compile.

Yarn.Library library

Returns

CompilationJob
CompilationJob
public IEnumerable<Declaration> VariableDeclarations;

Summary

CompilationJob
public string Source;

Summary

File
public string FileName;

Summary

Remarks

File
Line

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

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

The compiler will generate a string table only.

public enum Type
{
    FullCompilation,
    DeclarationsOnly,
    StringsOnly
}

Summary

Members

CompilationJob

File

Struct in CompilationJob

Inherits from System.ValueType

Summary

Represents the contents of a file to compile.

public struct File

Fields

Name
Description
DeclarationsOnly
FullCompilation
Program
StringsOnly

The name of the file.

The source code of this file.

FileName
Source

DeclarationsOnly

Enumeration Member in

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

DeclarationsOnly

Summary

Type