Method in Compiler
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)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.
Class in Yarn.Compiler
Inherits from Yarn.Compiler.YarnSpinnerParserBaseListener
Compiles Yarn code.
public class Compiler : YarnSpinnerParserBaseListenerCompiles 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 .
Method in Compiler
Compiles Yarn code, as specified by a compilation job.
public static CompilationResult Compile(CompilationJob compilationJob)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.
Yarn.Compiler.CompilationJob compilationJob
The compilation job to perform.
Method in Compiler
public static string GetLineIDForNodeName(string name)string name
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.
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.
The text of the documentation comments.
public static string GetDocumentComments(CommonTokenStream tokens, ParserRuleContext context, bool allowCommentsAfter = true)