All pages
Powered by GitBook
1 of 5

Loading...

Loading...

Loading...

Loading...

Loading...

Compiler

Class in Yarn.Compiler

Inherits from Yarn.Compiler.YarnSpinnerParserBaseListener

Summary

Compiles Yarn code.

public class Compiler : YarnSpinnerParserBaseListener

Methods

Name
Description

Compiles Yarn code, as specified by a compilation job.

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 .

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

Compile(CompilationJob)
FlattenParseTree(IParseTree)
GetDocumentComments(CommonTokenStream,ParserRuleContext,bool)
GetLineIDForNodeName(string)

FlattenParseTree(IParseTree)

Method in Compiler

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 .

public static IEnumerable<IParseTree> FlattenParseTree(IParseTree node)

Parameters

Name
Description

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

Antlr4.Runtime.Tree.IParseTree node

The root node to begin work from.

Returns

Compile(CompilationJob)

Method in Compiler

Summary

Compiles Yarn code, as specified by a compilation job.

public static CompilationResult Compile(CompilationJob compilationJob)

Parameters

Name
Description

compilationJob

The compilation job to perform.

Returns

The results of the compilation.

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

  • : The result of a compilation.

See Also

CompilationJob
CompilationResult
Yarn.Compiler.CompilationJob

GetLineIDForNodeName(string)

Method in

Name
Description
public static string GetLineIDForNodeName(string name)

string name

Summary

Parameters

Compiler

GetDocumentComments(CommonTokenStream,ParserRuleContext,bool)

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

Name
Description

The text of the documentation comments.

Antlr4.Runtime.CommonTokenStream tokens

The token stream to search.

Antlr4.Runtime.ParserRuleContext context

The parser rule context to get documentation comments for.

bool allowCommentsAfter

If true, this method will search for documentation comments that come after context 's last token and are on the same line.

Returns