Class in Yarn.Compiler
Inherits from Yarn.Compiler.YarnSpinnerParserBaseListener
Compiles Yarn code.
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
.
An System.Collections.Generic.IEnumerable`1
that contains a flattened version of the hierarchy rooted at node
.
Name | Description |
---|---|
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
.
Generates a line id for a raw text node
Antlr4.Runtime.Tree.IParseTree
node
The root node to begin work from.
Method in Compiler
Generates a line id for a raw text node
This should only be used when in raw text mode.
line id for the raw text node
Gets the text of the documentation comments that either immediately precede context
, or are on the same line as context
.
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.
The text of the documentation comments.
Name | Description |
---|---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
: An object that contains Yarn source code to compile, and instructions on how to compile it.
: The result of a compilation.
string
name
The name of the node
| The token stream to search. |
| The parser rule context to get documentation comments for. |
| If true, this method will search for documentation comments that come after |
The compilation job to perform. |
compilationJob