7035 lines
368 KiB
XML
7035 lines
368 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>YarnSpinner.Compiler</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Yarn.Compiler.BasicBlock">
|
|
<summary>
|
|
A basic block is a run of instructions inside a Node. Basic blocks group
|
|
instructions up into segments such that execution only ever begins at
|
|
the start of a block (that is, a program never jumps into the middle of
|
|
a block), and execution only ever leaves at the end of a block.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.LabelName">
|
|
<summary>
|
|
Gets the name of the label that this block begins at, or null if this basic block does not begin at a labelled instruction.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.NodeName">
|
|
<summary>
|
|
Gets the name of the node that this block is in.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.FirstInstructionIndex">
|
|
<summary>
|
|
Gets the index of the first instruction of the node that this block is in.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.BasicBlock.Node">
|
|
<summary>
|
|
Gets the Node that this block was extracted from.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.Name">
|
|
<summary>
|
|
Gets a descriptive name for the block.
|
|
</summary>
|
|
<remarks>
|
|
If this block begins at a labelled instruction, the name will be <c>[NodeName].[LabelName]</c>. Otherwise, it will be <c>[NodeName].[FirstInstructionIndex]</c>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.ToString(Yarn.Library,Yarn.Compiler.CompilationResult)">
|
|
<summary>
|
|
Gets a string containing the textual description of the instructions
|
|
in this <see cref="T:Yarn.Compiler.BasicBlock"/>.
|
|
</summary>
|
|
<param name="library">The <see cref="T:Yarn.Library"/> to use when
|
|
converting instructions to strings.</param>
|
|
<param name="compilationResult">The <see cref="T:Yarn.Compiler.CompilationResult"/>
|
|
that produced <see cref="F:Yarn.Compiler.BasicBlock.Node"/>.</param>
|
|
<returns>A string containing the text version of the
|
|
instructions.</returns>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.Ancestors">
|
|
<summary>
|
|
Get the ancestors of this block - that is, blocks that may run immediately before this block.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.Destinations">
|
|
<summary>
|
|
Gets the destinations of this block - that is, blocks or nodes that
|
|
may run immediately after this block.
|
|
</summary>
|
|
<seealso cref="T:Yarn.Compiler.BasicBlock.Destination"/>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.Instructions">
|
|
<summary>
|
|
Gets the Instructions that form this block.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.AddDestination(Yarn.Compiler.BasicBlock,Yarn.Compiler.BasicBlock.Condition)">
|
|
<summary>
|
|
Adds a new destination to this block, that points to another block.
|
|
</summary>
|
|
<param name="descendant">The new descendant node.</param>
|
|
<param name="condition">The condition under which <paramref
|
|
name="descendant"/> will be run.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when descendant is
|
|
<see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.AddDestination(System.String,Yarn.Compiler.BasicBlock.Condition)">
|
|
<summary>
|
|
Adds a new destination to this block, that points to a node.
|
|
</summary>
|
|
<param name="nodeName">The name of the destination node.</param>
|
|
<param name="condition">The condition under which <paramref
|
|
name="nodeName"/> will be jumped to.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when <paramref
|
|
name="nodeName"/> is <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.AddDetourDestination(System.String,Yarn.Compiler.BasicBlock.Condition,Yarn.Compiler.BasicBlock)">
|
|
<summary>
|
|
Adds a new destination to this block that represents a detour to a
|
|
node.
|
|
</summary>
|
|
<param name="nodeName">The name of the destination node.</param>
|
|
<param name="condition">The condition under which <paramref
|
|
name="nodeName"/> will be jumped to.</param>
|
|
<param name="returnToBlock">The name of the block that will be
|
|
returned to when the detour returns.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when <paramref
|
|
name="nodeName"/> is <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.AddDestinationToAnywhere(Yarn.Compiler.BasicBlock)">
|
|
<summary>
|
|
Adds a new destination to this block that points at any other node
|
|
in the program.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.AddDestination(Yarn.Compiler.BasicBlock,Yarn.Compiler.BasicBlock.Condition,System.String)">
|
|
<summary>
|
|
Adds a new destination to this block that points to a node, with a
|
|
option's line ID for context.
|
|
</summary>
|
|
<param name="descendant">The new descendant node.</param>
|
|
<param name="condition">The condition under which the node <paramref
|
|
name="descendant"/> will be run.</param>
|
|
<param name="lineID">The line ID of the option that must be selected
|
|
in order for <paramref name="descendant"/> to run.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when <paramref
|
|
name="descendant"/> is <see langword="null"/>.</exception>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.BasicBlock.Destination">
|
|
<summary>
|
|
A destination represents a <see cref="T:Yarn.Compiler.BasicBlock"/> or node that may
|
|
be run, following the execution of a <see cref="T:Yarn.Compiler.BasicBlock"/>.
|
|
</summary>
|
|
<remarks>
|
|
Destination objects represent links between blocks, or between
|
|
blocks and nodes.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.Destination.#ctor(Yarn.Compiler.BasicBlock.Condition,Yarn.Compiler.BasicBlock)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:Yarn.Compiler.BasicBlock.Destination"/>
|
|
class.
|
|
</summary>
|
|
<param name="condition">The condition under which the
|
|
destination will be run.</param>
|
|
<param name="returnTo">An optional block that may be returned to
|
|
later in the program execution.</param>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.Destination.Condition">
|
|
<summary>
|
|
The condition that causes this destination to be reached.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.Destination.ReturnTo">
|
|
<summary>
|
|
When this destination is taken, if this value is non-null, a VM
|
|
should push this block onto the call stack. When a Return
|
|
instruction is reached, pop a block off the call stack and
|
|
return to it. If the value is null, the VM should clear the call
|
|
stack.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.Destination.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.BasicBlock.NodeDestination">
|
|
<summary>
|
|
A destination that represents a jump or detour to a node.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.NodeDestination.#ctor(System.String,Yarn.Compiler.BasicBlock.Condition,Yarn.Compiler.BasicBlock)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:Yarn.Compiler.BasicBlock.NodeDestination"/>
|
|
class.
|
|
</summary>
|
|
<param name="condition">The condition under which the
|
|
destination will be run.</param>
|
|
<param name="returnTo">An optional block that may be returned to
|
|
later in the program execution.</param>
|
|
<param name="nodeName">The name of the node to jump or detour
|
|
to.</param>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.NodeDestination.NodeName">
|
|
<summary>
|
|
The name of the node that this destination refers to.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.BasicBlock.AnyNodeDestination">
|
|
<summary>
|
|
A destination that represents a jump or detour to any possible node.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.AnyNodeDestination.#ctor(Yarn.Compiler.BasicBlock)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:Yarn.Compiler.BasicBlock.AnyNodeDestination"/>
|
|
class.
|
|
</summary>
|
|
<param name="returnTo">An optional block that may be returned to
|
|
later in the program execution.</param>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.BasicBlock.BlockDestination">
|
|
<summary>
|
|
A destination that represents a jump to a specific block.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.BlockDestination.Block">
|
|
<summary>
|
|
The block that this destination refers to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.BlockDestination.DestinationInstructionIndex">
|
|
<summary>
|
|
Gets the index of the first instruction of the block in its
|
|
containing node.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.BlockDestination.#ctor(Yarn.Compiler.BasicBlock,Yarn.Compiler.BasicBlock.Condition)">
|
|
<summary>
|
|
Initialises a new instance of the <see
|
|
cref="T:Yarn.Compiler.BasicBlock.BlockDestination"/> class.
|
|
</summary>
|
|
<param name="block">The block that is jumped to.</param>
|
|
<param name="condition">The condition under which the
|
|
destination is taken.</param>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.BasicBlock.OptionDestination">
|
|
<summary>
|
|
A destination that represents an option being selected.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.OptionDestination.#ctor(System.String,Yarn.Compiler.BasicBlock)">
|
|
<summary>
|
|
Initialises a new instance of the <see
|
|
cref="T:Yarn.Compiler.BasicBlock.OptionDestination"/> class.
|
|
</summary>
|
|
<param name="optionLineID">The ID of the line associated with
|
|
this option.</param>
|
|
<param name="block">The block that is jumped to when this option
|
|
is selected.</param>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.OptionDestination.OptionLineID">
|
|
<summary>
|
|
Gets or sets the ID of the line associated with this option.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.OptionDestination.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.Descendants">
|
|
<summary>
|
|
Gets all descendants (that is, destinations, and destinations of
|
|
those destinations, and so on), recursively.
|
|
</summary>
|
|
<remarks>
|
|
Cycles are detected and avoided.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.DescendantsWithPlayerVisibleContent">
|
|
<summary>
|
|
Gets all descendants (that is, destinations, and destinations of
|
|
those destinations, and so on) that have any player-visible content,
|
|
recursively.
|
|
</summary>
|
|
<remarks>
|
|
Cycles are detected and avoided.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.BasicBlock.Condition">
|
|
<summary>
|
|
The conditions under which a <see cref="T:Yarn.Compiler.BasicBlock.Destination"/> may be
|
|
reached at the end of a BasicBlock.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.BasicBlock.Condition.Fallthrough">
|
|
<summary>
|
|
The Destination is reached because the preceding BasicBlock
|
|
reached the end of its execution, and the Destination's target
|
|
is the block immediately following.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.BasicBlock.Condition.DirectJump">
|
|
<summary>
|
|
The Destination is reached beacuse of an explicit instruction to
|
|
go to this block or node.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.BasicBlock.Condition.ExpressionIsTrue">
|
|
<summary>
|
|
The Destination is reached because an expression evaluated to
|
|
true.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.BasicBlock.Condition.ExpressionIsFalse">
|
|
<summary>
|
|
The Destination is reached because an expression evaluated to
|
|
false.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.BasicBlock.Condition.Option">
|
|
<summary>
|
|
The Destination is reached because the player made an in-game
|
|
choice to go to it.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.BasicBlock.PlayerVisibleContentElement">
|
|
<summary>
|
|
An abstract class that represents some content that is shown to the
|
|
player.
|
|
</summary>
|
|
<remarks>
|
|
This class is used, rather than the runtime classes Yarn.Line or
|
|
Yarn.OptionSet, because when the program is being analysed, no
|
|
values for any substitutions are available. Instead, these classes
|
|
represent the data that is available offline.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.BasicBlock.LineElement">
|
|
<summary>
|
|
A line of dialogue that should be shown to the player.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.BasicBlock.LineElement.LineID">
|
|
<summary>
|
|
The string table ID of the line that will be shown to the player.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.LineElement.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:Yarn.Compiler.BasicBlock.LineElement"/>
|
|
class.
|
|
</summary>
|
|
<param name="lineID">The ID of the line that this element
|
|
represents.</param>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.BasicBlock.OptionsElement">
|
|
<summary>
|
|
A collection of options that should be shown to the player.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.BasicBlock.OptionsElement.Option">
|
|
<summary>
|
|
Represents a single option that may be presented to the player.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.BasicBlock.OptionsElement.Option.LineID">
|
|
<summary>
|
|
The string table ID that will be shown to the player.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.BasicBlock.OptionsElement.Option.Destination">
|
|
<summary>
|
|
The destination that will be run if this option is selected
|
|
by the player.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.BasicBlock.OptionsElement.Options">
|
|
<summary>
|
|
The collection of options that will be delivered to the player.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.OptionsElement.#ctor(System.Collections.Generic.IEnumerable{Yarn.Compiler.BasicBlock.OptionsElement.Option})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:Yarn.Compiler.BasicBlock.OptionsElement"/>
|
|
class.
|
|
</summary>
|
|
<param name="options">The options that will be delivered to the
|
|
player.</param>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.BasicBlock.CommandElement">
|
|
<summary>
|
|
A command that will be executed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.BasicBlock.CommandElement.CommandText">
|
|
<summary>
|
|
The text of the command.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.BasicBlock.CommandElement.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:Yarn.Compiler.BasicBlock.CommandElement"/>
|
|
class.
|
|
</summary>
|
|
<param name="commandText">The text of the command.</param>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.BasicBlock.PlayerVisibleContent">
|
|
<summary>
|
|
Gets the collection of player-visible content that will be delivered
|
|
when this block is run.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
Player-visible content means lines, options and commands. When this
|
|
block is run, the entire contents of this collection will be
|
|
displayed to the player, in the same order as they appear in this
|
|
collection.
|
|
</para>
|
|
<para>
|
|
If this collection is empty, then the block contains no visible
|
|
content. This is the case for blocks that only contain logic, and do
|
|
not contain any lines, options or commands.
|
|
</para>
|
|
<example>
|
|
To tell the difference between the different kinds of content, use
|
|
the <see langword="is"/> operator to check the type of each item:
|
|
<code>
|
|
foreach (var item in block.PlayerVisibleContent) {
|
|
if (item is LineElement line) {
|
|
// Do something with line
|
|
}
|
|
}
|
|
</code>
|
|
</example>
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.InstructionCollectionExtensions">
|
|
<summary>
|
|
Contains extension methods for producing <see cref="T:Yarn.Compiler.BasicBlock"/>
|
|
objects from a Node.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.InstructionCollectionExtensions.GetBasicBlocks(Yarn.Node,Yarn.Compiler.NodeDebugInfo)">
|
|
<summary>
|
|
Produces <see cref="T:Yarn.Compiler.BasicBlock"/> objects from a Node.
|
|
</summary>
|
|
<param name="node">The node to get basic blocks from.</param>
|
|
<param name="info">An object containing debugging information for
|
|
the node.</param>
|
|
<returns></returns>
|
|
<exception cref="T:System.InvalidOperationException"></exception>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.DeclarationBuilder">
|
|
<summary>
|
|
Provides methods for constructing <see
|
|
cref="T:Yarn.Compiler.Declaration"/> objects.
|
|
</summary>
|
|
<remarks>
|
|
To use this class, create an instance of it, and call the
|
|
<c>With</c>-prefixed methods to set properties. When you're done, access
|
|
the <see cref="P:Yarn.Compiler.DeclarationBuilder.Declaration"/> property to get the final, constructed
|
|
<see cref="T:Yarn.Compiler.Declaration"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.DeclarationBuilder.Declaration">
|
|
<summary>
|
|
Gets the <see cref="P:Yarn.Compiler.DeclarationBuilder.Declaration"/> instance constructed by this <see
|
|
cref="T:Yarn.Compiler.DeclarationBuilder"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.DeclarationBuilder.WithName(System.String)">
|
|
<summary>
|
|
Sets the <see cref="P:Yarn.Compiler.Declaration.Name"/> of the <see
|
|
cref="P:Yarn.Compiler.DeclarationBuilder.Declaration"/>.
|
|
</summary>
|
|
<param name="name">The name to apply to the Declaration.</param>
|
|
<returns>The <see cref="T:Yarn.Compiler.DeclarationBuilder"/> instance that received
|
|
this method call.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.DeclarationBuilder.WithDefaultValue(System.IConvertible)">
|
|
<summary>
|
|
Sets the <see cref="P:Yarn.Compiler.Declaration.DefaultValue"/> of the <see
|
|
cref="P:Yarn.Compiler.DeclarationBuilder.Declaration"/>.
|
|
</summary>
|
|
<param name="defaultValue">The default value to apply to the
|
|
Declaration.</param>
|
|
<inheritdoc cref="M:Yarn.Compiler.DeclarationBuilder.WithName(System.String)" path="/returns"/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.DeclarationBuilder.WithDescription(System.String)">
|
|
<summary>
|
|
Sets the <see cref="P:Yarn.Compiler.Declaration.Description"/> of the <see
|
|
cref="P:Yarn.Compiler.DeclarationBuilder.Declaration"/>.
|
|
</summary>
|
|
<param name="description">The description to apply to the
|
|
Declaration.</param>
|
|
<inheritdoc cref="M:Yarn.Compiler.DeclarationBuilder.WithName(System.String)" path="/returns"/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.DeclarationBuilder.WithSourceFileName(System.String)">
|
|
<summary>
|
|
Sets the <see cref="P:Yarn.Compiler.Declaration.SourceFileName"/> of the <see
|
|
cref="P:Yarn.Compiler.DeclarationBuilder.Declaration"/>.
|
|
</summary>
|
|
<param name="sourceFileName">The source file name to apply to the
|
|
Declaration.</param>
|
|
<inheritdoc cref="M:Yarn.Compiler.DeclarationBuilder.WithName(System.String)" path="/returns"/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.DeclarationBuilder.WithSourceNodeName(System.String)">
|
|
<summary>
|
|
Sets the <see cref="P:Yarn.Compiler.Declaration.SourceNodeName"/> of the <see
|
|
cref="P:Yarn.Compiler.DeclarationBuilder.Declaration"/>.
|
|
</summary>
|
|
<param name="sourceNodeName">The source node name to apply to the
|
|
Declaration.</param>
|
|
<inheritdoc cref="M:Yarn.Compiler.DeclarationBuilder.WithName(System.String)" path="/returns"/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.DeclarationBuilder.WithRange(Yarn.Compiler.Range)">
|
|
<summary>
|
|
Sets the <see cref="P:Yarn.Compiler.Declaration.Range"/> of the <see
|
|
cref="P:Yarn.Compiler.DeclarationBuilder.Declaration"/>.
|
|
</summary>
|
|
<param name="range">The range to apply to the Declaration.</param>
|
|
<inheritdoc cref="M:Yarn.Compiler.DeclarationBuilder.WithName(System.String)" path="/returns"/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.DeclarationBuilder.WithImplicit(System.Boolean)">
|
|
<summary>
|
|
Sets the <see cref="P:Yarn.Compiler.Declaration.IsImplicit"/> of the <see
|
|
cref="P:Yarn.Compiler.DeclarationBuilder.Declaration"/>.
|
|
</summary>
|
|
<param name="isImplicit">The is-implicit value to apply to the
|
|
Declaration.</param>
|
|
<inheritdoc cref="M:Yarn.Compiler.DeclarationBuilder.WithName(System.String)" path="/returns"/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.DeclarationBuilder.WithType(Yarn.IType)">
|
|
<summary>
|
|
Sets the <see cref="P:Yarn.Compiler.Declaration.Type"/> of the <see
|
|
cref="P:Yarn.Compiler.DeclarationBuilder.Declaration"/>.
|
|
</summary>
|
|
<param name="type">The type to apply to the Declaration.</param>
|
|
<inheritdoc cref="M:Yarn.Compiler.DeclarationBuilder.WithName(System.String)" path="/returns"/>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.EnumTypeBuilder">
|
|
<summary>
|
|
Provides methods for constructing <see cref="T:Yarn.EnumType"/> objects.
|
|
</summary>
|
|
<remarks>
|
|
To use this class, create an instance of it, and call the
|
|
<c>With</c>-prefixed methods to set properties. When you're done, access
|
|
the <see cref="P:Yarn.Compiler.EnumTypeBuilder.EnumType"/> property to get the final, constructed <see
|
|
cref="T:Yarn.EnumType"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.EnumTypeBuilder.FromEnum``1(System.String)">
|
|
<summary>
|
|
Creates a new <see cref="P:Yarn.Compiler.EnumTypeBuilder.EnumType"/> given a CLR enum type.
|
|
</summary>
|
|
<typeparam name="TEnum">The type of the CLR enum.</typeparam>
|
|
<param name="description">An optional description to apply to the
|
|
new Yarn enum type.</param>
|
|
<returns>A Yarn type representing the enum.</returns>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.EnumTypeBuilder.EnumType">
|
|
<summary>
|
|
Gets the constructed enum type.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.EnumTypeBuilder.WithName(System.String)">
|
|
<summary>
|
|
Sets the <see cref="P:Yarn.EnumType.Name"/> property of the constructed
|
|
enum type.
|
|
</summary>
|
|
<param name="name">The new name.</param>
|
|
<returns>The <see cref="T:Yarn.Compiler.EnumTypeBuilder"/> instance that received
|
|
this method call.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.EnumTypeBuilder.WithDescription(System.String)">
|
|
<summary>
|
|
Sets the <see cref="P:Yarn.EnumType.Description"/> property of the
|
|
constructed enum type.
|
|
</summary>
|
|
<param name="description">The new description.</param>
|
|
<returns>The <see cref="T:Yarn.Compiler.EnumTypeBuilder"/> instance that received
|
|
this method call.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.EnumTypeBuilder.WithRawType(Yarn.IType)">
|
|
<summary>
|
|
Sets the <see cref="P:Yarn.EnumType.RawType"/> property of the constructed
|
|
enum type.
|
|
</summary>
|
|
<param name="rawType">The new raw type.</param>
|
|
<returns>The <see cref="T:Yarn.Compiler.EnumTypeBuilder"/> instance that received
|
|
this method call.</returns>
|
|
<exception cref="T:System.InvalidOperationException">Thrown if the enum has
|
|
any cases added to it.</exception>
|
|
<exception cref="T:System.ArgumentException">Thrown if <paramref
|
|
name="rawType"/> is neither a string type nor a number
|
|
type.</exception>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.EnumTypeBuilder.WithCase(System.String,System.String,System.String)">
|
|
<summary>
|
|
Adds a new string case to the constructed enum type.
|
|
</summary>
|
|
<param name="caseName">The name of the case, as it appears in Yarn
|
|
Spinner scripts.</param>
|
|
<param name="rawValue">The raw value of the case.</param>
|
|
<param name="description">The optional description for the
|
|
case.</param>
|
|
<inheritdoc cref="M:Yarn.Compiler.EnumTypeBuilder.WithCase(System.String,Yarn.IType,System.IConvertible,System.String)"
|
|
path="/exception"/>
|
|
<returns>The <see cref="T:Yarn.Compiler.EnumTypeBuilder"/> instance that received
|
|
this method call.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.EnumTypeBuilder.WithCase(System.String,System.Single,System.String)">
|
|
<summary>
|
|
Adds a new string case to the constructed enum type.
|
|
</summary>
|
|
<inheritdoc cref="M:Yarn.Compiler.EnumTypeBuilder.WithCase(System.String,Yarn.IType,System.IConvertible,System.String)"
|
|
path="/param"/>
|
|
<inheritdoc cref="M:Yarn.Compiler.EnumTypeBuilder.WithCase(System.String,Yarn.IType,System.IConvertible,System.String)"
|
|
path="/exception"/>
|
|
<returns>The <see cref="T:Yarn.Compiler.EnumTypeBuilder"/> instance that received
|
|
this method call.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.EnumTypeBuilder.WithCase(System.String,Yarn.IType,System.IConvertible,System.String)">
|
|
<summary>
|
|
Adds a new case to the constructed enum type.
|
|
</summary>
|
|
<param name="caseName">The name of the case, as it appears in Yarn
|
|
Spinner scripts.</param>
|
|
<param name="rawValue">The raw value of the case.</param>
|
|
<param name="description">The optional description for the
|
|
case.</param>
|
|
<param name="rawType">The type of the case.</param>
|
|
<returns></returns>
|
|
<exception cref="T:System.ArgumentException">Thrown if the raw type doesn't
|
|
match the enum's type, if a case with the given name already exists,
|
|
or if a case with the given value already exists.</exception>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.FunctionTypeBuilder">
|
|
<summary>
|
|
Provides methods for constructing <see cref="T:Yarn.FunctionType"/>
|
|
objects.
|
|
</summary>
|
|
<remarks>
|
|
To use this class, create an instance of it, and call the
|
|
<c>With</c>-prefixed methods to set properties. When you're done, access
|
|
the <see cref="P:Yarn.Compiler.FunctionTypeBuilder.FunctionType"/> property to get the final, constructed
|
|
<see cref="T:Yarn.FunctionType"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.FunctionTypeBuilder.FunctionType">
|
|
<summary>
|
|
Gets the <see cref="P:Yarn.Compiler.FunctionTypeBuilder.FunctionType"/> instance constructed by this
|
|
<see cref="T:Yarn.Compiler.FunctionTypeBuilder"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.FunctionTypeBuilder.WithReturnType(Yarn.IType)">
|
|
<summary>
|
|
Sets the <see cref="P:Yarn.FunctionType.ReturnType"/> of the <see
|
|
cref="P:Yarn.Compiler.FunctionTypeBuilder.FunctionType"/>.
|
|
</summary>
|
|
<param name="returnType">The return type to apply to the
|
|
function.</param>
|
|
<returns>The <see cref="T:Yarn.Compiler.FunctionTypeBuilder"/> instance that
|
|
received this method call.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.FunctionTypeBuilder.WithParameter(Yarn.IType)">
|
|
<summary>
|
|
Adds a new parameter of type <paramref name="parameterType"/> to the
|
|
<see cref="P:Yarn.Compiler.FunctionTypeBuilder.FunctionType"/>.
|
|
</summary>
|
|
<param name="parameterType">The type of the new parameter to add to the function.</param>
|
|
<inheritdoc cref="M:Yarn.Compiler.FunctionTypeBuilder.WithReturnType(Yarn.IType)" path="/returns"/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.FunctionTypeBuilder.FromFunctionType(System.Type)">
|
|
<summary>
|
|
Creates a new <see cref="T:Yarn.Compiler.FunctionTypeBuilder"/> based on a delegate
|
|
type.
|
|
</summary>
|
|
<param name="type">The type of a delegate to produce a type builder
|
|
from. This type must be a delegate.</param>
|
|
<returns>
|
|
A newly created <see cref="T:Yarn.Compiler.FunctionTypeBuilder"/>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentException">Thrown when the provided
|
|
type is not a delegate or has invalid components.</exception>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.FunctionTypeBuilder.WithVariadicParameterType(Yarn.IType)">
|
|
<summary>
|
|
Sets the <see cref="P:Yarn.FunctionType.VariadicParameterType"/> of the
|
|
<see cref="P:Yarn.Compiler.FunctionTypeBuilder.FunctionType"/>.
|
|
</summary>
|
|
<param name="variadicParameterType">The variadic parameter type to
|
|
apply to the function.</param>
|
|
<returns>The <see cref="T:Yarn.Compiler.FunctionTypeBuilder"/> instance that
|
|
received this method call.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.ISourceInput">
|
|
<summary>
|
|
An input into a Yarn Spinner compilation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.ISourceInput.FileName">
|
|
<summary>
|
|
The name of the input.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.CompilationJob">
|
|
<summary>
|
|
An object that contains Yarn source code to compile, and instructions on
|
|
how to compile it.
|
|
</summary>
|
|
<remarks>
|
|
Instances of this struct are used with <see
|
|
cref="M:Yarn.Compiler.Compiler.Compile(Yarn.Compiler.CompilationJob)"/> to produce <see
|
|
cref="T:Yarn.Compiler.CompilationResult"/> objects.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.CompilationJob.File">
|
|
<summary>
|
|
Represents the contents of a file to compile.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationJob.File.FileName">
|
|
<summary>
|
|
The name of the file.
|
|
</summary>
|
|
<remarks>
|
|
This may be a full path, or just the filename or anything in
|
|
between. This is useful for diagnostics, and for attributing
|
|
<see cref="T:Yarn.Line"/> objects to their original source
|
|
files.</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.CompilationJob.File.Source">
|
|
<summary>
|
|
The source code of this file.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.CompilationJob.Type">
|
|
<summary>
|
|
The type of compilation that the compiler will do.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.CompilationJob.Type.FullCompilation">
|
|
<summary>The compiler will do a full compilation, and
|
|
generate a <see cref="T:Yarn.Program"/>, function declaration set,
|
|
and string table.</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.CompilationJob.Type.TypeCheck">
|
|
<summary>The compiler will derive only the variable and
|
|
function declarations, and file tags, found in the
|
|
script.</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.CompilationJob.Type.DeclarationsOnly">
|
|
<summary>Generate declarations only. This is equivalent to <see
|
|
cref="F:Yarn.Compiler.CompilationJob.Type.TypeCheck"/>.</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.CompilationJob.Type.StringsOnly">
|
|
<summary>The compiler will generate a string table
|
|
only.</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationJob.Files">
|
|
<summary>
|
|
The <see cref="T:Yarn.Compiler.CompilationJob.File"/> structs that represent the content to
|
|
parse..
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.CompilationJob.Library">
|
|
<summary>
|
|
The <see cref="F:Yarn.Compiler.CompilationJob.Library"/> that contains declarations for
|
|
functions.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.CompilationJob.CompilationType">
|
|
<summary>
|
|
The type of compilation to perform.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationJob.VariableDeclarations">
|
|
<summary>
|
|
The declarations for variables.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.CompilationJob.Declarations">
|
|
<summary>
|
|
The declarations for variables and functions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationJob.LanguageVersion">
|
|
<summary>
|
|
Gets or sets the version of the Yarn language.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationJob.TypeDeclarations">
|
|
<summary>
|
|
The collection of type declarations that should be imported and made
|
|
available to the compiler, prior to compilation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationJob.CancellationToken">
|
|
<summary>
|
|
A cancellation token that can be used to signal that the compilation
|
|
should be cancelled.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.CompilationJob.CreateFromFiles(System.Collections.Generic.IEnumerable{System.String},Yarn.Library)">
|
|
<summary>
|
|
Creates a new <see cref="T:Yarn.Compiler.CompilationJob"/> using the contents of a
|
|
collection of files.
|
|
</summary>
|
|
<param name="paths">The paths to the files.</param>
|
|
<param name="library">The <see cref="F:Yarn.Compiler.CompilationJob.Library"/> containing functions
|
|
to use for this compilation.</param>
|
|
<returns>A new <see cref="T:Yarn.Compiler.CompilationJob"/>.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.CompilationJob.CreateFromFiles(System.String[])">
|
|
<inheritdoc cref="M:Yarn.Compiler.CompilationJob.CreateFromFiles(System.Collections.Generic.IEnumerable{System.String},Yarn.Library)" path="/summary"/>
|
|
<inheritdoc cref="M:Yarn.Compiler.CompilationJob.CreateFromFiles(System.Collections.Generic.IEnumerable{System.String},Yarn.Library)" path="/param[@name='paths']"/>
|
|
<inheritdoc cref="M:Yarn.Compiler.CompilationJob.CreateFromFiles(System.Collections.Generic.IEnumerable{System.String},Yarn.Library)" path="/returns"/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.CompilationJob.CreateFromInputs(System.Collections.Generic.IEnumerable{Yarn.Compiler.ISourceInput},Yarn.Library,System.Int32)">
|
|
<summary>
|
|
Creates a new <see cref="T:Yarn.Compiler.CompilationJob"/> using the contents of a
|
|
collection of source inputs.
|
|
</summary>
|
|
<param name="inputs">The inputs to the compilation.</param>
|
|
<param name="library">The <see cref="F:Yarn.Compiler.CompilationJob.Library"/> containing functions
|
|
to use for this compilation.</param>
|
|
<returns>A new <see cref="T:Yarn.Compiler.CompilationJob"/>.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.CompilationJob.CreateFromString(System.String,System.String,Yarn.Library,System.Int32)">
|
|
<summary>
|
|
Creates a new <see cref="T:Yarn.Compiler.CompilationJob"/> using the contents of a
|
|
string.
|
|
</summary>
|
|
<param name="fileName">The name to assign to the compiled
|
|
file.</param>
|
|
<param name="source">The text to compile.</param>
|
|
<param name="library">Library of function definitions to use during
|
|
compilation.</param>
|
|
<param name="languageVersion">The version of the Yarn language to
|
|
use.</param>
|
|
<returns>A new <see cref="T:Yarn.Compiler.CompilationJob"/>.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.CompilationResult">
|
|
<summary>
|
|
The result of a compilation.
|
|
</summary>
|
|
<remarks>
|
|
Instances of this class are produced as a result of supplying a <see
|
|
cref="T:Yarn.Compiler.CompilationJob"/> to <see
|
|
cref="M:Yarn.Compiler.Compiler.Compile(Yarn.Compiler.CompilationJob)"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationResult.Program">
|
|
<summary>
|
|
Gets the compiled Yarn program that the <see cref="T:Yarn.Compiler.Compiler"/>
|
|
produced.
|
|
</summary>
|
|
<remarks>
|
|
<para>This value will be <see langword="null"/> if there were errors
|
|
in the compilation. If this is the case, <see cref="P:Yarn.Compiler.CompilationResult.Diagnostics"/>
|
|
will contain information describing the errors.</para>
|
|
<para>
|
|
It will also be <see langword="null"/> if the <see
|
|
cref="T:Yarn.Compiler.CompilationJob"/> object's <see
|
|
cref="F:Yarn.Compiler.CompilationJob.CompilationType"/> value was not <see
|
|
cref="F:Yarn.Compiler.CompilationJob.Type.FullCompilation"/>.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationResult.StringTable">
|
|
<summary>
|
|
Gets a dictionary mapping line IDs to StringInfo objects.
|
|
</summary>
|
|
<remarks>
|
|
The string table contains the extracted line text found in the
|
|
provided source code. The keys of this dictionary are the line IDs
|
|
for each line - either through explicit line tags indicated through
|
|
the <c>#line:</c> tag, or implicitly-generated line IDs that the
|
|
compiler added during compilation.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationResult.Declarations">
|
|
<summary>
|
|
Gets the collection of variable declarations that were found during
|
|
compilation.
|
|
</summary>
|
|
<remarks>
|
|
This value will be <see langword="null"/> if the <see
|
|
cref="T:Yarn.Compiler.CompilationJob"/> object's <see
|
|
cref="F:Yarn.Compiler.CompilationJob.CompilationType"/> value was not <see
|
|
cref="F:Yarn.Compiler.CompilationJob.Type.TypeCheck"/> or <see
|
|
cref="F:Yarn.Compiler.CompilationJob.Type.FullCompilation"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationResult.ContainsImplicitStringTags">
|
|
<summary>
|
|
Gets a value indicating whether the compiler had to create line IDs
|
|
for lines in the source code that lacked <c>#line:</c> tags.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
Every line is required to have a line ID. If a line doesn't have a
|
|
line ID specified in the source code (via a <c>#line:</c> tag), the
|
|
compiler will create one.
|
|
</para>
|
|
<para>
|
|
Implicit line IDs are guaranteed to remain the same between
|
|
compilations when the source file does not change. If you want line
|
|
IDs to remain the same when the source code may be modified in the
|
|
future, add a <c>#line:</c> tag to the line. This may be done by
|
|
hand, or added using the <see cref="M:Yarn.Compiler.Utility.AddTagsToLines(System.String,System.Collections.Generic.ICollection{System.String})"/> method.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationResult.FileTags">
|
|
<summary>
|
|
Gets the collection of file-level tags found in the source code.
|
|
</summary>
|
|
<remarks>The keys of this dictionary are the file names (as
|
|
indicated by the <see cref="P:Yarn.Compiler.CompilationJob.File.FileName"/> property
|
|
of the <see cref="T:Yarn.Compiler.CompilationJob"/>'s <see
|
|
cref="P:Yarn.Compiler.CompilationJob.Files"/> collection), and the values are the
|
|
file tags associated with that file.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationResult.Diagnostics">
|
|
<summary>
|
|
Gets the collection of <see cref="T:Yarn.Compiler.Diagnostic"/> objects that
|
|
describe problems in the source code.
|
|
</summary>
|
|
<remarks>
|
|
If the compiler encounters errors while compiling source code, the
|
|
<see cref="T:Yarn.Compiler.CompilationResult"/> it produces will have a <see
|
|
cref="P:Yarn.Compiler.CompilationResult.Program"/> value of <see langword="null"/>. To help figure out
|
|
what the error is, users should consult the contents of this
|
|
property.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationResult.ContainsErrors">
|
|
<summary>
|
|
Gets a value indicating whether this compilation result contains any
|
|
error diagnostics.
|
|
</summary>
|
|
<remarks>
|
|
If this value is true, then the value contained in <see
|
|
cref="P:Yarn.Compiler.CompilationResult.Program"/> will not contain a valid output.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationResult.DebugInfo">
|
|
<summary>
|
|
Gets the collection of <see cref="P:Yarn.Compiler.CompilationResult.DebugInfo"/> objects for each node
|
|
in <see cref="P:Yarn.Compiler.CompilationResult.Program"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationResult.ProjectDebugInfo">
|
|
<summary>
|
|
Gets the debugging information for this compiled project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationResult.UserDefinedTypes">
|
|
<summary>
|
|
Gets a collection of any types that were defined by the user in the
|
|
input (for example, user-defined enum types.)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.CompilationResult.GetDescriptionForVariable(System.String)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.CompilationResult.GetLabelsForNode(System.String)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.CompilationResult.GetStringForKey(System.String)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationResult.ParseResults">
|
|
<summary>
|
|
Contains the results of parsing each input of the compilation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.CompilationResult.NodeMetadata">
|
|
<summary>
|
|
contains metadata about all nodes extracted during compilation for use by language server features
|
|
includes information about jumps, function calls, commands, variables, character names, tags, and structural information
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.ContentIdentifierType.Line">
|
|
<summary>
|
|
The content identifier is a <c>#line:</c> tag.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.ContentIdentifierType.Shadow">
|
|
<summary>
|
|
The content identifier is a <c>#shadow:</c> tag.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Compiler">
|
|
<summary>
|
|
Compiles Yarn code.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Compiler.TypeSolverTimeLimit">
|
|
<summary>
|
|
The maximum amount of time the type solver will spend attempting to
|
|
complete the type solution, in seconds.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Compiler.Compile(Yarn.Compiler.CompilationJob)">
|
|
<summary>
|
|
Compiles Yarn code, as specified by a compilation job.
|
|
</summary>
|
|
<param name="compilationJob">The compilation job to perform.</param>
|
|
<returns>The results of the compilation.</returns>
|
|
<seealso cref="T:Yarn.Compiler.CompilationJob"/>
|
|
<seealso cref="T:Yarn.Compiler.CompilationResult"/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Compiler.GetContentViewedVariableName(System.String)">
|
|
<summary>
|
|
Gets the name of the boolean variable that stores whether the
|
|
content identified by lineID has been seen by the player before.
|
|
</summary>
|
|
<param name="lineID">The line ID to generate a variable name
|
|
for.</param>
|
|
<returns>A variable name.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Compiler.AddErrorsForInvalidNodeNames(System.Collections.Generic.List{Yarn.Compiler.FileParseResult},System.Collections.Generic.List{Yarn.Compiler.Diagnostic}@)">
|
|
<summary>
|
|
Checks every node name in <paramref name="parseResults"/>, and
|
|
ensure that they're all unique and valid. If there are duplicates or
|
|
invalid node names, create diagnostics for them.
|
|
</summary>
|
|
<param name="parseResults">A collection of file parse results to
|
|
check.</param>
|
|
<param name="diagnostics">A collection of diagnostics to add
|
|
to.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Compiler.GetDeclarationsFromLibrary(Yarn.Library)">
|
|
<summary>
|
|
Returns a collection of <see cref="T:Yarn.Compiler.Declaration"/> structs that
|
|
describe the functions present in <paramref name="library"/>.
|
|
</summary>
|
|
<param name="library">The <see cref="T:Yarn.Library"/> to get declarations
|
|
from.</param>
|
|
<returns>The <see cref="T:Yarn.Compiler.Declaration"/> structs found.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Compiler.GetTokensFromFile(System.String)">
|
|
<summary>
|
|
Reads the contents of a text file containing source code, and
|
|
returns a list of tokens found in that source code.
|
|
</summary>
|
|
<param name="path">The path of the file to load the source code
|
|
from.</param>
|
|
<inheritdoc cref="M:Yarn.Compiler.Compiler.GetTokensFromString(System.String)" path="/returns"/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Compiler.GetTokensFromString(System.String)">
|
|
<summary>
|
|
Reads a string containing source code, and returns a list of
|
|
tokens found in that source code.
|
|
</summary>
|
|
<param name="text">The source code to extract tokens
|
|
from.</param>
|
|
<returns>The list of tokens extracted from the source
|
|
code.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Compiler.GetHeadersWithKey(Yarn.Compiler.YarnSpinnerParser.NodeContext,System.String)">
|
|
<summary>
|
|
Finds all header parse contexts in the given node with the given key.
|
|
</summary>
|
|
<param name="nodeContext">The node context to search.</param>
|
|
<param name="name">The key to search for</param>
|
|
<returns>A collection of header contexts.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Compiler.Emit(Yarn.Node,Yarn.Compiler.NodeDebugInfo,Yarn.Compiler.Range,Yarn.Instruction)">
|
|
<summary>
|
|
Creates a new instruction, and appends it to a node in the <see
|
|
cref="T:Yarn.Program" />.
|
|
</summary>
|
|
<param name="node">The node to append instructions to.</param>
|
|
<param name="debugInfo">The <see cref="T:Yarn.Compiler.NodeDebugInfo"/> object to add
|
|
line debugging information to.</param>
|
|
<param name="range">The range of source code corresponding to this instruction.</param>
|
|
<param name="instruction">The instruction to add.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Compiler.GetContentIDTag(Yarn.Compiler.ContentIdentifierType,Yarn.Compiler.YarnSpinnerParser.HashtagContext[])">
|
|
<summary>
|
|
Extracts a line ID from a collection of <see
|
|
cref="T:Yarn.Compiler.YarnSpinnerParser.HashtagContext"/>s, if one exists.
|
|
</summary>
|
|
<param name="type">The type of content identifier tag to
|
|
retrieve.</param>
|
|
<param name="hashtagContexts">The hashtag parsing contexts.</param>
|
|
<returns>The line ID if one is present in the hashtag contexts,
|
|
otherwise <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Compiler.GetContentID(Yarn.Compiler.ContentIdentifierType,Yarn.Compiler.YarnSpinnerParser.Line_statementContext)">
|
|
<summary>
|
|
Gets a string containing the line ID from a line statement parser
|
|
context.
|
|
</summary>
|
|
<remarks>
|
|
The line ID is extracted from the <c>#line:</c> hashtag found on the
|
|
line. If it isn't present, then this method throws an exception.
|
|
</remarks>
|
|
<param name="type">The type of content identifier to retrieve.</param>
|
|
<param name="line">The line statement to extract the line ID
|
|
from.</param>
|
|
<returns>The line ID found in this line.</returns>
|
|
<exception cref="T:System.ArgumentException">Thrown when the line does not
|
|
have a line ID.</exception>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Compiler.GetLineIDForNodeName(System.String)">
|
|
<summary>
|
|
Generates a line id for a raw text node
|
|
</summary>
|
|
<remarks>
|
|
This should only be used when in raw text mode.
|
|
</remarks>
|
|
<param name="name">The name of the node</param>
|
|
<returns>line id for the raw text node</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Compiler.FlattenParseTree(Antlr4.Runtime.Tree.IParseTree)">
|
|
<summary>
|
|
Flattens a tree of <see cref="T:Antlr4.Runtime.Tree.IParseTree"/> objects by
|
|
recursively visiting their children, and converting them into a
|
|
flat <see cref="T:System.Collections.Generic.IEnumerable`1"/>.
|
|
</summary>
|
|
<param name="node">The root node to begin work from.</param>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains a
|
|
flattened version of the hierarchy rooted at <paramref
|
|
name="node"/>.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Compiler.GetDocumentComments(Antlr4.Runtime.CommonTokenStream,Antlr4.Runtime.ParserRuleContext,System.Boolean)">
|
|
<summary>
|
|
Gets the text of the documentation comments that either immediately
|
|
precede <paramref name="context"/>, or are on the same line as
|
|
<paramref name="context"/>.
|
|
</summary>
|
|
<remarks>
|
|
Documentation comments begin with a triple-slash (<c>///</c>), 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.
|
|
</remarks>
|
|
<param name="tokens">The token stream to search.</param>
|
|
<param name="context">The parser rule context to get documentation
|
|
comments for.</param>
|
|
<param name="allowCommentsAfter">If true, this method will search
|
|
for documentation comments that come after <paramref
|
|
name="context"/>'s last token and are on the same line.</param>
|
|
<returns>The text of the documentation comments, or <see
|
|
langword="null"/> if no documentation comments were
|
|
present.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser">
|
|
<summary>
|
|
Adds additional functionality to the <see cref="T:Yarn.Compiler.YarnSpinnerParser"/>
|
|
class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser.NodeContext">
|
|
<summary>
|
|
Adds additional functionality to the <see cref="T:Yarn.Compiler.YarnSpinnerParser.NodeContext"/>
|
|
class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.NodeContext.SourceFileName">
|
|
<summary>
|
|
Gets the path to the file that this node was parsed from, if any.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.NodeContext.NodeTitle">
|
|
<summary>
|
|
Gets the title of this node, as specified in its '<c>title</c>'
|
|
header. If it is not present, returns <see langword="null"/>. If
|
|
more than one is present, the first is returned.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.NodeContext.NodeGroup">
|
|
<summary>
|
|
Gets the name of the node group that this node is part of, if
|
|
any.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParser.NodeContext.GetHeader(System.String)">
|
|
<summary>
|
|
Gets the first header in this node named <paramref name="key"/>.
|
|
</summary>
|
|
<param name="key">The key of the header to find.</param>
|
|
<returns>A header whose <see cref="F:Yarn.Compiler.YarnSpinnerParser.HeaderContext.header_key"/>
|
|
is <paramref name="key"/>. </returns>
|
|
<remarks>
|
|
This method returns only the first header with the specified
|
|
key. To fetch all headers with this key, use <see
|
|
cref="M:Yarn.Compiler.YarnSpinnerParser.NodeContext.GetHeaders(System.String)"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParser.NodeContext.GetHeaders(System.String)">
|
|
<summary>
|
|
Gets all headers in this node named <paramref name="key"/>.
|
|
</summary>
|
|
<param name="key">The key of the header to find.</param>
|
|
<returns>A collection of headers whose <see cref="F:Yarn.Compiler.YarnSpinnerParser.HeaderContext.header_key"/>
|
|
is <paramref name="key"/>. </returns>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.NodeContext.ComplexityScore">
|
|
<summary>
|
|
Gets the computed total complexity of this node's 'when'
|
|
conditions.
|
|
</summary>
|
|
<remarks>
|
|
If this node has no such conditions, this value is -1.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParser.GetBooleanOperatorCountInExpression(Antlr4.Runtime.ParserRuleContext)">
|
|
<summary>
|
|
Gets the total number of binary boolean operations - ands, ors, and
|
|
xors - present in an expression and its sub-expressions.
|
|
</summary>
|
|
<param name="context">An expression.</param>
|
|
<returns>The total number of binary boolean operations in the
|
|
expression.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser.Line_conditionContext">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.Line_conditionContext.ConditionCount">
|
|
<summary>
|
|
Gets the complexity of this line's condition.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser.When_headerContext">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.When_headerContext.ComplexityScore">
|
|
<summary>
|
|
Gets the complexity of this line's condition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.Line_statementContext.LineID">
|
|
<summary>
|
|
Gets or sets the localised line ID associated with this line
|
|
statement.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.Line_statementContext.LineIDIsImplicit">
|
|
<summary>
|
|
Gets or sets a value indiciating whether the line ID was added
|
|
implicitly.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.Line_statementContext.ShadowLineID">
|
|
<summary>
|
|
Gets or sets the shadow line ID associated with this line
|
|
statement.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.Line_statementContext.IsLastLineBeforeOptions">
|
|
<summary>
|
|
Gets or sets a value indicating whether this line is the last
|
|
one before a group of options.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser.ExpressionContext">
|
|
<summary>
|
|
Adds type properties to <see cref="T:Yarn.Compiler.YarnSpinnerParser.ExpressionContext"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.ExpressionContext.Type">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser.ValueContext">
|
|
<summary>
|
|
Adds type properties to <see cref="T:Yarn.Compiler.YarnSpinnerParser.ValueContext"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.ValueContext.Type">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser.ValueNumberContext">
|
|
<summary>
|
|
A number literal value.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser.ValueTrueContext">
|
|
<summary>
|
|
A true boolean literal value.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser.ValueFalseContext">
|
|
<summary>
|
|
A false boolean literal value.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser.ValueStringContext">
|
|
<summary>
|
|
A string literal value.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser.VariableContext">
|
|
<summary>
|
|
Adds type properties to <see cref="T:Yarn.Compiler.YarnSpinnerParser.VariableContext"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.VariableContext.Type">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser.Function_callContext">
|
|
<summary>
|
|
Adds type properties to <see cref="T:Yarn.Compiler.YarnSpinnerParser.Function_callContext"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.Function_callContext.Type">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser.Enum_case_statementContext">
|
|
<summary>
|
|
Adds enum case type information to <see
|
|
cref="T:Yarn.Compiler.YarnSpinnerParser.Enum_case_statementContext"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.Enum_case_statementContext.RawValue">
|
|
<summary>
|
|
Gets or sets the 'raw value' of this enum case, which is the
|
|
underlying value that this enum represents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.Enum_case_statementContext.Description">
|
|
<summary>
|
|
Gets or sets the descriptive text for this enum case.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser.Once_primary_clauseContext">
|
|
<summary>
|
|
Adds 'once' variable information to <see
|
|
cref="T:Yarn.Compiler.YarnSpinnerParser.Once_primary_clauseContext"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.YarnSpinnerParser.Once_primary_clauseContext.OnceVariableName">
|
|
<summary>
|
|
The name of the variable that tracks whether once statement
|
|
primary clause has been seen before or not.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParser.ILiteralContext">
|
|
<summary>
|
|
Marks that a type represents a <see cref="T:Antlr4.Runtime.ParserRuleContext"/> that
|
|
represents a literal value.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.ProjectDebugInfo">
|
|
<summary>
|
|
Contains debugging information for compiled Yarn Projects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.ProjectDebugInfo.Nodes">
|
|
<summary>
|
|
The debugging info for the nodes in the project.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.ProjectDebugInfo.GetNodeDebugInfo(System.String)">
|
|
<summary>
|
|
Gets the debugging info for a given node, if it exists.
|
|
</summary>
|
|
<param name="nodeName">The name of the node to get debugging info
|
|
for.</param>
|
|
<returns>The debugging info for the node, or <see langword="null"/>
|
|
if none is present.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.NodeDebugInfo">
|
|
<summary>
|
|
Contains debug information for a node in a Yarn file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.NodeDebugInfo.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the NodeDebugInfo class.
|
|
</summary>
|
|
<param name="fileName">The file that the node was defined
|
|
in.</param>
|
|
<param name="nodeName">The name of the node.</param>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeDebugInfo.FileName">
|
|
<summary>
|
|
Gets or sets the file that this DebugInfo was produced from.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeDebugInfo.NodeName">
|
|
<summary>
|
|
Gets or sets the node that this DebugInfo was produced from.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeDebugInfo.LineRanges">
|
|
<summary>
|
|
Gets or sets the mapping of instruction numbers to <see
|
|
cref="P:Yarn.Compiler.NodeDebugInfo.Range"/> information in the file indicated by <see
|
|
cref="P:Yarn.Compiler.NodeDebugInfo.FileName"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeDebugInfo.Range">
|
|
<summary>
|
|
The range in the file in which the node appears.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeDebugInfo.IsImplicit">
|
|
<summary>
|
|
Gets or sets a value indicating whether this node was created by the
|
|
compiler.
|
|
</summary>
|
|
<remarks>
|
|
Nodes that exist in a .yarn file have an <see cref="P:Yarn.Compiler.NodeDebugInfo.IsImplicit"/>
|
|
value of <see langword="false"/>. Nodes that are generated by the
|
|
compiler include smart variable implementations, and node group
|
|
'hub' nodes.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.NodeDebugInfo.GetLineInfo(System.Int32)">
|
|
<summary>
|
|
Gets a <see cref="T:Yarn.Compiler.NodeDebugInfo.LineInfo"/> object that describes the specified
|
|
instruction at the index <paramref name="instructionNumber"/>.
|
|
</summary>
|
|
<param name="instructionNumber">The index of the instruction to
|
|
retrieve information for.</param>
|
|
<returns>A <see cref="T:Yarn.Compiler.NodeDebugInfo.LineInfo"/> object that describes the position
|
|
of the instruction.</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref
|
|
name="instructionNumber"/> is less than zero, or greater than the
|
|
number of instructions present in the node.</exception>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.NodeDebugInfo.LineInfo">
|
|
<summary>
|
|
Contains positional information about an instruction.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.NodeDebugInfo.LineInfo.FileName">
|
|
<summary>
|
|
The file name of the source that this instruction was produced
|
|
from.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.NodeDebugInfo.LineInfo.NodeName">
|
|
<summary>
|
|
The node name of the source that this instruction was produced
|
|
from.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.NodeDebugInfo.LineInfo.Range">
|
|
<summary>
|
|
The range in <see cref="F:Yarn.Compiler.NodeDebugInfo.LineInfo.FileName"/> that contains the
|
|
statement or expression that this line was produced from.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Range">
|
|
<summary>
|
|
Represents a range of text in a multi-line string.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Range.InvalidRange">
|
|
<summary>
|
|
Represents the default value for a Range.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Range.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Yarn.Compiler.Range"/> class, given
|
|
start and end information.
|
|
</summary>
|
|
<param name="startLine">The zero-indexed line number of the start of
|
|
the range.</param>
|
|
<param name="startCharacter">The zero-indexed character number of
|
|
the start of the range.</param>
|
|
<param name="endLine">The zero-indexed line number of the end of the
|
|
range.</param>
|
|
<param name="endCharacter">The zero-indexed character number of the
|
|
end of the range.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Range.#ctor(Yarn.Compiler.Position,Yarn.Compiler.Position)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Yarn.Compiler.Range"/> class, given
|
|
start and end information.
|
|
</summary>
|
|
<param name="startPosition">The position at the start of
|
|
the range.</param>
|
|
<param name="endPosition">The position at the end of
|
|
the range.</param>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Range.Start">
|
|
<summary>
|
|
Gets or sets the start position of this range.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Range.End">
|
|
<summary>
|
|
Gets or sets the end position of this range.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Range.Equals(System.Object)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Range.GetHashCode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Range.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Range.IsValid">
|
|
<summary>
|
|
Gets a value indicating whether this range is valid.
|
|
</summary>
|
|
<remarks>
|
|
A range is valid when its start and end positions are both valid,
|
|
and the start position is not after the end position.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Position">
|
|
<summary>
|
|
Represents a position in a multi-line string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Position.Line">
|
|
<summary>
|
|
Gets or sets the zero-indexed line of this position.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Position.Character">
|
|
<summary>
|
|
Gets or sets the zero-indexed character number of this position.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Position.IsValid">
|
|
<summary>
|
|
Gets a value indicating whether this position has a zero or positive
|
|
line and character number.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Position.InvalidPosition">
|
|
<summary>
|
|
Represents the default value for a Position.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Position.#ctor(System.Int32,System.Int32)">
|
|
<summary>
|
|
Initialises a new instance of the Position class with the specified
|
|
line and character.
|
|
</summary>
|
|
<param name="line">The zero-indexed line number.</param>
|
|
<param name="character">The zero-index character number.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Position.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the Position class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Position.Equals(System.Object)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Position.GetHashCode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Position.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Position.op_GreaterThanOrEqual(Yarn.Compiler.Position,Yarn.Compiler.Position)">
|
|
<summary>
|
|
Compares two positions and returns true if <paramref name="a"/> is
|
|
equal to or after <paramref name="b"/>.
|
|
</summary>
|
|
<param name="a">The first position.</param>
|
|
<param name="b">The second position.</param>
|
|
<returns>true if a is after or equal to b; false
|
|
otherwise.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Position.op_LessThanOrEqual(Yarn.Compiler.Position,Yarn.Compiler.Position)">
|
|
<summary>
|
|
Compares two positions and returns true if <paramref name="a"/> is
|
|
equal to or before <paramref name="b"/>.
|
|
</summary>
|
|
<param name="a">The first position.</param>
|
|
<param name="b">The second position.</param>
|
|
<returns>true if a is before or equal to b; false
|
|
otherwise.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Position.op_Addition(Yarn.Compiler.Position,Yarn.Compiler.Position)">
|
|
<summary>
|
|
Adds two positions by component and returns the result.
|
|
</summary>
|
|
<param name="a">The first position.</param>
|
|
<param name="b">The second position.</param>
|
|
<returns>The resulting combined position.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Declaration">
|
|
<summary>
|
|
Represents a variable declaration
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Declaration.Name">
|
|
<summary>
|
|
Gets the name of this Declaration.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Declaration.CreateVariable(System.String,Yarn.IType,System.IConvertible,System.String)">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:Yarn.Compiler.Declaration"/> class,
|
|
using the given name, type and default value.
|
|
</summary>
|
|
<param name="name">The name of the new declaration.</param>
|
|
<param name="type">The type of the declaration.</param>
|
|
<param name="defaultValue">The default value of the
|
|
declaration. This must be a string, a number (integer or
|
|
floating-point), or boolean value.</param>
|
|
<param name="description">The description of the new
|
|
declaration.</param>
|
|
<returns>A new instance of the <see cref="T:Yarn.Compiler.Declaration"/>
|
|
class.</returns>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Declaration.DefaultValue">
|
|
<summary>
|
|
Gets the default value of this <see cref="T:Yarn.Compiler.Declaration"/>, if no
|
|
value has been specified in code or is available from a <see
|
|
cref="T:Yarn.Dialogue"/>'s <see cref="T:Yarn.IVariableStorage"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Declaration.Description">
|
|
<summary>
|
|
Gets a string describing the purpose of this <see
|
|
cref="T:Yarn.Compiler.Declaration"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Declaration.SourceFileName">
|
|
<summary>
|
|
Gets the name of the file in which this Declaration was found.
|
|
</summary>
|
|
<remarks>
|
|
If this <see cref="T:Yarn.Compiler.Declaration"/> was not found in a Yarn
|
|
source file, this will be <see cref="F:Yarn.Compiler.Declaration.ExternalDeclaration"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Declaration.SourceNodeName">
|
|
<summary>
|
|
Gets the name of the node in which this Declaration was found.
|
|
</summary>
|
|
<remarks>
|
|
If this <see cref="T:Yarn.Compiler.Declaration"/> was not found in a Yarn
|
|
source file, this will be <see langword="null"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Declaration.SourceFileLine">
|
|
<summary>
|
|
Gets the line number at which this Declaration was found in the
|
|
source file.
|
|
</summary>
|
|
<remarks>
|
|
If this <see cref="T:Yarn.Compiler.Declaration"/> was not found in a Yarn
|
|
source file, this will be -1.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Declaration.IsInlineExpansion">
|
|
<summary>
|
|
Gets a value indicating that this Declaration does not refer to a
|
|
stored variable, and instead represents an inline-expanded
|
|
expression (a 'smart variable').
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Declaration.IsImplicit">
|
|
<summary>
|
|
Gets a value indicating whether this Declaration was implicitly
|
|
inferred from usage.
|
|
</summary>
|
|
<value>If <see langword="true"/>, this Declaration was implicitly
|
|
inferred from usage. If <see langword="false"/>, this Declaration
|
|
appears in the source code.</value>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Declaration.Type">
|
|
<summary>
|
|
Gets the type of the variable, as represented by an object that
|
|
implements <see cref="T:Yarn.IType"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Declaration.ExternalDeclaration">
|
|
<summary>
|
|
The string used for <see cref="P:Yarn.Compiler.Declaration.SourceFileName"/> if the
|
|
Declaration was found outside of a Yarn source file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Declaration.Range">
|
|
<summary>
|
|
Gets the range of text at which this declaration occurs.
|
|
</summary>
|
|
<remarks>
|
|
This range refers to the declaration of the symbol itself, and not
|
|
any syntax surrounding it. For example, the declaration
|
|
<c><<declare $x = 1>></c> would have a Range referring
|
|
to the <c>$x</c> symbol.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Declaration.InitialValueParserContext">
|
|
<summary>
|
|
Gets or sets the parser context for the initial value provided in
|
|
this variable's 'declare' statement, if any. This is only valid for
|
|
variable declarations, not functions (because functions don't have a
|
|
value.)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Declaration.Dependents">
|
|
<summary>
|
|
Gets the collection of <see cref="T:Yarn.Compiler.Declaration"/> objects whose value
|
|
depends upon this <see cref="T:Yarn.Compiler.Declaration"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Declaration.Dependencies">
|
|
<summary>
|
|
Gets the collection of <see cref="T:Yarn.Compiler.Declaration"/> objects that this
|
|
<see cref="T:Yarn.Compiler.Declaration"/> depends upon the value of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Declaration.IsVariable">
|
|
<summary>
|
|
Gets a value indicating whether this Declaration represents a
|
|
variable, and not a function.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Declaration.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.DiagnosticDescriptor">
|
|
<summary>
|
|
Describes a diagnostic message with a unique code and template.
|
|
</summary>
|
|
<remarks>
|
|
This class ensures that diagnostic codes and their descriptions
|
|
are always paired correctly, preventing typos and mismatches.
|
|
All diagnostics should be created using the predefined descriptors
|
|
in this class.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.DiagnosticDescriptor.Code">
|
|
<summary>
|
|
Gets the unique error code for this diagnostic (e.g., "YS0001").
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.DiagnosticDescriptor.MessageTemplate">
|
|
<summary>
|
|
Gets the message template for this diagnostic.
|
|
</summary>
|
|
<remarks>
|
|
The template may contain placeholders like {0}, {1}, etc. for
|
|
string formatting.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.DiagnosticDescriptor.DefaultSeverity">
|
|
<summary>
|
|
Gets the default severity for this diagnostic.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.DiagnosticDescriptor.Description">
|
|
<summary>
|
|
Gets a brief description of what this diagnostic means.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.DiagnosticDescriptor.Create(System.String,System.String[])">
|
|
<summary>
|
|
Creates a new Diagnostic using this descriptor.
|
|
</summary>
|
|
<param name="sourceFile">The name of the file in which this error
|
|
occurred.</param>
|
|
<param name="args">The arguments to use when composing the
|
|
diagnostic's message.</param>
|
|
<returns>The diagnostic.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.DiagnosticDescriptor.Create(System.String,Antlr4.Runtime.ParserRuleContext,System.String[])">
|
|
<summary>
|
|
Creates a new Diagnostic using this descriptor.
|
|
</summary>
|
|
<param name="sourceFile">The name of the file in which this error
|
|
occurred.</param>
|
|
<param name="context">The parse context associated with this error.</param>
|
|
<param name="args">The arguments to use when composing the
|
|
diagnostic's message.</param>
|
|
<returns>The diagnostic.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.DiagnosticDescriptor.Create(System.String,Antlr4.Runtime.IToken,System.String[])">
|
|
<summary>
|
|
Creates a new Diagnostic using this descriptor.
|
|
</summary>
|
|
<param name="sourceFile">The name of the file in which this error
|
|
occurred.</param>
|
|
<param name="token">The token associated with this error.</param>
|
|
<param name="args">The arguments to use when composing the
|
|
diagnostic's message.</param>
|
|
<returns>The diagnostic.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.DiagnosticDescriptor.Create(System.String,Yarn.Compiler.Range,System.String[])">
|
|
<summary>
|
|
Creates a new Diagnostic using this descriptor.
|
|
</summary>
|
|
<param name="sourceFile">The name of the file in which this error
|
|
occurred.</param>
|
|
<param name="range">The range of the file associated with this error.</param>
|
|
<param name="args">The arguments to use when composing the
|
|
diagnostic's message.</param>
|
|
<returns>The diagnostic.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.DiagnosticDescriptor.FormatMessage(System.Object[])">
|
|
<summary>
|
|
Formats the message template with the provided arguments.
|
|
</summary>
|
|
<param name="args">Arguments to format the message template with.</param>
|
|
<returns>The formatted message.</returns>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.ImplicitVariableTypeConflict">
|
|
<summary>
|
|
YS0001: A variable has been implicitly declared with multiple conflicting types.
|
|
</summary>
|
|
<remarks>
|
|
<para>This error occurs when a variable is used with different types across
|
|
different files or contexts without an explicit declaration, and the
|
|
compiler cannot determine which type is correct.</para>
|
|
<para>Format placeholders: 0: variable name, 1: type names.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.TypeMismatch">
|
|
<summary>
|
|
YS0002: A type mismatch occurred during type checking.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: expected type, 1: actual type.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.UndefinedVariable">
|
|
<summary>
|
|
YS0003: An undefined variable was referenced.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: variable name.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.MissingDelimiter">
|
|
<summary>
|
|
YS0004: Missing node delimiter (=== or ---).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.SyntaxError">
|
|
<summary>
|
|
YS0005: Malformed dialogue or syntax error.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: specific syntax error message.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.UnclosedCommand">
|
|
<summary>
|
|
YS0006: Unclosed command (missing >>).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.UnclosedScope">
|
|
<summary>
|
|
YS0007: Unclosed control flow scope (missing endif, endonce, etc.).
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: missing token.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.UnreachableCode">
|
|
<summary>
|
|
YS0008: Unreachable code detected.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.UnusedVariable">
|
|
<summary>
|
|
YS0010: Variable is declared but never used.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: variable name.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.DuplicateNodeTitle">
|
|
<summary>
|
|
YS0011: Duplicate node title.
|
|
</summary>
|
|
<remarks>
|
|
<para>This diagnostic is not emitted for node groups where nodes
|
|
share a title but have different `when:` clauses.</para>
|
|
<para>Format placeholders: 0: node title.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.UndefinedNode">
|
|
<summary>
|
|
YS0012: Jump to undefined node.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: node title.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.InvalidFunctionCall">
|
|
<summary>
|
|
YS0013: Invalid function call.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: function name.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.InvalidCommand">
|
|
<summary>
|
|
YS0014: Invalid command.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: command name</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.CyclicDependency">
|
|
<summary>
|
|
YS0015: Cyclic dependency detected.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: error message.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.UnknownCharacter">
|
|
<summary>
|
|
YS0016: Unknown character name.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: character name.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.LinesCantHaveLineAndShadowTag">
|
|
<summary>
|
|
YS0017: Lines cannot have both a '#line' tag and a '#shadow' tag.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.DuplicateLineID">
|
|
<summary>
|
|
YS0018: Lines cannot have both a '#line' tag and a '#shadow' tag.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: line ID.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.LineContentAfterCommand">
|
|
<summary>
|
|
YS0019: Line content after a non-flow-control command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.LineContentBeforeCommand">
|
|
<summary>
|
|
YS0020: Line content before a non-flow-control command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.StrayCommandEnd">
|
|
<summary>
|
|
YS0021: Stray command end marker without matching start marker.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.UnenclosedCommand">
|
|
<summary>
|
|
YS0022: Command keyword outside of command block.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.InvalidNodeName">
|
|
<summary>
|
|
YS0027: Node title or subtitle contains invalid characters.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: "title" or "subtitle", 1: the invalid name.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.RedeclarationOfExistingVariable">
|
|
<summary>
|
|
YS0039: Redeclaration of existing variable
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: variable name.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.RedeclarationOfExistingType">
|
|
<summary>
|
|
YS0040: Redeclaration of existing type
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: type name.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.InternalError">
|
|
<summary>
|
|
YS0041: Internal error.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: error description.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.UnknownLineIDForShadowLine">
|
|
<summary>
|
|
YS0042: Unknown line ID {0} for shadow line.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: line ID.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.ShadowLinesCantHaveExpressions">
|
|
<summary>
|
|
YS0043: Shadow lines must not have expressions
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.ShadowLinesMustHaveSameTextAsSource">
|
|
<summary>
|
|
YS0044: Shadow lines must have the same text as their source
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.SmartVariableLoop">
|
|
<summary>
|
|
YS0045: Smart variables cannot contain reference loops.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: variable reference, 1: smart variable name.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.NullDefaultValue">
|
|
<summary>
|
|
YS0046: Variable declaration has a null default value.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: variable name, 1: type name.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.TypeSolverTimeout">
|
|
<summary>
|
|
YS0047: Expression failed to resolve in a reasonable time.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: time limit in seconds.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.TypeInferenceFailure">
|
|
<summary>
|
|
YS0028: Can't determine type of variable given its usage.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: variable name.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.ExpressionTypeUndetermined">
|
|
<summary>
|
|
YS0029: Can't determine the type of an expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.SmartVariableReadOnly">
|
|
<summary>
|
|
YS0030: Smart variable cannot be modified.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: variable name.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.NodeGroupMissingWhen">
|
|
<summary>
|
|
YS0031: All nodes in a group must have a 'when' clause.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: node group title.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.DuplicateSubtitle">
|
|
<summary>
|
|
YS0032: Duplicate subtitle in a node group.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: group name, 1: subtitle.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.EmptyNode">
|
|
<summary>
|
|
YS0033: Node is empty and will not be compiled.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: node title.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.InvalidLibraryFunction">
|
|
<summary>
|
|
YS0034: Function cannot be used in Yarn Spinner scripts.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: function name, 1: reason.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.EnumDeclarationError">
|
|
<summary>
|
|
YS0035: Enum declaration error.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: error message.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.LanguageVersionTooLow">
|
|
<summary>
|
|
YS0036: Language version too low for feature.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: error message.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.InvalidLiteralValue">
|
|
<summary>
|
|
YS0037: Invalid literal value.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: error message.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.DiagnosticDescriptor.InvalidMemberAccess">
|
|
<summary>
|
|
YS0038: Invalid member access.
|
|
</summary>
|
|
<remarks>
|
|
<para>Format placeholders: 0: error message.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.DiagnosticDescriptor.GetDescriptor(System.String)">
|
|
<summary>
|
|
Gets a diagnostic descriptor by its code.
|
|
</summary>
|
|
<param name="code">The diagnostic code to look up.</param>
|
|
<returns>The descriptor, or null if not found.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Diagnostic">
|
|
<summary>
|
|
A diagnostic message that describes an error, warning or informational
|
|
message that the user can take action on.
|
|
</summary>
|
|
<remarks>
|
|
Diagnostics are presented to the user as the result of compilation,
|
|
through the <see cref="T:Yarn.Compiler.CompilationResult"/> class's <see
|
|
cref="P:Yarn.Compiler.CompilationResult.Diagnostics"/> property.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Diagnostic.FileName">
|
|
<summary>
|
|
Gets or sets the path, URI or file-name that the issue occurred in.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Diagnostic.Range">
|
|
<summary>
|
|
Gets or sets the range of the file indicated by <see
|
|
cref="P:Yarn.Compiler.Diagnostic.FileName"/> that the issue occurred in.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Diagnostic.Message">
|
|
<summary>
|
|
Gets or sets the description of the issue.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Diagnostic.Context">
|
|
<summary>
|
|
Gets or sets the source text of <see cref="P:Yarn.Compiler.Diagnostic.FileName"/> containing
|
|
the issue.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Diagnostic.Severity">
|
|
<summary>
|
|
Gets or sets the severity of the issue.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Diagnostic.Code">
|
|
<summary>
|
|
Gets or sets the error code for this diagnostic.
|
|
</summary>
|
|
<remarks>
|
|
Error codes help users look up documentation and categorize issues.
|
|
Follows the format YS0001, YS0002, etc.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Diagnostic.Line">
|
|
<summary>
|
|
Gets the zero-indexed line number in FileName at which the issue
|
|
begins.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Diagnostic.Column">
|
|
<summary>
|
|
Gets the zero-indexed character number in FileName at which the
|
|
issue begins.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Diagnostic.#ctor(System.String,System.String,Yarn.Compiler.Diagnostic.DiagnosticSeverity)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Yarn.Compiler.Diagnostic"/> class.
|
|
</summary>
|
|
<param name="fileName"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.FileName"
|
|
path="/summary/node()"/></param>
|
|
<param name="message"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.Message"
|
|
path="/summary/node()"/></param>
|
|
<param name="severity"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.Severity"
|
|
path="/summary/node()"/></param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Diagnostic.#ctor(System.String,Yarn.Compiler.Diagnostic.DiagnosticSeverity)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Yarn.Compiler.Diagnostic"/> class.
|
|
</summary>
|
|
<param name="message"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.Message"
|
|
path="/summary/node()"/></param>
|
|
<param name="severity"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.Severity"
|
|
path="/summary/node()"/></param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Diagnostic.#ctor(System.String,Antlr4.Runtime.ParserRuleContext,System.String,Yarn.Compiler.Diagnostic.DiagnosticSeverity)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Yarn.Compiler.Diagnostic"/> class.
|
|
</summary>
|
|
<param name="fileName"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.FileName"
|
|
path="/summary/node()"/></param>
|
|
<param name="context">The parse node at which the error
|
|
occurred.</param>
|
|
<param name="message"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.Message"
|
|
path="/summary/node()"/></param>
|
|
<param name="severity"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.Severity"
|
|
path="/summary/node()"/></param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Diagnostic.#ctor(System.String,Antlr4.Runtime.IToken,System.String,Yarn.Compiler.Diagnostic.DiagnosticSeverity)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Yarn.Compiler.Diagnostic"/> class.
|
|
</summary>
|
|
<param name="fileName"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.FileName"
|
|
path="/summary/node()"/></param>
|
|
<param name="token">The token at which the error
|
|
occurred.</param>
|
|
<param name="message"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.Message"
|
|
path="/summary/node()"/></param>
|
|
<param name="severity"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.Severity"
|
|
path="/summary/node()"/></param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Diagnostic.#ctor(System.String,Yarn.Compiler.Range,System.String,Yarn.Compiler.Diagnostic.DiagnosticSeverity)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Yarn.Compiler.Diagnostic"/> class.
|
|
</summary>
|
|
<param name="fileName"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.FileName"
|
|
path="/summary/node()"/></param>
|
|
<param name="range"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.Range"
|
|
path="/summary/node()"/></param>
|
|
<param name="message"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.Message"
|
|
path="/summary/node()"/></param>
|
|
<param name="severity"><inheritdoc cref="P:Yarn.Compiler.Diagnostic.Severity"
|
|
path="/summary/node()"/></param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Diagnostic.CreateDiagnostic(System.String,Yarn.Compiler.DiagnosticDescriptor,System.Object[])">
|
|
<summary>
|
|
Creates a new <see cref="T:Yarn.Compiler.Diagnostic"/> using a <see cref="T:Yarn.Compiler.DiagnosticDescriptor"/>.
|
|
</summary>
|
|
<param name="fileName">The file where the diagnostic occurred.</param>
|
|
<param name="descriptor">The diagnostic descriptor defining the error code and message template.</param>
|
|
<param name="args">Arguments to format the message template.</param>
|
|
<returns>A new diagnostic instance.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Diagnostic.CreateDiagnostic(System.String,Yarn.Compiler.Range,Yarn.Compiler.DiagnosticDescriptor,System.Object[])">
|
|
<summary>
|
|
Creates a new <see cref="T:Yarn.Compiler.Diagnostic"/> using a <see cref="T:Yarn.Compiler.DiagnosticDescriptor"/> with range information.
|
|
</summary>
|
|
<param name="fileName">The file where the diagnostic occurred.</param>
|
|
<param name="range">The range in the file where the diagnostic occurred.</param>
|
|
<param name="descriptor">The diagnostic descriptor defining the error code and message template.</param>
|
|
<param name="args">Arguments to format the message template.</param>
|
|
<returns>A new diagnostic instance.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Diagnostic.CreateDiagnostic(System.String,Antlr4.Runtime.ParserRuleContext,Yarn.Compiler.DiagnosticDescriptor,System.Object[])">
|
|
<summary>
|
|
Creates a new <see cref="T:Yarn.Compiler.Diagnostic"/> using a <see cref="T:Yarn.Compiler.DiagnosticDescriptor"/> with parser context.
|
|
</summary>
|
|
<param name="fileName">The file where the diagnostic occurred.</param>
|
|
<param name="context">The parser context where the diagnostic occurred.</param>
|
|
<param name="descriptor">The diagnostic descriptor defining the error code and message template.</param>
|
|
<param name="args">Arguments to format the message template.</param>
|
|
<returns>A new diagnostic instance.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Diagnostic.CreateDiagnostic(System.String,Antlr4.Runtime.IToken,Yarn.Compiler.DiagnosticDescriptor,System.Object[])">
|
|
<summary>
|
|
Creates a new <see cref="T:Yarn.Compiler.Diagnostic"/> using a <see cref="T:Yarn.Compiler.DiagnosticDescriptor"/> with token information.
|
|
</summary>
|
|
<param name="fileName">The file where the diagnostic occurred.</param>
|
|
<param name="token">The token where the diagnostic occurred.</param>
|
|
<param name="descriptor">The diagnostic descriptor defining the error code and message template.</param>
|
|
<param name="args">Arguments to format the message template.</param>
|
|
<returns>A new diagnostic instance.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Diagnostic.DiagnosticSeverity">
|
|
<summary>
|
|
The severity of the issue.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Diagnostic.DiagnosticSeverity.Info">
|
|
<summary>
|
|
An informational diagnostic.
|
|
</summary>
|
|
<remarks>
|
|
Infos represent possible issues or steps that the user may wish
|
|
to fix, but are unlikely to cause problems.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Diagnostic.DiagnosticSeverity.Warning">
|
|
<summary>
|
|
A warning.
|
|
</summary>
|
|
<remarks>
|
|
Warnings represent possible problems that the user should fix,
|
|
but do not cause the compilation process to fail.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Diagnostic.DiagnosticSeverity.Error">
|
|
<summary>
|
|
An error.
|
|
</summary>
|
|
<remarks>
|
|
If a Yarn source file contains errors, it cannot be compiled,
|
|
and the compilation process will fail.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Diagnostic.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Diagnostic.Equals(System.Object)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Diagnostic.GetHashCode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.ParserErrorListener.CategorizeParserError(System.String)">
|
|
<summary>
|
|
Categorizes parser errors from ANTLR messages and assigns appropriate error codes
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.FileCompiler">
|
|
<summary>
|
|
An <see cref="T:Yarn.Compiler.ICodeEmitter"/> that generates code for a parsed file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.FileCompiler.CurrentNode">
|
|
<summary>
|
|
Gets the current node to which instructions are being added.
|
|
</summary>
|
|
<value>The current node.</value>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.FileCompiler.CurrentNodeDebugInfo">
|
|
<summary>
|
|
Gets the current debug information that describes <see
|
|
cref="P:Yarn.Compiler.FileCompiler.CurrentNode"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.FileCompiler.VariableDeclarations">
|
|
<summary>
|
|
The collection of variable declarations known to the compiler.
|
|
</summary>
|
|
<remarks>
|
|
This is supplied as part of a <see cref="T:Yarn.Compiler.CompilationJob"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.FileCompiler.Library">
|
|
<summary>
|
|
The Library, which contains the function declarations known to the
|
|
compiler.
|
|
</summary>
|
|
<remarks>
|
|
This is supplied as part of a <see cref="T:Yarn.Compiler.CompilationJob"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.FileCompiler.#ctor(Yarn.Compiler.FileCompiler.CompilationContext)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Yarn.Compiler.Compiler"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.FileCompiler.Emit(Antlr4.Runtime.IToken,Antlr4.Runtime.IToken,Yarn.Instruction)">
|
|
<summary>
|
|
Adds the specified instruction it to the current node in the <see
|
|
cref="T:Yarn.Program"/>, and associates it with the position of <paramref
|
|
name="startToken"/>.
|
|
</summary>
|
|
<remarks>
|
|
Called by instances of <see cref="T:Yarn.Compiler.CodeGenerationVisitor"/> while
|
|
walking the parse tree.
|
|
</remarks>
|
|
<param name="startToken">The first token in the expression or
|
|
statement that was responsible for emitting this
|
|
instruction.</param>
|
|
<param name="endToken">The last token in the expression or
|
|
statement that was responsible for emitting this
|
|
instruction.</param>
|
|
<param name="instruction">The instruction to emit.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.FileCompiler.EnterNode(Yarn.Compiler.YarnSpinnerParser.NodeContext)">
|
|
<summary>
|
|
We have found a new node. Set up the currentNode var ready to hold
|
|
it, and otherwise continue.
|
|
</summary>
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.FileCompiler.ExitNode(Yarn.Compiler.YarnSpinnerParser.NodeContext)">
|
|
<summary>
|
|
We have left the current node. Store it into the program, wipe the
|
|
var, and make it ready to go again.
|
|
</summary>
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Yarn.Compiler.FileCompiler.ExitHeader(Yarn.Compiler.YarnSpinnerParser.HeaderContext)">
|
|
<summary>
|
|
We have finished with the header, so we're about to enter the node
|
|
body, and all its statements. Do the initial setup required before
|
|
compiling.
|
|
</summary>
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Yarn.Compiler.FileCompiler.EnterBody(Yarn.Compiler.YarnSpinnerParser.BodyContext)">
|
|
<summary>
|
|
Have entered the body. The header should have finished being parsed,
|
|
and the currentNode is ready. All we do is set up a body visitor and
|
|
tell it to run through all the statements. It handles everything
|
|
from that point onwards.
|
|
</summary>
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Yarn.Compiler.FileCompiler.ExitBody(Yarn.Compiler.YarnSpinnerParser.BodyContext)">
|
|
<summary>
|
|
Closes off the node.
|
|
</summary>
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Yarn.Compiler.FileParseResult">
|
|
<summary>
|
|
Contains the result of parsing a single file of source code.
|
|
</summary>
|
|
<remarks>
|
|
This class provides only syntactic information about a parse - that is,
|
|
it provides access to the parse tree, and the stream of tokens used to
|
|
produce that parse tree.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.FileParseResult.Name">
|
|
<summary>
|
|
<inheritdoc cref="M:Yarn.Compiler.FileParseResult.#ctor(System.String,Antlr4.Runtime.Tree.IParseTree,Antlr4.Runtime.CommonTokenStream,System.Collections.Generic.IEnumerable{Yarn.Compiler.Diagnostic})" path="/param[@name='name']"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.FileParseResult.FileName">
|
|
<inheritdoc/>>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.FileParseResult.Tree">
|
|
<summary>
|
|
<inheritdoc cref="M:Yarn.Compiler.FileParseResult.#ctor(System.String,Antlr4.Runtime.Tree.IParseTree,Antlr4.Runtime.CommonTokenStream,System.Collections.Generic.IEnumerable{Yarn.Compiler.Diagnostic})" path="/param[@name='tree']"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.FileParseResult.Tokens">
|
|
<summary>
|
|
<inheritdoc cref="M:Yarn.Compiler.FileParseResult.#ctor(System.String,Antlr4.Runtime.Tree.IParseTree,Antlr4.Runtime.CommonTokenStream,System.Collections.Generic.IEnumerable{Yarn.Compiler.Diagnostic})" path="/param[@name='tokens']"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.FileParseResult.Diagnostics">
|
|
<summary>
|
|
<inheritdoc cref="M:Yarn.Compiler.FileParseResult.#ctor(System.String,Antlr4.Runtime.Tree.IParseTree,Antlr4.Runtime.CommonTokenStream,System.Collections.Generic.IEnumerable{Yarn.Compiler.Diagnostic})" path="/param[@name='tokens']"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.FileParseResult.#ctor(System.String,Antlr4.Runtime.Tree.IParseTree,Antlr4.Runtime.CommonTokenStream,System.Collections.Generic.IEnumerable{Yarn.Compiler.Diagnostic})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Yarn.Compiler.FileParseResult"/>
|
|
struct.
|
|
</summary>
|
|
<param name="name">The name of the file.</param>
|
|
<param name="tree">The parse tree extracted from the file.</param>
|
|
<param name="tokens">The tokens extracted from the file.</param>
|
|
<param name="diagnostics">The diagnostics produced from parsing the file.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.FileParseResult.Equals(System.Object)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.FileParseResult.GetHashCode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParserBaseListener">
|
|
<summary>
|
|
This class provides an empty implementation of <see cref="T:Yarn.Compiler.IYarnSpinnerParserListener"/>,
|
|
which can be extended to create a listener which only needs to handle a subset
|
|
of the available methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterDialogue(Yarn.Compiler.YarnSpinnerParser.DialogueContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.dialogue"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitDialogue(Yarn.Compiler.YarnSpinnerParser.DialogueContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.dialogue"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterFile_hashtag(Yarn.Compiler.YarnSpinnerParser.File_hashtagContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.file_hashtag"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitFile_hashtag(Yarn.Compiler.YarnSpinnerParser.File_hashtagContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.file_hashtag"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterNode(Yarn.Compiler.YarnSpinnerParser.NodeContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.node"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitNode(Yarn.Compiler.YarnSpinnerParser.NodeContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.node"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterTitle_header(Yarn.Compiler.YarnSpinnerParser.Title_headerContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.title_header"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitTitle_header(Yarn.Compiler.YarnSpinnerParser.Title_headerContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.title_header"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterWhen_header(Yarn.Compiler.YarnSpinnerParser.When_headerContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.when_header"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitWhen_header(Yarn.Compiler.YarnSpinnerParser.When_headerContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.when_header"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterHeader(Yarn.Compiler.YarnSpinnerParser.HeaderContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.header"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitHeader(Yarn.Compiler.YarnSpinnerParser.HeaderContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.header"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterHeader_when_expression(Yarn.Compiler.YarnSpinnerParser.Header_when_expressionContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.header_when_expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitHeader_when_expression(Yarn.Compiler.YarnSpinnerParser.Header_when_expressionContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.header_when_expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterBody(Yarn.Compiler.YarnSpinnerParser.BodyContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.body"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitBody(Yarn.Compiler.YarnSpinnerParser.BodyContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.body"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterStatement(Yarn.Compiler.YarnSpinnerParser.StatementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitStatement(Yarn.Compiler.YarnSpinnerParser.StatementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterLine_statement(Yarn.Compiler.YarnSpinnerParser.Line_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitLine_statement(Yarn.Compiler.YarnSpinnerParser.Line_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterLine_formatted_text(Yarn.Compiler.YarnSpinnerParser.Line_formatted_textContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_formatted_text"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitLine_formatted_text(Yarn.Compiler.YarnSpinnerParser.Line_formatted_textContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_formatted_text"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterHashtag(Yarn.Compiler.YarnSpinnerParser.HashtagContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.hashtag"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitHashtag(Yarn.Compiler.YarnSpinnerParser.HashtagContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.hashtag"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterLineCondition(Yarn.Compiler.YarnSpinnerParser.LineConditionContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>lineCondition</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_condition"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitLineCondition(Yarn.Compiler.YarnSpinnerParser.LineConditionContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>lineCondition</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_condition"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterLineOnceCondition(Yarn.Compiler.YarnSpinnerParser.LineOnceConditionContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>lineOnceCondition</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_condition"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitLineOnceCondition(Yarn.Compiler.YarnSpinnerParser.LineOnceConditionContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>lineOnceCondition</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_condition"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterExpParens(Yarn.Compiler.YarnSpinnerParser.ExpParensContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expParens</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitExpParens(Yarn.Compiler.YarnSpinnerParser.ExpParensContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expParens</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterExpMultDivMod(Yarn.Compiler.YarnSpinnerParser.ExpMultDivModContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expMultDivMod</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitExpMultDivMod(Yarn.Compiler.YarnSpinnerParser.ExpMultDivModContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expMultDivMod</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterExpComparison(Yarn.Compiler.YarnSpinnerParser.ExpComparisonContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expComparison</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitExpComparison(Yarn.Compiler.YarnSpinnerParser.ExpComparisonContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expComparison</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterExpNegative(Yarn.Compiler.YarnSpinnerParser.ExpNegativeContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expNegative</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitExpNegative(Yarn.Compiler.YarnSpinnerParser.ExpNegativeContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expNegative</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterExpAndOrXor(Yarn.Compiler.YarnSpinnerParser.ExpAndOrXorContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expAndOrXor</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitExpAndOrXor(Yarn.Compiler.YarnSpinnerParser.ExpAndOrXorContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expAndOrXor</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterExpAddSub(Yarn.Compiler.YarnSpinnerParser.ExpAddSubContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expAddSub</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitExpAddSub(Yarn.Compiler.YarnSpinnerParser.ExpAddSubContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expAddSub</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterExpNot(Yarn.Compiler.YarnSpinnerParser.ExpNotContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expNot</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitExpNot(Yarn.Compiler.YarnSpinnerParser.ExpNotContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expNot</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterExpValue(Yarn.Compiler.YarnSpinnerParser.ExpValueContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expValue</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitExpValue(Yarn.Compiler.YarnSpinnerParser.ExpValueContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expValue</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterExpEquality(Yarn.Compiler.YarnSpinnerParser.ExpEqualityContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expEquality</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitExpEquality(Yarn.Compiler.YarnSpinnerParser.ExpEqualityContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expEquality</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterValueNumber(Yarn.Compiler.YarnSpinnerParser.ValueNumberContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>valueNumber</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitValueNumber(Yarn.Compiler.YarnSpinnerParser.ValueNumberContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>valueNumber</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterValueTrue(Yarn.Compiler.YarnSpinnerParser.ValueTrueContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>valueTrue</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitValueTrue(Yarn.Compiler.YarnSpinnerParser.ValueTrueContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>valueTrue</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterValueFalse(Yarn.Compiler.YarnSpinnerParser.ValueFalseContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>valueFalse</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitValueFalse(Yarn.Compiler.YarnSpinnerParser.ValueFalseContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>valueFalse</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterValueVar(Yarn.Compiler.YarnSpinnerParser.ValueVarContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>valueVar</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitValueVar(Yarn.Compiler.YarnSpinnerParser.ValueVarContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>valueVar</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterValueString(Yarn.Compiler.YarnSpinnerParser.ValueStringContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>valueString</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitValueString(Yarn.Compiler.YarnSpinnerParser.ValueStringContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>valueString</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterValueFunc(Yarn.Compiler.YarnSpinnerParser.ValueFuncContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>valueFunc</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitValueFunc(Yarn.Compiler.YarnSpinnerParser.ValueFuncContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>valueFunc</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterValueTypeMemberReference(Yarn.Compiler.YarnSpinnerParser.ValueTypeMemberReferenceContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>valueTypeMemberReference</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitValueTypeMemberReference(Yarn.Compiler.YarnSpinnerParser.ValueTypeMemberReferenceContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>valueTypeMemberReference</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterVariable(Yarn.Compiler.YarnSpinnerParser.VariableContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.variable"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitVariable(Yarn.Compiler.YarnSpinnerParser.VariableContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.variable"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterFunction_call(Yarn.Compiler.YarnSpinnerParser.Function_callContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.function_call"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitFunction_call(Yarn.Compiler.YarnSpinnerParser.Function_callContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.function_call"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterTypeMemberReference(Yarn.Compiler.YarnSpinnerParser.TypeMemberReferenceContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.typeMemberReference"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitTypeMemberReference(Yarn.Compiler.YarnSpinnerParser.TypeMemberReferenceContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.typeMemberReference"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterIf_statement(Yarn.Compiler.YarnSpinnerParser.If_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.if_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitIf_statement(Yarn.Compiler.YarnSpinnerParser.If_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.if_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterIf_clause(Yarn.Compiler.YarnSpinnerParser.If_clauseContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.if_clause"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitIf_clause(Yarn.Compiler.YarnSpinnerParser.If_clauseContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.if_clause"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterElse_if_clause(Yarn.Compiler.YarnSpinnerParser.Else_if_clauseContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.else_if_clause"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitElse_if_clause(Yarn.Compiler.YarnSpinnerParser.Else_if_clauseContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.else_if_clause"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterElse_clause(Yarn.Compiler.YarnSpinnerParser.Else_clauseContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.else_clause"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitElse_clause(Yarn.Compiler.YarnSpinnerParser.Else_clauseContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.else_clause"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterSet_statement(Yarn.Compiler.YarnSpinnerParser.Set_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.set_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitSet_statement(Yarn.Compiler.YarnSpinnerParser.Set_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.set_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterCall_statement(Yarn.Compiler.YarnSpinnerParser.Call_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.call_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitCall_statement(Yarn.Compiler.YarnSpinnerParser.Call_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.call_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterCommand_statement(Yarn.Compiler.YarnSpinnerParser.Command_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.command_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitCommand_statement(Yarn.Compiler.YarnSpinnerParser.Command_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.command_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterCommand_formatted_text(Yarn.Compiler.YarnSpinnerParser.Command_formatted_textContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.command_formatted_text"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitCommand_formatted_text(Yarn.Compiler.YarnSpinnerParser.Command_formatted_textContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.command_formatted_text"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterShortcut_option_statement(Yarn.Compiler.YarnSpinnerParser.Shortcut_option_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.shortcut_option_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitShortcut_option_statement(Yarn.Compiler.YarnSpinnerParser.Shortcut_option_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.shortcut_option_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterShortcut_option(Yarn.Compiler.YarnSpinnerParser.Shortcut_optionContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.shortcut_option"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitShortcut_option(Yarn.Compiler.YarnSpinnerParser.Shortcut_optionContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.shortcut_option"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterLine_group_statement(Yarn.Compiler.YarnSpinnerParser.Line_group_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_group_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitLine_group_statement(Yarn.Compiler.YarnSpinnerParser.Line_group_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_group_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterLine_group_item(Yarn.Compiler.YarnSpinnerParser.Line_group_itemContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_group_item"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitLine_group_item(Yarn.Compiler.YarnSpinnerParser.Line_group_itemContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_group_item"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterDeclare_statement(Yarn.Compiler.YarnSpinnerParser.Declare_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.declare_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitDeclare_statement(Yarn.Compiler.YarnSpinnerParser.Declare_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.declare_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterEnum_statement(Yarn.Compiler.YarnSpinnerParser.Enum_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.enum_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitEnum_statement(Yarn.Compiler.YarnSpinnerParser.Enum_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.enum_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterEnum_case_statement(Yarn.Compiler.YarnSpinnerParser.Enum_case_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.enum_case_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitEnum_case_statement(Yarn.Compiler.YarnSpinnerParser.Enum_case_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.enum_case_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterJumpToNodeName(Yarn.Compiler.YarnSpinnerParser.JumpToNodeNameContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>jumpToNodeName</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitJumpToNodeName(Yarn.Compiler.YarnSpinnerParser.JumpToNodeNameContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>jumpToNodeName</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterJumpToExpression(Yarn.Compiler.YarnSpinnerParser.JumpToExpressionContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>jumpToExpression</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitJumpToExpression(Yarn.Compiler.YarnSpinnerParser.JumpToExpressionContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>jumpToExpression</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterDetourToNodeName(Yarn.Compiler.YarnSpinnerParser.DetourToNodeNameContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>detourToNodeName</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitDetourToNodeName(Yarn.Compiler.YarnSpinnerParser.DetourToNodeNameContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>detourToNodeName</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterDetourToExpression(Yarn.Compiler.YarnSpinnerParser.DetourToExpressionContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>detourToExpression</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitDetourToExpression(Yarn.Compiler.YarnSpinnerParser.DetourToExpressionContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>detourToExpression</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterReturn_statement(Yarn.Compiler.YarnSpinnerParser.Return_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.return_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitReturn_statement(Yarn.Compiler.YarnSpinnerParser.Return_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.return_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterOnce_statement(Yarn.Compiler.YarnSpinnerParser.Once_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitOnce_statement(Yarn.Compiler.YarnSpinnerParser.Once_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_statement"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterOnce_primary_clause(Yarn.Compiler.YarnSpinnerParser.Once_primary_clauseContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_primary_clause"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitOnce_primary_clause(Yarn.Compiler.YarnSpinnerParser.Once_primary_clauseContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_primary_clause"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterOnce_alternate_clause(Yarn.Compiler.YarnSpinnerParser.Once_alternate_clauseContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_alternate_clause"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitOnce_alternate_clause(Yarn.Compiler.YarnSpinnerParser.Once_alternate_clauseContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_alternate_clause"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterStructured_command(Yarn.Compiler.YarnSpinnerParser.Structured_commandContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.structured_command"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitStructured_command(Yarn.Compiler.YarnSpinnerParser.Structured_commandContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.structured_command"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterStructured_command_value(Yarn.Compiler.YarnSpinnerParser.Structured_command_valueContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.structured_command_value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitStructured_command_value(Yarn.Compiler.YarnSpinnerParser.Structured_command_valueContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.structured_command_value"/>.
|
|
<para>The default implementation does nothing.</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.EnterEveryRule(Antlr4.Runtime.ParserRuleContext)">
|
|
<inheritdoc/>
|
|
<remarks>The default implementation does nothing.</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.ExitEveryRule(Antlr4.Runtime.ParserRuleContext)">
|
|
<inheritdoc/>
|
|
<remarks>The default implementation does nothing.</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.VisitTerminal(Antlr4.Runtime.Tree.ITerminalNode)">
|
|
<inheritdoc/>
|
|
<remarks>The default implementation does nothing.</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseListener.VisitErrorNode(Antlr4.Runtime.Tree.IErrorNode)">
|
|
<inheritdoc/>
|
|
<remarks>The default implementation does nothing.</remarks>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1">
|
|
<summary>
|
|
This class provides an empty implementation of <see cref="T:Yarn.Compiler.IYarnSpinnerParserVisitor`1"/>,
|
|
which can be extended to create a visitor which only needs to handle a subset
|
|
of the available methods.
|
|
</summary>
|
|
<typeparam name="Result">The return type of the visit operation.</typeparam>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitDialogue(Yarn.Compiler.YarnSpinnerParser.DialogueContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.dialogue"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitFile_hashtag(Yarn.Compiler.YarnSpinnerParser.File_hashtagContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.file_hashtag"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitNode(Yarn.Compiler.YarnSpinnerParser.NodeContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.node"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitTitle_header(Yarn.Compiler.YarnSpinnerParser.Title_headerContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.title_header"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitWhen_header(Yarn.Compiler.YarnSpinnerParser.When_headerContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.when_header"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitHeader(Yarn.Compiler.YarnSpinnerParser.HeaderContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.header"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitHeader_when_expression(Yarn.Compiler.YarnSpinnerParser.Header_when_expressionContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.header_when_expression"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitBody(Yarn.Compiler.YarnSpinnerParser.BodyContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.body"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitStatement(Yarn.Compiler.YarnSpinnerParser.StatementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitLine_statement(Yarn.Compiler.YarnSpinnerParser.Line_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitLine_formatted_text(Yarn.Compiler.YarnSpinnerParser.Line_formatted_textContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_formatted_text"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitHashtag(Yarn.Compiler.YarnSpinnerParser.HashtagContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.hashtag"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitLineCondition(Yarn.Compiler.YarnSpinnerParser.LineConditionContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>lineCondition</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_condition"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitLineOnceCondition(Yarn.Compiler.YarnSpinnerParser.LineOnceConditionContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>lineOnceCondition</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_condition"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitExpParens(Yarn.Compiler.YarnSpinnerParser.ExpParensContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expParens</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitExpMultDivMod(Yarn.Compiler.YarnSpinnerParser.ExpMultDivModContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expMultDivMod</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitExpComparison(Yarn.Compiler.YarnSpinnerParser.ExpComparisonContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expComparison</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitExpNegative(Yarn.Compiler.YarnSpinnerParser.ExpNegativeContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expNegative</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitExpAndOrXor(Yarn.Compiler.YarnSpinnerParser.ExpAndOrXorContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expAndOrXor</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitExpAddSub(Yarn.Compiler.YarnSpinnerParser.ExpAddSubContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expAddSub</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitExpNot(Yarn.Compiler.YarnSpinnerParser.ExpNotContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expNot</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitExpValue(Yarn.Compiler.YarnSpinnerParser.ExpValueContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expValue</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitExpEquality(Yarn.Compiler.YarnSpinnerParser.ExpEqualityContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expEquality</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitValueNumber(Yarn.Compiler.YarnSpinnerParser.ValueNumberContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>valueNumber</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitValueTrue(Yarn.Compiler.YarnSpinnerParser.ValueTrueContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>valueTrue</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitValueFalse(Yarn.Compiler.YarnSpinnerParser.ValueFalseContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>valueFalse</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitValueVar(Yarn.Compiler.YarnSpinnerParser.ValueVarContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>valueVar</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitValueString(Yarn.Compiler.YarnSpinnerParser.ValueStringContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>valueString</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitValueFunc(Yarn.Compiler.YarnSpinnerParser.ValueFuncContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>valueFunc</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitValueTypeMemberReference(Yarn.Compiler.YarnSpinnerParser.ValueTypeMemberReferenceContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>valueTypeMemberReference</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitVariable(Yarn.Compiler.YarnSpinnerParser.VariableContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.variable"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitFunction_call(Yarn.Compiler.YarnSpinnerParser.Function_callContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.function_call"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitTypeMemberReference(Yarn.Compiler.YarnSpinnerParser.TypeMemberReferenceContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.typeMemberReference"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitIf_statement(Yarn.Compiler.YarnSpinnerParser.If_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.if_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitIf_clause(Yarn.Compiler.YarnSpinnerParser.If_clauseContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.if_clause"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitElse_if_clause(Yarn.Compiler.YarnSpinnerParser.Else_if_clauseContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.else_if_clause"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitElse_clause(Yarn.Compiler.YarnSpinnerParser.Else_clauseContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.else_clause"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitSet_statement(Yarn.Compiler.YarnSpinnerParser.Set_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.set_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitCall_statement(Yarn.Compiler.YarnSpinnerParser.Call_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.call_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitCommand_statement(Yarn.Compiler.YarnSpinnerParser.Command_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.command_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitCommand_formatted_text(Yarn.Compiler.YarnSpinnerParser.Command_formatted_textContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.command_formatted_text"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitShortcut_option_statement(Yarn.Compiler.YarnSpinnerParser.Shortcut_option_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.shortcut_option_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitShortcut_option(Yarn.Compiler.YarnSpinnerParser.Shortcut_optionContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.shortcut_option"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitLine_group_statement(Yarn.Compiler.YarnSpinnerParser.Line_group_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_group_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitLine_group_item(Yarn.Compiler.YarnSpinnerParser.Line_group_itemContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_group_item"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitDeclare_statement(Yarn.Compiler.YarnSpinnerParser.Declare_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.declare_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitEnum_statement(Yarn.Compiler.YarnSpinnerParser.Enum_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.enum_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitEnum_case_statement(Yarn.Compiler.YarnSpinnerParser.Enum_case_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.enum_case_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitJumpToNodeName(Yarn.Compiler.YarnSpinnerParser.JumpToNodeNameContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>jumpToNodeName</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitJumpToExpression(Yarn.Compiler.YarnSpinnerParser.JumpToExpressionContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>jumpToExpression</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitDetourToNodeName(Yarn.Compiler.YarnSpinnerParser.DetourToNodeNameContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>detourToNodeName</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitDetourToExpression(Yarn.Compiler.YarnSpinnerParser.DetourToExpressionContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>detourToExpression</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitReturn_statement(Yarn.Compiler.YarnSpinnerParser.Return_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.return_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitOnce_statement(Yarn.Compiler.YarnSpinnerParser.Once_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_statement"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitOnce_primary_clause(Yarn.Compiler.YarnSpinnerParser.Once_primary_clauseContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_primary_clause"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitOnce_alternate_clause(Yarn.Compiler.YarnSpinnerParser.Once_alternate_clauseContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_alternate_clause"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitStructured_command(Yarn.Compiler.YarnSpinnerParser.Structured_commandContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.structured_command"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.YarnSpinnerParserBaseVisitor`1.VisitStructured_command_value(Yarn.Compiler.YarnSpinnerParser.Structured_command_valueContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.structured_command_value"/>.
|
|
<para>
|
|
The default implementation returns the result of calling <see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.VisitChildren(Antlr4.Runtime.Tree.IRuleNode)"/>
|
|
on <paramref name="context"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.ParserRuleContextExtension">
|
|
<summary>
|
|
Contains extension methods for <see cref="T:Antlr4.Runtime.ParserRuleContext"/> objects.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.ParserRuleContextExtension.GetTextWithWhitespace(Antlr4.Runtime.ParserRuleContext)">
|
|
<summary>
|
|
Returns the original text of this <see cref="T:Antlr4.Runtime.ParserRuleContext"/>,
|
|
including all whitespace, comments, and other information that the
|
|
parser would otherwise not include.
|
|
</summary>
|
|
<returns>The original text of this expression.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.IYarnSpinnerParserListener">
|
|
<summary>
|
|
This interface defines a complete listener for a parse tree produced by
|
|
<see cref="T:Yarn.Compiler.YarnSpinnerParser"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterDialogue(Yarn.Compiler.YarnSpinnerParser.DialogueContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.dialogue"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitDialogue(Yarn.Compiler.YarnSpinnerParser.DialogueContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.dialogue"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterFile_hashtag(Yarn.Compiler.YarnSpinnerParser.File_hashtagContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.file_hashtag"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitFile_hashtag(Yarn.Compiler.YarnSpinnerParser.File_hashtagContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.file_hashtag"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterNode(Yarn.Compiler.YarnSpinnerParser.NodeContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.node"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitNode(Yarn.Compiler.YarnSpinnerParser.NodeContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.node"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterTitle_header(Yarn.Compiler.YarnSpinnerParser.Title_headerContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.title_header"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitTitle_header(Yarn.Compiler.YarnSpinnerParser.Title_headerContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.title_header"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterWhen_header(Yarn.Compiler.YarnSpinnerParser.When_headerContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.when_header"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitWhen_header(Yarn.Compiler.YarnSpinnerParser.When_headerContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.when_header"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterHeader(Yarn.Compiler.YarnSpinnerParser.HeaderContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.header"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitHeader(Yarn.Compiler.YarnSpinnerParser.HeaderContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.header"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterHeader_when_expression(Yarn.Compiler.YarnSpinnerParser.Header_when_expressionContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.header_when_expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitHeader_when_expression(Yarn.Compiler.YarnSpinnerParser.Header_when_expressionContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.header_when_expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterBody(Yarn.Compiler.YarnSpinnerParser.BodyContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.body"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitBody(Yarn.Compiler.YarnSpinnerParser.BodyContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.body"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterStatement(Yarn.Compiler.YarnSpinnerParser.StatementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitStatement(Yarn.Compiler.YarnSpinnerParser.StatementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterLine_statement(Yarn.Compiler.YarnSpinnerParser.Line_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitLine_statement(Yarn.Compiler.YarnSpinnerParser.Line_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterLine_formatted_text(Yarn.Compiler.YarnSpinnerParser.Line_formatted_textContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_formatted_text"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitLine_formatted_text(Yarn.Compiler.YarnSpinnerParser.Line_formatted_textContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_formatted_text"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterHashtag(Yarn.Compiler.YarnSpinnerParser.HashtagContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.hashtag"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitHashtag(Yarn.Compiler.YarnSpinnerParser.HashtagContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.hashtag"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterLineCondition(Yarn.Compiler.YarnSpinnerParser.LineConditionContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>lineCondition</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_condition"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitLineCondition(Yarn.Compiler.YarnSpinnerParser.LineConditionContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>lineCondition</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_condition"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterLineOnceCondition(Yarn.Compiler.YarnSpinnerParser.LineOnceConditionContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>lineOnceCondition</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_condition"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitLineOnceCondition(Yarn.Compiler.YarnSpinnerParser.LineOnceConditionContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>lineOnceCondition</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_condition"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterExpParens(Yarn.Compiler.YarnSpinnerParser.ExpParensContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expParens</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitExpParens(Yarn.Compiler.YarnSpinnerParser.ExpParensContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expParens</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterExpMultDivMod(Yarn.Compiler.YarnSpinnerParser.ExpMultDivModContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expMultDivMod</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitExpMultDivMod(Yarn.Compiler.YarnSpinnerParser.ExpMultDivModContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expMultDivMod</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterExpComparison(Yarn.Compiler.YarnSpinnerParser.ExpComparisonContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expComparison</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitExpComparison(Yarn.Compiler.YarnSpinnerParser.ExpComparisonContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expComparison</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterExpNegative(Yarn.Compiler.YarnSpinnerParser.ExpNegativeContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expNegative</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitExpNegative(Yarn.Compiler.YarnSpinnerParser.ExpNegativeContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expNegative</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterExpAndOrXor(Yarn.Compiler.YarnSpinnerParser.ExpAndOrXorContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expAndOrXor</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitExpAndOrXor(Yarn.Compiler.YarnSpinnerParser.ExpAndOrXorContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expAndOrXor</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterExpAddSub(Yarn.Compiler.YarnSpinnerParser.ExpAddSubContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expAddSub</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitExpAddSub(Yarn.Compiler.YarnSpinnerParser.ExpAddSubContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expAddSub</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterExpNot(Yarn.Compiler.YarnSpinnerParser.ExpNotContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expNot</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitExpNot(Yarn.Compiler.YarnSpinnerParser.ExpNotContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expNot</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterExpValue(Yarn.Compiler.YarnSpinnerParser.ExpValueContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expValue</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitExpValue(Yarn.Compiler.YarnSpinnerParser.ExpValueContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expValue</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterExpEquality(Yarn.Compiler.YarnSpinnerParser.ExpEqualityContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>expEquality</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitExpEquality(Yarn.Compiler.YarnSpinnerParser.ExpEqualityContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>expEquality</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterValueNumber(Yarn.Compiler.YarnSpinnerParser.ValueNumberContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>valueNumber</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitValueNumber(Yarn.Compiler.YarnSpinnerParser.ValueNumberContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>valueNumber</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterValueTrue(Yarn.Compiler.YarnSpinnerParser.ValueTrueContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>valueTrue</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitValueTrue(Yarn.Compiler.YarnSpinnerParser.ValueTrueContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>valueTrue</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterValueFalse(Yarn.Compiler.YarnSpinnerParser.ValueFalseContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>valueFalse</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitValueFalse(Yarn.Compiler.YarnSpinnerParser.ValueFalseContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>valueFalse</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterValueVar(Yarn.Compiler.YarnSpinnerParser.ValueVarContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>valueVar</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitValueVar(Yarn.Compiler.YarnSpinnerParser.ValueVarContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>valueVar</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterValueString(Yarn.Compiler.YarnSpinnerParser.ValueStringContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>valueString</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitValueString(Yarn.Compiler.YarnSpinnerParser.ValueStringContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>valueString</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterValueFunc(Yarn.Compiler.YarnSpinnerParser.ValueFuncContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>valueFunc</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitValueFunc(Yarn.Compiler.YarnSpinnerParser.ValueFuncContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>valueFunc</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterValueTypeMemberReference(Yarn.Compiler.YarnSpinnerParser.ValueTypeMemberReferenceContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>valueTypeMemberReference</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitValueTypeMemberReference(Yarn.Compiler.YarnSpinnerParser.ValueTypeMemberReferenceContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>valueTypeMemberReference</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterVariable(Yarn.Compiler.YarnSpinnerParser.VariableContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.variable"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitVariable(Yarn.Compiler.YarnSpinnerParser.VariableContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.variable"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterFunction_call(Yarn.Compiler.YarnSpinnerParser.Function_callContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.function_call"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitFunction_call(Yarn.Compiler.YarnSpinnerParser.Function_callContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.function_call"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterTypeMemberReference(Yarn.Compiler.YarnSpinnerParser.TypeMemberReferenceContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.typeMemberReference"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitTypeMemberReference(Yarn.Compiler.YarnSpinnerParser.TypeMemberReferenceContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.typeMemberReference"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterIf_statement(Yarn.Compiler.YarnSpinnerParser.If_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.if_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitIf_statement(Yarn.Compiler.YarnSpinnerParser.If_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.if_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterIf_clause(Yarn.Compiler.YarnSpinnerParser.If_clauseContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.if_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitIf_clause(Yarn.Compiler.YarnSpinnerParser.If_clauseContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.if_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterElse_if_clause(Yarn.Compiler.YarnSpinnerParser.Else_if_clauseContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.else_if_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitElse_if_clause(Yarn.Compiler.YarnSpinnerParser.Else_if_clauseContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.else_if_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterElse_clause(Yarn.Compiler.YarnSpinnerParser.Else_clauseContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.else_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitElse_clause(Yarn.Compiler.YarnSpinnerParser.Else_clauseContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.else_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterSet_statement(Yarn.Compiler.YarnSpinnerParser.Set_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.set_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitSet_statement(Yarn.Compiler.YarnSpinnerParser.Set_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.set_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterCall_statement(Yarn.Compiler.YarnSpinnerParser.Call_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.call_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitCall_statement(Yarn.Compiler.YarnSpinnerParser.Call_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.call_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterCommand_statement(Yarn.Compiler.YarnSpinnerParser.Command_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.command_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitCommand_statement(Yarn.Compiler.YarnSpinnerParser.Command_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.command_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterCommand_formatted_text(Yarn.Compiler.YarnSpinnerParser.Command_formatted_textContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.command_formatted_text"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitCommand_formatted_text(Yarn.Compiler.YarnSpinnerParser.Command_formatted_textContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.command_formatted_text"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterShortcut_option_statement(Yarn.Compiler.YarnSpinnerParser.Shortcut_option_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.shortcut_option_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitShortcut_option_statement(Yarn.Compiler.YarnSpinnerParser.Shortcut_option_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.shortcut_option_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterShortcut_option(Yarn.Compiler.YarnSpinnerParser.Shortcut_optionContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.shortcut_option"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitShortcut_option(Yarn.Compiler.YarnSpinnerParser.Shortcut_optionContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.shortcut_option"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterLine_group_statement(Yarn.Compiler.YarnSpinnerParser.Line_group_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_group_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitLine_group_statement(Yarn.Compiler.YarnSpinnerParser.Line_group_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_group_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterLine_group_item(Yarn.Compiler.YarnSpinnerParser.Line_group_itemContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_group_item"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitLine_group_item(Yarn.Compiler.YarnSpinnerParser.Line_group_itemContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_group_item"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterDeclare_statement(Yarn.Compiler.YarnSpinnerParser.Declare_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.declare_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitDeclare_statement(Yarn.Compiler.YarnSpinnerParser.Declare_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.declare_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterEnum_statement(Yarn.Compiler.YarnSpinnerParser.Enum_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.enum_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitEnum_statement(Yarn.Compiler.YarnSpinnerParser.Enum_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.enum_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterEnum_case_statement(Yarn.Compiler.YarnSpinnerParser.Enum_case_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.enum_case_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitEnum_case_statement(Yarn.Compiler.YarnSpinnerParser.Enum_case_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.enum_case_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterJumpToNodeName(Yarn.Compiler.YarnSpinnerParser.JumpToNodeNameContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>jumpToNodeName</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitJumpToNodeName(Yarn.Compiler.YarnSpinnerParser.JumpToNodeNameContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>jumpToNodeName</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterJumpToExpression(Yarn.Compiler.YarnSpinnerParser.JumpToExpressionContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>jumpToExpression</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitJumpToExpression(Yarn.Compiler.YarnSpinnerParser.JumpToExpressionContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>jumpToExpression</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterDetourToNodeName(Yarn.Compiler.YarnSpinnerParser.DetourToNodeNameContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>detourToNodeName</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitDetourToNodeName(Yarn.Compiler.YarnSpinnerParser.DetourToNodeNameContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>detourToNodeName</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterDetourToExpression(Yarn.Compiler.YarnSpinnerParser.DetourToExpressionContext)">
|
|
<summary>
|
|
Enter a parse tree produced by the <c>detourToExpression</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitDetourToExpression(Yarn.Compiler.YarnSpinnerParser.DetourToExpressionContext)">
|
|
<summary>
|
|
Exit a parse tree produced by the <c>detourToExpression</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterReturn_statement(Yarn.Compiler.YarnSpinnerParser.Return_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.return_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitReturn_statement(Yarn.Compiler.YarnSpinnerParser.Return_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.return_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterOnce_statement(Yarn.Compiler.YarnSpinnerParser.Once_statementContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitOnce_statement(Yarn.Compiler.YarnSpinnerParser.Once_statementContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterOnce_primary_clause(Yarn.Compiler.YarnSpinnerParser.Once_primary_clauseContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_primary_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitOnce_primary_clause(Yarn.Compiler.YarnSpinnerParser.Once_primary_clauseContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_primary_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterOnce_alternate_clause(Yarn.Compiler.YarnSpinnerParser.Once_alternate_clauseContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_alternate_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitOnce_alternate_clause(Yarn.Compiler.YarnSpinnerParser.Once_alternate_clauseContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_alternate_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterStructured_command(Yarn.Compiler.YarnSpinnerParser.Structured_commandContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.structured_command"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitStructured_command(Yarn.Compiler.YarnSpinnerParser.Structured_commandContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.structured_command"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.EnterStructured_command_value(Yarn.Compiler.YarnSpinnerParser.Structured_command_valueContext)">
|
|
<summary>
|
|
Enter a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.structured_command_value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserListener.ExitStructured_command_value(Yarn.Compiler.YarnSpinnerParser.Structured_command_valueContext)">
|
|
<summary>
|
|
Exit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.structured_command_value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.IYarnSpinnerParserVisitor`1">
|
|
<summary>
|
|
This interface defines a complete generic visitor for a parse tree produced
|
|
by <see cref="T:Yarn.Compiler.YarnSpinnerParser"/>.
|
|
</summary>
|
|
<typeparam name="Result">The return type of the visit operation.</typeparam>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitDialogue(Yarn.Compiler.YarnSpinnerParser.DialogueContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.dialogue"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitFile_hashtag(Yarn.Compiler.YarnSpinnerParser.File_hashtagContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.file_hashtag"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitNode(Yarn.Compiler.YarnSpinnerParser.NodeContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.node"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitTitle_header(Yarn.Compiler.YarnSpinnerParser.Title_headerContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.title_header"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitWhen_header(Yarn.Compiler.YarnSpinnerParser.When_headerContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.when_header"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitHeader(Yarn.Compiler.YarnSpinnerParser.HeaderContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.header"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitHeader_when_expression(Yarn.Compiler.YarnSpinnerParser.Header_when_expressionContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.header_when_expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitBody(Yarn.Compiler.YarnSpinnerParser.BodyContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.body"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitStatement(Yarn.Compiler.YarnSpinnerParser.StatementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitLine_statement(Yarn.Compiler.YarnSpinnerParser.Line_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitLine_formatted_text(Yarn.Compiler.YarnSpinnerParser.Line_formatted_textContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_formatted_text"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitHashtag(Yarn.Compiler.YarnSpinnerParser.HashtagContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.hashtag"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitLineCondition(Yarn.Compiler.YarnSpinnerParser.LineConditionContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>lineCondition</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_condition"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitLineOnceCondition(Yarn.Compiler.YarnSpinnerParser.LineOnceConditionContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>lineOnceCondition</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_condition"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitExpParens(Yarn.Compiler.YarnSpinnerParser.ExpParensContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expParens</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitExpMultDivMod(Yarn.Compiler.YarnSpinnerParser.ExpMultDivModContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expMultDivMod</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitExpComparison(Yarn.Compiler.YarnSpinnerParser.ExpComparisonContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expComparison</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitExpNegative(Yarn.Compiler.YarnSpinnerParser.ExpNegativeContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expNegative</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitExpAndOrXor(Yarn.Compiler.YarnSpinnerParser.ExpAndOrXorContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expAndOrXor</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitExpAddSub(Yarn.Compiler.YarnSpinnerParser.ExpAddSubContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expAddSub</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitExpNot(Yarn.Compiler.YarnSpinnerParser.ExpNotContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expNot</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitExpValue(Yarn.Compiler.YarnSpinnerParser.ExpValueContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expValue</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitExpEquality(Yarn.Compiler.YarnSpinnerParser.ExpEqualityContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>expEquality</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.expression"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitValueNumber(Yarn.Compiler.YarnSpinnerParser.ValueNumberContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>valueNumber</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitValueTrue(Yarn.Compiler.YarnSpinnerParser.ValueTrueContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>valueTrue</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitValueFalse(Yarn.Compiler.YarnSpinnerParser.ValueFalseContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>valueFalse</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitValueVar(Yarn.Compiler.YarnSpinnerParser.ValueVarContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>valueVar</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitValueString(Yarn.Compiler.YarnSpinnerParser.ValueStringContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>valueString</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitValueFunc(Yarn.Compiler.YarnSpinnerParser.ValueFuncContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>valueFunc</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitValueTypeMemberReference(Yarn.Compiler.YarnSpinnerParser.ValueTypeMemberReferenceContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>valueTypeMemberReference</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitVariable(Yarn.Compiler.YarnSpinnerParser.VariableContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.variable"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitFunction_call(Yarn.Compiler.YarnSpinnerParser.Function_callContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.function_call"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitTypeMemberReference(Yarn.Compiler.YarnSpinnerParser.TypeMemberReferenceContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.typeMemberReference"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitIf_statement(Yarn.Compiler.YarnSpinnerParser.If_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.if_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitIf_clause(Yarn.Compiler.YarnSpinnerParser.If_clauseContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.if_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitElse_if_clause(Yarn.Compiler.YarnSpinnerParser.Else_if_clauseContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.else_if_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitElse_clause(Yarn.Compiler.YarnSpinnerParser.Else_clauseContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.else_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitSet_statement(Yarn.Compiler.YarnSpinnerParser.Set_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.set_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitCall_statement(Yarn.Compiler.YarnSpinnerParser.Call_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.call_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitCommand_statement(Yarn.Compiler.YarnSpinnerParser.Command_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.command_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitCommand_formatted_text(Yarn.Compiler.YarnSpinnerParser.Command_formatted_textContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.command_formatted_text"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitShortcut_option_statement(Yarn.Compiler.YarnSpinnerParser.Shortcut_option_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.shortcut_option_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitShortcut_option(Yarn.Compiler.YarnSpinnerParser.Shortcut_optionContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.shortcut_option"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitLine_group_statement(Yarn.Compiler.YarnSpinnerParser.Line_group_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_group_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitLine_group_item(Yarn.Compiler.YarnSpinnerParser.Line_group_itemContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.line_group_item"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitDeclare_statement(Yarn.Compiler.YarnSpinnerParser.Declare_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.declare_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitEnum_statement(Yarn.Compiler.YarnSpinnerParser.Enum_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.enum_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitEnum_case_statement(Yarn.Compiler.YarnSpinnerParser.Enum_case_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.enum_case_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitJumpToNodeName(Yarn.Compiler.YarnSpinnerParser.JumpToNodeNameContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>jumpToNodeName</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitJumpToExpression(Yarn.Compiler.YarnSpinnerParser.JumpToExpressionContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>jumpToExpression</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitDetourToNodeName(Yarn.Compiler.YarnSpinnerParser.DetourToNodeNameContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>detourToNodeName</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitDetourToExpression(Yarn.Compiler.YarnSpinnerParser.DetourToExpressionContext)">
|
|
<summary>
|
|
Visit a parse tree produced by the <c>detourToExpression</c>
|
|
labeled alternative in <see cref="M:Yarn.Compiler.YarnSpinnerParser.jump_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitReturn_statement(Yarn.Compiler.YarnSpinnerParser.Return_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.return_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitOnce_statement(Yarn.Compiler.YarnSpinnerParser.Once_statementContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_statement"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitOnce_primary_clause(Yarn.Compiler.YarnSpinnerParser.Once_primary_clauseContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_primary_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitOnce_alternate_clause(Yarn.Compiler.YarnSpinnerParser.Once_alternate_clauseContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.once_alternate_clause"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitStructured_command(Yarn.Compiler.YarnSpinnerParser.Structured_commandContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.structured_command"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IYarnSpinnerParserVisitor`1.VisitStructured_command_value(Yarn.Compiler.YarnSpinnerParser.Structured_command_valueContext)">
|
|
<summary>
|
|
Visit a parse tree produced by <see cref="M:Yarn.Compiler.YarnSpinnerParser.structured_command_value"/>.
|
|
</summary>
|
|
<param name="context">The parse tree.</param>
|
|
<return>The visitor result.</return>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.ICodeEmitter.Emit(Antlr4.Runtime.IToken,Antlr4.Runtime.IToken,Yarn.Instruction)">
|
|
<summary>
|
|
Creates a new instruction, and appends it to the current node in the
|
|
<see cref="T:Yarn.Program"/>.
|
|
</summary>
|
|
<remarks>
|
|
Called by instances of <see
|
|
cref="T:Yarn.Compiler.CodeGenerationVisitor"/> while walking the parse tree.
|
|
</remarks>
|
|
<param name="instruction">The instruction to add.</param>
|
|
<param name="startToken">The first token in the expression or
|
|
statement that was responsible for emitting this
|
|
instruction.</param>
|
|
<param name="endToken">The last token in the expression or
|
|
statement that was responsible for emitting this
|
|
instruction.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.ICodeEmitter.Emit(Antlr4.Runtime.IToken,Antlr4.Runtime.IToken,Yarn.Instruction[])">
|
|
<summary>
|
|
Adds instructions to the current node in the <see cref="T:Yarn.Program"/>.
|
|
</summary>
|
|
<remarks>
|
|
Called by instances of <see cref="T:Yarn.Compiler.CodeGenerationVisitor"/> while
|
|
walking the parse tree.
|
|
</remarks>
|
|
<param name="instructions">The instructions to add.</param>
|
|
<param name="startToken">The first token in the expression or
|
|
statement that was responsible for emitting this
|
|
instruction.</param>
|
|
<param name="endToken">The last token in the expression or
|
|
statement that was responsible for emitting this
|
|
instruction.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.ICodeEmitter.Emit(Yarn.Instruction)">
|
|
<summary>
|
|
Creates a new instruction, and appends it to the current node in the
|
|
<see cref="T:Yarn.Program"/>.
|
|
Differs from the other Emit call by not requiring a start token.
|
|
This enables its use in pure synthesised elements of the Yarn.
|
|
</summary>
|
|
<remarks>
|
|
Called by instances of <see
|
|
cref="T:Yarn.Compiler.CodeGenerationVisitor"/> while walking the parse tree.
|
|
</remarks>
|
|
<param name="instruction">The instruction to add.</param>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.IndentAwareLexer">
|
|
<summary>
|
|
A Lexer subclass that detects newlines and generates indent and
|
|
dedent tokens accordingly.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IndentAwareLexer.IsInWhenClause">
|
|
<summary>
|
|
Returns a value indicating whether the lexer is currently lexing an
|
|
expression that's part of a 'when' clause.
|
|
</summary>
|
|
<remarks>
|
|
This value is set by <see cref="M:Yarn.Compiler.IndentAwareLexer.SetInWhenClause(System.Boolean)"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IndentAwareLexer.SetInWhenClause(System.Boolean)">
|
|
<summary>
|
|
Sets a value indicating whether the lexer is currently lexing an
|
|
expression that's part of a 'when' clause.
|
|
</summary>
|
|
<param name="val">The value to set.</param>
|
|
<remarks>
|
|
This value can be accessed by calling <see cref="M:Yarn.Compiler.IndentAwareLexer.IsInWhenClause"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.IndentAwareLexer.pendingTokens">
|
|
<summary>
|
|
The collection of tokens that we have seen, but have not yet
|
|
returned. This is needed when NextToken encounters a newline,
|
|
which means we need to buffer indents or dedents. NextToken
|
|
only returns a single <see cref="T:Antlr4.Runtime.IToken"/> at a time, which
|
|
means we use this list to buffer it.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.IndentAwareLexer.warnings">
|
|
<summary>
|
|
The collection of <see cref="T:Yarn.Compiler.IndentAwareLexer.LexerWarning"/> objects we've
|
|
generated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.IndentAwareLexer.unbalancedIndents">
|
|
<summary>
|
|
A stack keeping track of the levels of indentations we have
|
|
seen so far that are relevant to shortcuts.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.IndentAwareLexer.lastIndent">
|
|
<summary>
|
|
Keeps track of the last indentation encounterd.
|
|
This is used to see if depth has changed between lines.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.IndentAwareLexer.lineContainsIndentTrackingToken">
|
|
<summary>
|
|
A flag to say the last line observed was a shortcut or not.
|
|
Used to determine if tracking indents needs to occur.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.IndentAwareLexer.lastToken">
|
|
<summary>
|
|
Holds the last observed token from the stream.
|
|
Used to see if a line is blank or not.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.IndentAwareLexer.lastSeenIndentTrackingContent">
|
|
<summary>
|
|
Holds the line number of the last seen indent-tracking content. Lets
|
|
us work out if the blank line needs to end the option.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IndentAwareLexer.#ctor(Antlr4.Runtime.ICharStream,System.IO.TextWriter,System.IO.TextWriter)">
|
|
<summary>
|
|
Initializes a new instance of the <see
|
|
cref="T:Yarn.Compiler.IndentAwareLexer"/> class.
|
|
</summary>
|
|
<param name="input">The incoming character stream.</param>
|
|
<param name="output">The <see cref="T:System.IO.TextWriter"/> to send
|
|
output to.</param>
|
|
<param name="errorOutput">The <see cref="T:System.IO.TextWriter"/> to send
|
|
errors to.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IndentAwareLexer.#ctor(Antlr4.Runtime.ICharStream)">
|
|
<summary>
|
|
Initializes a new instance of the <see
|
|
cref="T:Yarn.Compiler.IndentAwareLexer"/> class.
|
|
</summary>
|
|
<param name="input">The incoming character stream.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IndentAwareLexer.IsEndOfCommandKeyword">
|
|
<summary>
|
|
Looks ahead 1 character in the input stream and returns a value
|
|
indicating whether the character is whitespace (as determined by
|
|
<see cref="M:System.Char.IsWhiteSpace(System.Char)"/>) or the <c>></c> character.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.IndentAwareLexer.Warnings">
|
|
<summary>
|
|
Gets the collection of warnings determined during lexing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IndentAwareLexer.NextToken">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.IndentAwareLexer.InsertToken(System.String,System.Int32)">
|
|
<summary>
|
|
Inserts a new token with the given text and type, as though it
|
|
had appeared in the input stream.
|
|
</summary>
|
|
<param name="text">The text to use for the token.</param>
|
|
<param name="type">The type of the token.</param>
|
|
<remarks>The token will have a zero length.</remarks>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.IndentAwareLexer.LexerWarning">
|
|
<summary>
|
|
A warning emitted during lexing.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.IndentAwareLexer.LexerWarning.Token">
|
|
<summary>
|
|
The token associated with the warning.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.IndentAwareLexer.LexerWarning.Message">
|
|
<summary>
|
|
The message associated with the warning.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.NodeGroupCompiler.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,Yarn.Compiler.Declaration},System.Collections.Generic.IEnumerable{Yarn.Compiler.YarnSpinnerParser.NodeContext},System.Collections.Generic.List{Yarn.Node},System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Initializes a new instance of the NodeGroupCompiler class.
|
|
</summary>
|
|
<param name="nodeGroupName">The name of the node group to
|
|
compile.</param>
|
|
<param name="variableDeclarations">The collection of existing
|
|
variable declarations found during compilation.</param>
|
|
<param name="nodeContexts">The collection of node group parser
|
|
contexts that all belong to this node group.</param>
|
|
<param name="compiledNodes">The collection of existing compiled
|
|
nodes in the compilation.</param>
|
|
<param name="trackingNodes">The collection of node names for whom
|
|
tracking information should be added.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.NodeGroupCompiler.Emit(Antlr4.Runtime.IToken,Antlr4.Runtime.IToken,Yarn.Instruction)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.NodeGroupCompiler.Emit(Antlr4.Runtime.IToken,Antlr4.Runtime.IToken,Yarn.Instruction[])">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.NodeGroupCompiler.Emit(Yarn.Instruction)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.NodeMetadata">
|
|
<summary>
|
|
contains metadata about a node extracted during compilation for use by language server features
|
|
this is different from nodedebuginfo which is for instruction level debugging
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.Title">
|
|
<summary>
|
|
the title of the node
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.SourceTitle">
|
|
<summary>
|
|
the original title as written in source (before any rewriting by NodeGroupVisitor)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.UniqueTitle">
|
|
<summary>
|
|
the rewritten unique title (e.g. "Meeting.happy" or "Meeting.checksum"), set by NodeGroupVisitor
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.NodeGroup">
|
|
<summary>
|
|
the node group name (equals sourceTitle when when: headers exist, null otherwise)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.Subtitle">
|
|
<summary>
|
|
the subtitle of the node (optional)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.Uri">
|
|
<summary>
|
|
the file uri where this node is defined
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.Jumps">
|
|
<summary>
|
|
all jump and detour destinations referenced from this node
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.FunctionCalls">
|
|
<summary>
|
|
all function names called within this node
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.CommandCalls">
|
|
<summary>
|
|
all command names called within this node (excludes flow control like if/else/endif)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.VariableReferences">
|
|
<summary>
|
|
all variable names referenced within this node
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.NodeGroupComplexity">
|
|
<summary>
|
|
complexity score for node groups or negative one if not part of a group
|
|
calculated by the compiler based on when clauses
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.CharacterNames">
|
|
<summary>
|
|
character names found in dialogue lines within this node
|
|
extracted from lines matching the pattern charactername: dialogue
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.Tags">
|
|
<summary>
|
|
tags from the node tags header
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.PreviewText">
|
|
<summary>
|
|
preview text from the first few lines of dialogue in the node
|
|
used for quick previews in ui
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.OptionCount">
|
|
<summary>
|
|
number of shortcut options in this node
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.Options">
|
|
<summary>
|
|
detailed information about each shortcut option in this node
|
|
includes text, conditions, and grouping for visual display
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.HeaderStartLine">
|
|
<summary>
|
|
zero based line number where the node header starts (first three dashes)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.TitleLine">
|
|
<summary>
|
|
zero based line number where the title declaration is (title: nodename)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.BodyStartLine">
|
|
<summary>
|
|
zero based line number where the node body starts (after second three dashes)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.NodeMetadata.BodyEndLine">
|
|
<summary>
|
|
zero based line number where the node body ends (at or before three equals signs)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.JumpInfo">
|
|
<summary>
|
|
information about a jump or detour from one node to another
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.JumpInfo.Uri">
|
|
<summary>
|
|
The URI of the file in which this jump occurs.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.JumpInfo.DestinationTitle">
|
|
<summary>
|
|
the title of the destination node
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.JumpInfo.Type">
|
|
<summary>
|
|
whether this is a jump or a detour
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.JumpInfo.Range">
|
|
<summary>
|
|
the source location of this jump statement in the file
|
|
used for precise error reporting (YS0002)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.JumpType">
|
|
<summary>
|
|
type of jump between nodes
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.JumpType.Jump">
|
|
<summary>
|
|
a standard jump to another node
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.JumpType.Detour">
|
|
<summary>
|
|
a detour to another node that will return
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.OptionInfo">
|
|
<summary>
|
|
information about a shortcut option within a node
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.OptionInfo.Text">
|
|
<summary>
|
|
the display text of the option (before any pipe separator)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.OptionInfo.LineNumber">
|
|
<summary>
|
|
zero based line number where this option appears
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.OptionInfo.GroupId">
|
|
<summary>
|
|
group identifier - consecutive options that are presented together get the same group id
|
|
used for visual grouping in the editor to show which options appear at the same time
|
|
increments each time options are separated by dialogue or commands
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Project">
|
|
<summary>
|
|
Yarn Projects represent instructions on where to find Yarn scripts and
|
|
associated assets, and how they should be compiled.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Project.WorkspaceRootPlaceholder">
|
|
<summary>
|
|
A placeholder string that represents the location of the workspace
|
|
root in paths.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Project.CurrentProjectFileVersion">
|
|
<summary>
|
|
The current version of <c>.yarnproject</c> file format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Project.YarnSpinnerProjectVersion2">
|
|
<summary>
|
|
A version number representing project version 2 (released with Yarn Spinner 2.0)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Project.YarnSpinnerProjectVersion3">
|
|
<summary>
|
|
A version number representing project version 3 (released with Yarn Spinner 3.0).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Project.YarnSpinnerProjectVersion4">
|
|
<summary>
|
|
A version number representing project version 4 (released with Yarn Spinner 3.2.0).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Project.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Yarn.Compiler.Project"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Project.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Yarn.Compiler.Project"/> class.
|
|
</summary>
|
|
<param name="path">The value to use for the new instance's <see
|
|
cref="P:Yarn.Compiler.Project.Path"/> property.</param>
|
|
<param name="workspaceRootPath">The path to the root of the current
|
|
workspace, or <see langword="null"/>.</param>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.FileVersion">
|
|
<summary>
|
|
Gets or sets the file version of the project.
|
|
</summary>
|
|
<remarks>
|
|
This value is required to be equal to <see
|
|
cref="F:Yarn.Compiler.Project.CurrentProjectFileVersion"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.Path">
|
|
<summary>
|
|
Gets the path that the <see cref="T:Yarn.Compiler.Project"/> was loaded from.
|
|
</summary>
|
|
<remarks>
|
|
This value is not stored when the file is saved, but is instead
|
|
determined when the file is loaded by <see
|
|
cref="M:Yarn.Compiler.Project.LoadFromFile(System.String,System.String)"/>, or provided when the <see
|
|
cref="T:Yarn.Compiler.Project"/> is constructed.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.SourceFilePatterns">
|
|
<summary>
|
|
Gets or sets the collection of file search patterns used to locate
|
|
Yarn files that form this project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.ExcludeFilePatterns">
|
|
<summary>
|
|
Gets or sets the collection of file search patterns that should be
|
|
excluded from this project.
|
|
</summary>
|
|
<remarks>
|
|
If a file is matched by a pattern in <see
|
|
cref="P:Yarn.Compiler.Project.SourceFilePatterns"/>, and is also matched by a pattern in
|
|
<see cref="P:Yarn.Compiler.Project.ExcludeFilePatterns"/>, then it is not included in the
|
|
value returned by <see cref="P:Yarn.Compiler.Project.SourceFiles"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.Localisation">
|
|
<summary>
|
|
Gets or sets the collection of <see cref="T:Yarn.Compiler.Project.LocalizationInfo"/>
|
|
objects that store information about where localized data for this
|
|
project is found.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.BaseLanguage">
|
|
<summary>
|
|
Gets or sets the base language of the project, as an IETF BCP-47
|
|
language tag.
|
|
</summary>
|
|
<remarks>
|
|
The base language is the language that the Yarn scripts is written
|
|
in.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.Definitions">
|
|
<summary>
|
|
Gets or sets the patterns for matching paths to JSON files that
|
|
contain command and function definitions that this project
|
|
references.
|
|
</summary>
|
|
<remarks>
|
|
Definitions files are used by editing tools to provide type
|
|
information and other externally-defined data used by the Yarn
|
|
scripts.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.IsImplicit">
|
|
<summary>
|
|
Gets a value indicating whether this Project is an 'implicit'
|
|
project (that is, it does not currently represent a file that exists
|
|
on disk.)
|
|
</summary>
|
|
<remarks>
|
|
An implicit project is created by tools like the Yarn Spinner
|
|
Language Server when opening a folder that contains Yarn files but
|
|
no Yarn Project file.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.CompilerOptions">
|
|
<summary>
|
|
Gets or sets a dictionary containing instructions that control how
|
|
the Yarn Spinner compiler should compile a project.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Project.IsValidVersionNumber(System.Int32)">
|
|
<summary>
|
|
Gets a value indicating whether <paramref name="number"/> is a valid
|
|
Yarn Spinner version number.
|
|
</summary>
|
|
<param name="number"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.AllowLanguagePreviewFeatures">
|
|
<summary>
|
|
Gets or sets a value indicating whether compiler features that are
|
|
not intended for production use are allowed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.SourceFiles">
|
|
<summary>
|
|
Gets the collection of Yarn files that should be used to compile the
|
|
project.
|
|
</summary>
|
|
<remarks>
|
|
This collection uses a <see cref="P:Yarn.Compiler.Project.Matcher"/> to find all files
|
|
specified by <see cref="P:Yarn.Compiler.Project.SourceFilePatterns"/>, excluding those that
|
|
are specified by <see cref="P:Yarn.Compiler.Project.ExcludeFilePatterns"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.DefinitionsPath">
|
|
<summary>
|
|
Gets the path to the Definitions file, relative to this project's
|
|
location.
|
|
</summary>
|
|
<seealso cref="P:Yarn.Compiler.Project.DefinitionsFiles"/>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.DefinitionsFiles">
|
|
<summary>
|
|
Gets the absolute paths to the project's Definitions files.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.ExtensionData">
|
|
<summary>
|
|
Contains any data parsed from the source file that was not matched
|
|
to a property on this type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.SearchDirectoryPath">
|
|
<summary>
|
|
Gets the path of the directory from which to start searching for
|
|
.yarn files. This value is <see langword="null"/> if the directory
|
|
does not exist on disk.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Project.IsMatchingPath(System.String)">
|
|
<summary>
|
|
Gets a value indicating whether <paramref name="path"/> is a path
|
|
that is included in this project.
|
|
</summary>
|
|
<param name="path">The path to check.</param>
|
|
<returns><see langword="true"/> if <paramref name="path"/> is a path
|
|
that is included in this project; <see langword="false"/>
|
|
otherwise.</returns>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.CurrentNeutralCulture">
|
|
<summary>
|
|
Gets a neutral <see cref="T:System.Globalization.CultureInfo"/> that
|
|
represents the current culture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.WorkspaceRootPath">
|
|
<summary>
|
|
The location of the root of the workspace in which this project is
|
|
located.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Project.LoadFromFile(System.String,System.String)">
|
|
<summary>
|
|
Loads and parses a <see cref="T:Yarn.Compiler.Project"/> from a file on disk.
|
|
</summary>
|
|
<param name="path">The path to the file to load.</param>
|
|
<param name="workspaceRoot">The path of the root of the workspace in
|
|
which <see langword="file"/> is located.</param>
|
|
<returns>The loaded <see cref="T:Yarn.Compiler.Project"/>.</returns>
|
|
<exception cref="T:System.ArgumentException">Thrown when the contents of the
|
|
file cannot be loaded.</exception>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Project.SaveToFile(System.String)">
|
|
<summary>
|
|
Saves a <see cref="T:Yarn.Compiler.Project"/> as JSON-formatted text to a file on
|
|
disk.
|
|
</summary>
|
|
<param name="path">The path of the file to write to.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Project.GetJson">
|
|
<summary>
|
|
Gets a string containing JSON-formatted text that represents this
|
|
<see cref="T:Yarn.Compiler.Project"/>.
|
|
</summary>
|
|
<returns>The <see cref="T:Yarn.Compiler.Project"/>, serialized to JSON.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Project.LocalizationInfo">
|
|
<summary>
|
|
Stores the locations of where localized assets and a localized
|
|
string table for a Yarn Project may be found.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.LocalizationInfo.Assets">
|
|
<summary>
|
|
Gets or sets the location at which localized assets may be
|
|
found.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Project.LocalizationInfo.Strings">
|
|
<summary>
|
|
Gets or sets the location at which the localized string table
|
|
may be found.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.SmartVariableCompiler.Compile(Yarn.Compiler.Declaration)">
|
|
<summary>
|
|
Compiles a Declaration describing a smart variable, and produces a
|
|
<see cref="T:Yarn.Node"/> and a <see cref="T:Yarn.Compiler.NodeDebugInfo"/>.
|
|
</summary>
|
|
<param name="decl">The Declaration to generate an implementation
|
|
node for.</param>
|
|
<returns>A <see cref="T:Yarn.Compiler.NodeCompilationResult"/> that contains the
|
|
generated node for this smart variable and its debugger
|
|
information.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.StringInfo">
|
|
<summary>
|
|
Information about a string. Stored inside a string table, which is
|
|
produced from the Compiler.
|
|
</summary>
|
|
<remarks>
|
|
You do not create instances of this class yourself. They are
|
|
generated by the <see cref="T:Yarn.Compiler.Compiler"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.StringInfo.text">
|
|
<summary>
|
|
The original text of the string.
|
|
</summary>
|
|
<remarks>
|
|
This field is <see langword="null"/> if <see cref="F:Yarn.Compiler.StringInfo.shadowLineID"/>
|
|
is not null.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.StringInfo.nodeName">
|
|
<summary>
|
|
The name of the node that this string was found in.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.StringInfo.lineNumber">
|
|
<summary>
|
|
The line number at which this string was found in the file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.StringInfo.fileName">
|
|
<summary>
|
|
The name of the file this string was found in.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.StringInfo.isImplicitTag">
|
|
<summary>
|
|
Indicates whether this string's line ID was implicitly
|
|
generated.
|
|
</summary>
|
|
<remarks>
|
|
Implicitly generated line IDs are not guaranteed to remain the
|
|
same across multiple compilations. To ensure that a line ID
|
|
remains the same, you must define it by adding a line tag to the
|
|
line.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.StringInfo.metadata">
|
|
<summary>
|
|
The metadata (i.e. hashtags) associated with this string.
|
|
</summary>
|
|
<remarks>
|
|
This array will contain any hashtags associated with this
|
|
string besides the <c>#line:</c> hashtag.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.StringInfo.shadowLineID">
|
|
<summary>
|
|
The ID of the line that this line is shadowing, or null if this line
|
|
is not shadowing another line.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.StringInfo.#ctor(System.String,System.String,System.String,System.Int32,System.Boolean,System.String[],System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Yarn.Compiler.StringInfo"/> struct.
|
|
</summary>
|
|
<param name="text">The text of the string.</param>
|
|
<param name="fileName">The file name.</param>
|
|
<param name="nodeName">The node name.</param>
|
|
<param name="lineNumber">The line number.</param>
|
|
<param name="isImplicitTag">If <c>true</c>, this string info is
|
|
stored with an implicit line ID.</param>
|
|
<param name="metadata">The string's metadata.</param>
|
|
<param name="shadowID">The ID of the line that this entry is
|
|
shadowing, or null.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.StringTableManager.RegisterString(Yarn.Compiler.YarnSpinnerParser.Line_statementContext,System.String,System.String,System.String,System.String,System.Int32,System.String[],System.String)">
|
|
<summary>
|
|
Registers a new string in the string table.
|
|
</summary>
|
|
<param name="context"></param>
|
|
<param name="text">The text of the string to register.</param>
|
|
<param name="fileName">The name of the yarn file that this line is contained within</param>
|
|
<param name="nodeName">The name of the node that this string
|
|
was found in.</param>
|
|
<param name="existingLineID">The line ID to use for this entry in the
|
|
string table.</param>
|
|
<param name="lineNumber">The line number that this string was
|
|
found in.</param>
|
|
<param name="tags">The tags to associate with this string in
|
|
the string table.</param>
|
|
<param name="shadowID">The line ID that this line is shadowing.</param>
|
|
<returns>The string ID for the newly registered
|
|
string.</returns>
|
|
<remarks>If <paramref name="existingLineID"/> is <see
|
|
langword="null"/>, a line ID will be generated from <paramref
|
|
name="fileName"/>, <paramref name="nodeName"/>, and the number
|
|
of elements in <see cref="F:Yarn.Compiler.StringTableManager.StringTable"/>.</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.StringTableManager.ContainsKey(System.String)">
|
|
<summary>
|
|
Checks to see if this string table already contains a line with
|
|
the line ID <paramref name="lineID"/>.
|
|
</summary>
|
|
<param name="lineID">The line ID to check for.</param>
|
|
<returns><see langword="true"/> if the string table already
|
|
contains a line with this ID, <see langword="false"/>
|
|
otherwise.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.StructuredCommandParser">
|
|
<summary>
|
|
Contains methods for parsing structured commands.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.StructuredCommandParser.ParseResult">
|
|
<summary>
|
|
Represents the result of a parse operation containing both the
|
|
parsed context and diagnostics.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.StructuredCommandParser.ParseResult.context">
|
|
<summary>
|
|
The parsed structured command context.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.StructuredCommandParser.ParseResult.diagnostics">
|
|
<summary>
|
|
A collection of diagnostics produced during parsing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.StructuredCommandParser.ParseResult.IsValid">
|
|
<summary>
|
|
Gets a value indicating whether the parse result is valid (that
|
|
is, it contains no parse errors.)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.StructuredCommandParser.ParseStructuredCommand(System.String)">
|
|
<summary>
|
|
Parses the given source string into a structured command.
|
|
</summary>
|
|
<param name="source">The string containing the possible structured
|
|
command text to be parsed.</param>
|
|
<returns>A <see cref="T:Yarn.Compiler.StructuredCommandParser.ParseResult"/> object encapsulating the parsed
|
|
context and any diagnostics.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.SyntaxValidationListener">
|
|
<summary>
|
|
Validates syntax patterns that the parser accepts but are semantically incorrect.
|
|
This includes:
|
|
- Stray command end markers without matching start markers
|
|
- Command keywords outside of command blocks
|
|
- Line content on the same line as non-flow-control commands
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.TypeCheckerListener">
|
|
<summary>
|
|
<see cref="T:Yarn.Compiler.TypeCheckerListener"/> creates type constraints (subclasses
|
|
of <see cref="T:TypeChecker.TypeConstraint"/>) for expressions and values found in a
|
|
parse tree, as well as type declarations that it encounters. These
|
|
constraints can then be resolved by a <see cref="T:TypeChecker.Solver"/> to determine
|
|
the types of expressions and values in the source code (or to determine
|
|
if there was a type error.)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.TypeCheckerListener.typeParameterCount">
|
|
<summary>
|
|
Stores the total number of type variables that have been produced.
|
|
</summary>
|
|
<remarks>
|
|
This variable is used to ensure that names for new type variables
|
|
are always unique.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.TypeCheckerListener.tokens">
|
|
<summary>
|
|
The token stream used to produce the current file.
|
|
</summary>
|
|
<remarks>
|
|
This variable is used to get documentation comments via calls to
|
|
<see cref="M:Yarn.Compiler.Compiler.GetDocumentComments(Antlr4.Runtime.CommonTokenStream,Antlr4.Runtime.ParserRuleContext,System.Boolean)"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.TypeCheckerListener.sourceFileName">
|
|
<summary>
|
|
The name of the source file that we are currently walking.
|
|
</summary>
|
|
<remarks>
|
|
This variable is used to help produce error messages.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.TypeCheckerListener.knownDeclarations">
|
|
<summary>
|
|
The list of all known <see cref="T:Yarn.Compiler.Declaration"/> objects.
|
|
</summary>
|
|
<remarks>
|
|
This list is passed to the constructor, and added to while walking
|
|
the parse tree when new explicit or implicit variable declarations
|
|
need to be added.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.TypeCheckerListener.knownTypes">
|
|
<summary>
|
|
Contains the list of all named type declarations found so far, from
|
|
both built-in types (string, number, etc) and user-defined types
|
|
(enums). This doesn't include function types.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.TypeCheckerListener.TypeSolution">
|
|
<summary>
|
|
The current type solution produced by running this listener on a
|
|
parse tree.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.TypeCheckerListener.currentNodeName">
|
|
<summary>
|
|
The name of the node that we are currently walking.
|
|
</summary>
|
|
<remarks>
|
|
This variable is used to help produce error messages.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.TypeCheckerListener.typeSolution">
|
|
<summary>
|
|
The current incremental type solution.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.TypeCheckerListener.Diagnostics">
|
|
<summary>
|
|
Gets the list of diagnostics produced during type checking.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.TypeCheckerListener.TypeEquations">
|
|
<summary>
|
|
Gets the list of type equations that have been generated by this
|
|
listener.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.TypeCheckerListener.FileTags">
|
|
<summary>
|
|
Gets the collection of file-level hashtags that were found as a
|
|
result of using this <see cref="T:Yarn.Compiler.TypeCheckerListener"/> to visit a
|
|
<see cref="T:Antlr4.Runtime.ParserRuleContext"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.TypeCheckerListener.LanguageTypeNames">
|
|
<summary>Maps the names of types as they appear in the language
|
|
(string, bool, number) to actual type objects.</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.TypeCheckerListener.#ctor(System.String,Antlr4.Runtime.CommonTokenStream,System.Collections.Generic.List{Yarn.Compiler.Declaration},System.Collections.Generic.List{Yarn.TypeBase},TypeChecker.Substitution,System.Collections.Generic.HashSet{TypeChecker.TypeConstraint},System.Threading.CancellationToken)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Yarn.Compiler.TypeCheckerListener"/>
|
|
class.
|
|
</summary>
|
|
<param name="sourceFileName">The name of the source file being
|
|
walked.</param>
|
|
<param name="tokens">The token stream produced from the source
|
|
file.</param>
|
|
<param name="knownDeclarations">The list of all known variable and
|
|
function declarations. This list will be added to while walking the
|
|
parse tree.</param>
|
|
<param name="knownTypes">The list of all known types. This list will
|
|
be added to while walking the parse tree.</param>
|
|
<param name="typeSolution">An existing type solution to build
|
|
upon.</param>
|
|
<param name="failingTypeConstraints">A collection of <see
|
|
cref="T:TypeChecker.TypeConstraint"/> objects. During type checking, this
|
|
collection will be added to if a type constraint fails to resolve by
|
|
the end of a file.</param>
|
|
<param name="cancellationToken">A token used to indicate that type
|
|
checking should be cancelled.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.TypeCheckerListener.GetKnownDeclaration(System.String)">
|
|
<summary>
|
|
Gets a declaration for the identifier named <paramref name="name"/>,
|
|
or <see langword="null"/>.
|
|
</summary>
|
|
<param name="name">The name of the identifier to get a declaration
|
|
for.</param>
|
|
<returns>A <see cref="T:Yarn.Compiler.Declaration"/> object for <paramref
|
|
name="name"/>, or <see langword="null"/> if none was
|
|
found.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.TypeCheckerListener.ExitFile_hashtag(Yarn.Compiler.YarnSpinnerParser.File_hashtagContext)">
|
|
<summary>
|
|
Adds a file hashtag to the parse result.
|
|
</summary>
|
|
<param name="context">The file hashtag parse node.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.TypeCheckerListener.ResolveInitialValues(System.Collections.Generic.List{Yarn.Compiler.Declaration}@,System.Collections.Generic.List{Yarn.Compiler.Diagnostic}@)">
|
|
<summary>
|
|
Given a collection of Declaration objects that have fully-resolved
|
|
types, determines the appropriate value to use as this declaration's
|
|
initial value.
|
|
</summary>
|
|
<param name="declarations">The list of declarations to
|
|
update.</param>
|
|
<param name="diagnostics">The list of diagnostics to add to.</param>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.ParseTreeWalker">
|
|
<summary>
|
|
Provides methods for walking a parse tree.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.ParseTreeWalker.WalkTree(Antlr4.Runtime.ParserRuleContext,System.Action{Antlr4.Runtime.ParserRuleContext})">
|
|
<summary>
|
|
Walks a parse tree, starting at <paramref name="startContext"/>, and
|
|
calls <paramref name="handler"/> for each <see
|
|
cref="T:Antlr4.Runtime.ParserRuleContext"/> it encounters.
|
|
</summary>
|
|
<param name="startContext">The parser rule context to begin walking
|
|
from.</param>
|
|
<param name="handler">The delegate to call for each parser rule
|
|
context encountered.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.ParseTreeWalker.WalkTree``1(Antlr4.Runtime.ParserRuleContext,System.Action{``0})">
|
|
<summary>
|
|
Walks a parse tree, starting at <paramref name="startContext"/>, and
|
|
calls <paramref name="handler"/> for each <typeparamref
|
|
name="TContext"/> it encounters.
|
|
</summary>
|
|
<typeparam name="TContext">The type of parser rule context to call
|
|
<paramref name="handler"/> for.</typeparam>
|
|
<param name="startContext">The parser rule context to begin walking
|
|
from.</param>
|
|
<param name="handler">The delegate to call for each parser rule
|
|
context encountered.</param>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.ITypedContext">
|
|
<summary>
|
|
Contains properties common to all parse nodes that have a type
|
|
associated with them.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.ITypedContext.Type">
|
|
<summary>
|
|
Gets or sets the type of this parse node.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Upgrader.UpgradeJob">
|
|
<summary>
|
|
An upgrade job.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Upgrader.UpgradeJob.Files">
|
|
<summary>
|
|
The collection of files to upgrade.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Upgrader.UpgradeJob.UpgradeType">
|
|
<summary>
|
|
The type of the upgrade to perform.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Upgrader.UpgradeJob.#ctor(Yarn.Compiler.Upgrader.UpgradeType,System.Collections.Generic.IEnumerable{Yarn.Compiler.CompilationJob.File})">
|
|
<summary>
|
|
Initialises a new instances of the UpgradeJob struct.
|
|
</summary>
|
|
<param name="upgradeType">The type of the upgrade.</param>
|
|
<param name="files">The files to upgrade.</param>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Upgrader.UpgradeResult">
|
|
<summary>
|
|
The result of an upgrade.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Upgrader.UpgradeResult.Files">
|
|
<summary>
|
|
The files produced as part of the upgrade.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Upgrader.UpgradeResult.Diagnostics">
|
|
<summary>
|
|
Gets a collection containing all <see cref="T:Yarn.Compiler.Diagnostic"/>
|
|
objects across all of the files in <see cref="F:Yarn.Compiler.Upgrader.UpgradeResult.Files"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Upgrader.UpgradeResult.OutputFile">
|
|
<summary>
|
|
A file generated as part of an upgrade.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Upgrader.UpgradeResult.OutputFile.Path">
|
|
<summary>
|
|
The path of the file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Upgrader.UpgradeResult.OutputFile.Replacements">
|
|
<summary>
|
|
The list of replacements needed to be made in order to go from
|
|
<see cref="F:Yarn.Compiler.Upgrader.UpgradeResult.OutputFile.OriginalSource"/> to <see cref="P:Yarn.Compiler.Upgrader.UpgradeResult.OutputFile.UpgradedSource"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Upgrader.UpgradeResult.OutputFile.OriginalSource">
|
|
<summary>
|
|
The original text of the file, prior to upgrades.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Upgrader.UpgradeResult.OutputFile.UpgradedSource">
|
|
<summary>
|
|
The upgraded text of the file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Upgrader.UpgradeResult.OutputFile.Diagnostics">
|
|
<summary>
|
|
The diagnostics produced for this file as a result of the
|
|
upgrade process.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Upgrader.UpgradeResult.OutputFile.IsNewFile">
|
|
<summary>
|
|
Indicates whether this <see cref="T:Yarn.Compiler.Upgrader.UpgradeResult.OutputFile"/> represents
|
|
a new file to be created. If this is <see
|
|
langword="true"/>, <see cref="F:Yarn.Compiler.Upgrader.UpgradeResult.OutputFile.OriginalSource"/> will be the
|
|
empty string, and <see cref="F:Yarn.Compiler.Upgrader.UpgradeResult.OutputFile.Replacements"/> will be empty.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Upgrader.UpgradeResult.OutputFile.Merge(Yarn.Compiler.Upgrader.UpgradeResult.OutputFile,Yarn.Compiler.Upgrader.UpgradeResult.OutputFile)">
|
|
<summary>
|
|
Merges two <see cref="T:Yarn.Compiler.Upgrader.UpgradeResult.OutputFile"/> objects, producing a
|
|
merged result.
|
|
</summary>
|
|
<param name="a">The first file.</param>
|
|
<param name="b">The second file.</param>
|
|
<returns>The merged result.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Upgrader.TextReplacement">
|
|
<summary>
|
|
Contains information describing a replacement to make in a string.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Upgrader.TextReplacement.Start">
|
|
<summary>
|
|
The position in the original string where the substitution
|
|
should be made.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Upgrader.TextReplacement.StartLine">
|
|
<summary>
|
|
The line in the original string where the substitution should
|
|
be made.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Upgrader.TextReplacement.OriginalText">
|
|
<summary>
|
|
The string to expect at <see cref="F:Yarn.Compiler.Upgrader.TextReplacement.Start"/> in the original
|
|
string.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Upgrader.TextReplacement.ReplacementText">
|
|
<summary>
|
|
The string to replace <see cref="F:Yarn.Compiler.Upgrader.TextReplacement.OriginalText"/> with at <see
|
|
cref="F:Yarn.Compiler.Upgrader.TextReplacement.Start"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Upgrader.TextReplacement.Comment">
|
|
<summary>
|
|
A descriptive comment explaining why the substitution is
|
|
necessary.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Upgrader.TextReplacement.OriginalLength">
|
|
<summary>
|
|
Gets the length of <see cref="F:Yarn.Compiler.Upgrader.TextReplacement.OriginalText"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.Upgrader.TextReplacement.ReplacementLength">
|
|
<summary>
|
|
Gets the length of <see cref="P:Yarn.Compiler.Upgrader.TextReplacement.ReplacementLength"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Upgrader.LanguageUpgrader">
|
|
<summary>
|
|
Contains methods for upgrading the syntax of Yarn scripts.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Upgrader.LanguageUpgrader.Upgrade(Yarn.Compiler.Upgrader.UpgradeJob)">
|
|
<summary>
|
|
Upgrades a Yarn script from one version of the language to
|
|
another, producing both the fully upgraded text as well as a
|
|
collection of replacements.
|
|
</summary>
|
|
<param name="upgradeJob">The upgrade job to perform.</param>
|
|
<throws cref="T:System.ArgumentException">Thrown if the
|
|
<see cref="F:Yarn.Compiler.Upgrader.UpgradeJob.UpgradeType"/> is unsupported.</throws>
|
|
<returns>An <see cref="T:Yarn.Compiler.Upgrader.UpgradeResult"/> object containing the
|
|
results of the upgrade operation.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Upgrader.LanguageUpgrader.ApplyReplacements(System.String,System.Collections.Generic.IEnumerable{Yarn.Compiler.Upgrader.TextReplacement})">
|
|
<summary>
|
|
Applies a collection of string replacements to a string.
|
|
</summary>
|
|
<param name="originalText">The string to modify.</param>
|
|
<param name="replacements">A collection of <see
|
|
cref="T:Yarn.Compiler.Upgrader.TextReplacement"/>s to make in the <paramref
|
|
name="originalText"/>.</param>
|
|
<returns>The modified string.</returns>
|
|
<throws cref="T:System.ArgumentOutOfRangeException">Thrown when a
|
|
replacement refers to an invalid position in originalText, or
|
|
its original text does not match what exists in the
|
|
text.</throws>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Upgrader.UpgradeType">
|
|
<summary>
|
|
Specifies what kind of language upgrading should be applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.Upgrader.UpgradeType.Version1to2">
|
|
<summary>
|
|
Indicates an upgrade from Yarn Spinner 1.0 syntax to Yarn
|
|
Spinner 2.0 syntax.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Utility">
|
|
<summary>
|
|
Utility methods for working with line tags.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.GenerateYarnFileWithDeclarations(System.Collections.Generic.IEnumerable{Yarn.Compiler.Declaration},System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
|
<summary>
|
|
Generates a Yarn script that contains a node that declares
|
|
variables.
|
|
</summary>
|
|
<remarks>This method is intended to be called by tools that let the
|
|
user manage variable declarations. Such tools can read the existing
|
|
variable declarations in from a script (by compiling the script with
|
|
the <see cref="F:Yarn.Compiler.CompilationJob.CompilationType"/> value set to <see
|
|
cref="F:Yarn.Compiler.CompilationJob.Type.TypeCheck"/>), allow the user to
|
|
make changes, and then write the changes to disk by calling this
|
|
method and saving the results.</remarks>
|
|
<param name="declarations">The collection of <see
|
|
cref="T:Yarn.Compiler.Declaration"/> objects to include in the output.</param>
|
|
<param name="title">The title of the node that should be
|
|
generated.</param>
|
|
<param name="tags">The collection of tags that should be generated
|
|
for the node. If this is <see langword="null"/>, no tags will be
|
|
generated.</param>
|
|
<param name="headers">The collection of additional headers that
|
|
should be generated for the node. If this is <see langword="null"/>,
|
|
no additional headers will be generated.</param>
|
|
<returns>A string containing a Yarn script that declares the
|
|
specified variables.</returns>
|
|
<throws cref="T:System.ArgumentOutOfRangeException">Thrown when any of the
|
|
<see cref="T:Yarn.Compiler.Declaration"/> objects in <paramref name="declarations"/>
|
|
is not a variable declaration, or if the <see
|
|
cref="P:Yarn.Compiler.Declaration.Type"/> of any of the declarations is an
|
|
invalid value.</throws>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.AddTagsToLines(System.String,System.Collections.Generic.ICollection{System.String})">
|
|
<summary>
|
|
Given Yarn source code, adds line tags to the ends of all lines
|
|
that need one and do not already have one.
|
|
</summary>
|
|
<remarks><para>
|
|
This method ensures that it does not generate line
|
|
tags that are already present in the file, or present in the
|
|
<paramref name="existingLineTags"/> collection.
|
|
</para>
|
|
<para>
|
|
Line tags are added to any line of source code that contains
|
|
user-visible text: lines, options, and shortcut options.
|
|
</para>
|
|
</remarks>
|
|
<param name="contents">The source code to add line tags
|
|
to.</param>
|
|
<param name="existingLineTags">The collection of line tags
|
|
already exist elsewhere in the source code; the newly added
|
|
line tags will not be duplicates of any in this
|
|
collection.</param>
|
|
<returns>The modified source code, with line tags
|
|
added.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.TagLines(System.String,System.Collections.Generic.ICollection{System.String})">
|
|
<summary>
|
|
Given Yarn source code, adds line tags to the ends of all lines that
|
|
need one and do not already have one.
|
|
</summary>
|
|
<remarks><para>
|
|
This method ensures that it does not generate line tags that are
|
|
already present in the file, or present in the <paramref
|
|
name="existingLineTags"/> collection.
|
|
</para>
|
|
<para>
|
|
Line tags are added to any line of source code that contains
|
|
user-visible text: lines, options, and shortcut options.
|
|
</para>
|
|
</remarks>
|
|
<param name="contents">The source code to add line tags to.</param>
|
|
<param name="existingLineTags">The collection of line tags already
|
|
exist elsewhere in the source code; the newly added line tags will
|
|
not be duplicates of any in this collection.</param>
|
|
<returns>Tuple of the modified source code, with line tags added and
|
|
an updated list of line IDs.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.ParseSource(System.String)">
|
|
<summary>
|
|
Parses a string of Yarn source code, and produces a FileParseResult
|
|
and (if there were any problems) a collection of diagnostics.
|
|
</summary>
|
|
<param name="source">The source code to parse.</param>
|
|
<returns>A tuple containing a <see cref="T:Yarn.Compiler.FileParseResult"/> that
|
|
stores the parse tree and tokens, and a collection of <see
|
|
cref="T:Yarn.Compiler.Diagnostic"/> objects that describe problems in the source
|
|
code.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.ParseSourceText(System.String,System.String)">
|
|
<summary>
|
|
Parses a string of Yarn source code, and produces a <see
|
|
cref="T:Yarn.Compiler.FileParseResult"/>.
|
|
</summary>
|
|
<param name="source">The source code to parse.</param>
|
|
<param name="sourceName">The name of the source.</param>
|
|
<returns>A <see cref="T:Yarn.Compiler.FileParseResult"/> representing the result of
|
|
parsing the source.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.GenerateString(System.Collections.Generic.ICollection{System.String})">
|
|
<summary>
|
|
Generates a new unique line tag that is not present in
|
|
<c>existingKeys</c>.
|
|
</summary>
|
|
<param name="existingKeys">The collection of keys that should be
|
|
considered when generating a new, unique line tag.</param>
|
|
<returns>A unique line tag that is not already present in <paramref
|
|
name="existingKeys"/>.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.GetRange(Antlr4.Runtime.ParserRuleContext)">
|
|
<summary>
|
|
Gets the range covered by a <see cref="T:Antlr4.Runtime.ParserRuleContext"/> in the
|
|
source code.
|
|
</summary>
|
|
<param name="context">The context to get a range for.</param>
|
|
<returns>The <see cref="T:Yarn.Compiler.Range"/> covered by this context.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.Utility.UntaggedLineListener">
|
|
<summary>
|
|
An <see cref="T:Yarn.Compiler.IYarnSpinnerParserListener"/> that produces line tags.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.UntaggedLineListener.#ctor(System.Collections.Generic.IList{System.String},Antlr4.Runtime.CommonTokenStream)">
|
|
<summary>
|
|
Initializes a new instance of the <see
|
|
cref="T:Yarn.Compiler.Utility.UntaggedLineListener"/> class.
|
|
</summary>
|
|
<param name="existingStrings">A collection of line IDs that
|
|
should not be used. This list will be added to as this instance
|
|
works.</param>
|
|
<param name="tokenStream">The token stream used to generate the
|
|
<see cref="T:Antlr4.Runtime.Tree.IParseTree"/> this instance is operating on.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.UntaggedLineListener.ExitLine_statement(Yarn.Compiler.YarnSpinnerParser.Line_statementContext)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.UntaggedLineListener.IndexOfPreviousTokenOnChannel(Antlr4.Runtime.CommonTokenStream,System.Int32,System.Int32)">
|
|
<summary>
|
|
Gets the index of the first token to the left of the token at
|
|
<paramref name="index"/> that's on <paramref name="channel"/>.
|
|
If there are no tokens that match, return -1.
|
|
</summary>
|
|
<param name="tokenStream">The token stream to search
|
|
within.</param>
|
|
<param name="index">The index of the token to start searching
|
|
from.</param>
|
|
<param name="channel">The channel to find tokens on.</param>
|
|
<returns>The index of the first token before the token at
|
|
<paramref name="index"/> that is on the channel <paramref
|
|
name="channel"/>. If none is found, returns -1. If <paramref
|
|
name="index"/> is beyond the size of <paramref
|
|
name="tokenStream"/>, returns the index of the last token in the
|
|
stream.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.ExtractStringBlocks(System.Collections.Generic.IEnumerable{Yarn.Node},Yarn.Compiler.ProjectDebugInfo)">
|
|
<summary>
|
|
Gets the collection of contiguous runs of lines in the provided
|
|
nodes. Each run of lines is guaranteed to run to completion once
|
|
entered.
|
|
</summary>
|
|
<param name="nodes">The nodes to get string blocks for.</param>
|
|
<param name="projectDebugInfo">An object containing debugging
|
|
information for the project.</param>
|
|
<returns>A collection of runs of lines.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.DetermineNodeConnections(System.String[])">
|
|
<summary>
|
|
Finds and collates every jump in every node.
|
|
</summary>
|
|
<param name="YarnFileContents">The collection of yarn file content to parse and walk</param>
|
|
<returns>A list of lists of GraphingNode each containing a node, its jumps, and any positional info.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.GetCompiledCodeAsString(Yarn.Program,Yarn.Library,Yarn.Compiler.CompilationResult)">
|
|
<summary>
|
|
Gets a string containing a representation of the compiled bytecode
|
|
for a <see cref="T:Yarn.Program"/>.
|
|
</summary>
|
|
<param name="program"></param>
|
|
<param name="l"></param>
|
|
<param name="result"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.GetYarnValue(System.IConvertible)">
|
|
<summary>
|
|
Returns an <see cref="T:Yarn.IYarnValue"/> representation of the provided
|
|
value.
|
|
</summary>
|
|
<param name="clrValue">The value to get a Yarn representation
|
|
of.</param>
|
|
<returns>An <see cref="T:Yarn.IYarnValue"/> representation of <paramref
|
|
name="clrValue"/>.</returns>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.Utility.TryGetNodeTitle(System.String,Yarn.Compiler.YarnSpinnerParser.NodeContext,System.String@,System.String@,System.String@,System.String@)">
|
|
<summary>
|
|
Gets the title for a node as defined in the source code, along with
|
|
its unique title (which may be different to the source title.)
|
|
</summary>
|
|
<param name="sourceFileName">The name of the file in which the node
|
|
is defined, or <see langword="null"/> if not available.</param>
|
|
<param name="nodeContext">The parsed node's context.</param>
|
|
<param name="sourceTitle">On return, contains the title of the node,
|
|
as it appears in the source code.</param>
|
|
<param name="uniqueTitle">On return, contains the unique title of
|
|
the node, as stored in the output program.</param>
|
|
<param name="subtitle">The sub-title of the node, if present. This
|
|
value is always <see langword="null"/> if the node is not in a node
|
|
group.</param>
|
|
<param name="nodeGroupName">The name of the node group the node is a
|
|
member of, if any.</param>
|
|
<returns><see langword="true"/> if the <paramref
|
|
name="sourceTitle"/> and <paramref name="uniqueTitle"/> could be
|
|
determined; <see langword="false"/> otherwise.</returns>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.GraphingNode">
|
|
<summary>
|
|
A node for representation in a visual graph.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.GraphingNode.node">
|
|
<summary>
|
|
The name of the node.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.GraphingNode.jumps">
|
|
<summary>
|
|
The list of nodes that this node jumps to.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.GraphingNode.hasPositionalInformation">
|
|
<summary>
|
|
<see langword="true"/> if this <see cref="T:Yarn.Compiler.GraphingNode"/>'s <see
|
|
cref="F:Yarn.Compiler.GraphingNode.position"/> field contains valid information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.GraphingNode.position">
|
|
<summary>
|
|
The position of this <see cref="T:Yarn.Compiler.GraphingNode"/>. Only valid when
|
|
<see cref="F:Yarn.Compiler.GraphingNode.hasPositionalInformation"/> is <see langword="true"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.CodeGenerationVisitor.EvaluateLineCondition(Yarn.Compiler.YarnSpinnerParser.Line_statementContext,System.String@)">
|
|
<summary>
|
|
Generates code that evaluates any conditions present on the line and
|
|
places the result on the stack.
|
|
</summary>
|
|
<param name="lineStatement">The line statement containing
|
|
potential condition information.</param>
|
|
<param name="onceVariable">An output parameter to store the name of
|
|
the relevant 'once' variable for this statement if present, or <see
|
|
langword="null"/> if not.</param>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.CodeGenerationVisitor.GenerateCodeForOperation(Yarn.Operator,Antlr4.Runtime.IToken,Yarn.IType,Antlr4.Runtime.ParserRuleContext[])">
|
|
<summary>
|
|
Emits code that calls a method appropriate for the operator
|
|
<paramref name="op"/> on the type <paramref name="type"/>, given the
|
|
operands <paramref name="operands"/>.
|
|
</summary>
|
|
<param name="op">The operation to perform on <paramref
|
|
name="operands"/>.</param>
|
|
<param name="operatorToken">The first token in the statement that is
|
|
responsible for this operation.</param>
|
|
<param name="type">The type of the expression.</param>
|
|
<param name="operands">The operands to perform the operation
|
|
<paramref name="op"/> on.</param>
|
|
<exception cref="T:System.InvalidOperationException">Thrown when there is no
|
|
matching instructions for the <paramref name="op"/></exception>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.ParserContextExtensions.ContentConditionType.NoCondition">
|
|
<summary>
|
|
The content does not have a condition.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.ParserContextExtensions.ContentConditionType.OnceCondition">
|
|
<summary>
|
|
The content has a 'once' condition (possibly with an additional expression).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Yarn.Compiler.ParserContextExtensions.ContentConditionType.RegularCondition">
|
|
<summary>
|
|
The content has a regular condition with an expression.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.DiagnosticsGeneratorVisitor.Diagnostics">
|
|
<summary>
|
|
Gets the collection of <see cref="T:Yarn.Compiler.Diagnostic"/> objects
|
|
generated by this object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.LiteralValueVisitor">
|
|
<summary>
|
|
A visitor that visits any valid literal (i.e. numbers, bools, strings),
|
|
and returns a <see cref="T:Yarn.Value"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.LiteralValueVisitor.#ctor(Antlr4.Runtime.ParserRuleContext,System.String,System.Collections.Generic.List{Yarn.Compiler.Diagnostic})">
|
|
<summary>
|
|
Initializes a new instance of the <see
|
|
cref="T:Yarn.Compiler.LiteralValueVisitor"/> class.
|
|
</summary>
|
|
<param name="context">The parser context for this value.</param>
|
|
<param name="sourceFileName">The name of the file that is being
|
|
visited by this instance.</param>
|
|
<param name="diagnostics">The list of diagnostics to add to.</param>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.NodeMetadataVisitor">
|
|
<summary>
|
|
Extracts node metadata during compilation for language server features.
|
|
</summary>
|
|
<remarks>
|
|
This visitor walks the parse tree and gathers information about nodes including
|
|
jumps, function calls, commands, variables, character names, and structural information.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Yarn.Compiler.NodeMetadataVisitor.Extract(System.String,Yarn.Compiler.YarnSpinnerParser.DialogueContext)">
|
|
<summary>
|
|
Extracts metadata from a parse tree.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Yarn.Compiler.StringTableGeneratorVisitor">
|
|
<summary>
|
|
A Visitor that walks an expression parse tree and generates string
|
|
table entries, which are provided to a <see
|
|
cref="T:Yarn.Compiler.StringTableManager"/>. This string table can then be provided
|
|
to future compilation passes, or stored for later use. Call the
|
|
<see cref="M:Antlr4.Runtime.Tree.AbstractParseTreeVisitor`1.Visit(Antlr4.Runtime.Tree.IParseTree)"/> method to begin generating string table
|
|
entries.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Yarn.Compiler.StringTableGeneratorVisitor.Diagnostics">
|
|
<summary>
|
|
Gets the collection of <see cref="T:Yarn.Compiler.Diagnostic"/> objects
|
|
generated by this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:ErrorStrategy.ReportNoViableAlternative(Antlr4.Runtime.Parser,Antlr4.Runtime.NoViableAltException)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:ErrorStrategy.ReportInputMismatch(Antlr4.Runtime.Parser,Antlr4.Runtime.InputMismatchException)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:TypeChecker.ConjunctionConstraint">
|
|
<summary>
|
|
A conjunction constraint is a logical 'and' that resolves if all of its
|
|
child constraints resolve.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TypeChecker.ConjunctionConstraint.AllVariables">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:TypeChecker.DisjunctionConstraint">
|
|
<summary>
|
|
A disjunction constraint is a logical 'or' that resolves if at least one
|
|
of its child constraints resolves.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TypeChecker.DisjunctionConstraint.AllVariables">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:TypeChecker.EnumerablesExtension">
|
|
<summary>
|
|
Contains extension methods for working with <see cref="T:System.Collections.Generic.IEnumerable`1"/>
|
|
types.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TypeChecker.EnumerablesExtension.CartesianProduct``1(System.Collections.Generic.IEnumerable{System.Collections.Generic.IEnumerable{``0}})">
|
|
<summary>
|
|
Gets the Cartesian product of 2 or more sequences.
|
|
</summary>
|
|
<typeparam name="T">The type of the values in the sequences.</typeparam>
|
|
<param name="sequences">The sequences to combine.</param>
|
|
<returns>The Cartesian product of the sequences.</returns>
|
|
</member>
|
|
<member name="M:TypeChecker.EnumerablesExtension.NotNull``1(System.Collections.Generic.IEnumerable{``0})">
|
|
<summary>
|
|
Returns an enumerator containing all items of <paramref
|
|
name="sequence"/> that are not null.
|
|
</summary>
|
|
<typeparam name="T">The type of item in <paramref
|
|
name="sequence"/>.</typeparam>
|
|
<param name="sequence">The sequence.</param>
|
|
<returns>A sequence containing non-null elements of <paramref
|
|
name="sequence"/>.</returns>
|
|
</member>
|
|
<member name="T:TypeChecker.FalseConstraint">
|
|
<summary>
|
|
A constraint that always fails to resolve.
|
|
</summary>
|
|
<remarks>This type of constraint is useful for representing error
|
|
messages, and for simplifying larger but known-to-be-unresolvable
|
|
constraint systems.</remarks>
|
|
</member>
|
|
<member name="T:TypeChecker.TrueConstraint">
|
|
<summary>
|
|
A <see cref="T:TypeChecker.TypeConstraint"/> that is always resolvable under any circumstance.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TypeChecker.TypeConstraint">
|
|
<summary>
|
|
Stores information that a Solver can use to solve a system of type
|
|
equations.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TypeChecker.TypeConstraint.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:TypeChecker.TypeConstraint.Simplify(TypeChecker.Substitution,System.Collections.Generic.IEnumerable{Yarn.TypeBase})">
|
|
<summary>
|
|
Simplifies this constraint, producing either a <see
|
|
cref="T:TypeChecker.TypeEqualityConstraint"/> or a <see
|
|
cref="T:TypeChecker.DisjunctionConstraint"/>, or <see langword="null"/>.
|
|
</summary>
|
|
<remarks>
|
|
If this method returns <see langword="null"/>, it represents that
|
|
the constraint has determined that it is a tautology (e.g. 'T0 ==
|
|
T0'), and does not need further evaluation.
|
|
</remarks>
|
|
<param name="subst">A <see cref="T:TypeChecker.Substitution"/> that the constraint
|
|
can use to help decide how to simplify.</param>
|
|
<param name="knownTypes">The collection of all currently known types.</param>
|
|
<returns>A <see cref="T:TypeChecker.TypeEqualityConstraint"/> or a <see
|
|
cref="T:TypeChecker.DisjunctionConstraint"/> that represents a simplified version
|
|
of this constraint, or null.</returns>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeConstraint.SourceRange">
|
|
<summary>
|
|
Gets or sets the range of text that contained the expression that
|
|
produced this constraint.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeConstraint.SourceFileName">
|
|
<summary>
|
|
Gets or sets the name of the file that contained the expression that
|
|
produced this constraint.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeConstraint.AllVariables">
|
|
<summary>
|
|
Gets the collection of all variables involved in this constraint.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeConstraint.IsTautological">
|
|
<summary>
|
|
Gets a value indicating whether this constraint is self-evident.
|
|
</summary>
|
|
<remarks>
|
|
A self-evident constraint will always evaluate to 'true' on its own;
|
|
for example, 'String == String' or 'nameof(String) == "String"').
|
|
Tautological constraints are removed from the type problem, because
|
|
they don't provide any additional information to the type solution.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:TypeChecker.TypeConvertibleConstraint.#ctor(Yarn.IType,Yarn.IType)">
|
|
<summary>
|
|
Initializes a new instance of the <see
|
|
cref="T:TypeChecker.TypeConvertibleConstraint"/> class.
|
|
</summary>
|
|
<param name="type">The type to constraint to one that is convertible
|
|
to <paramref name="convertibleToType"/></param>
|
|
<param name="convertibleToType">The type that <paramref
|
|
name="type"/> should be constrained to be convertible to.</param>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeConvertibleConstraint.FromType">
|
|
<summary>
|
|
Gets or sets the type that is being constrained to one that is
|
|
convertible to <see cref="P:TypeChecker.TypeConvertibleConstraint.ToType"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeConvertibleConstraint.ToType">
|
|
<summary>
|
|
Gets or sets the type that <see cref="P:TypeChecker.TypeConvertibleConstraint.FromType"/> can be converted
|
|
to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeConvertibleConstraint.AllVariables">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:TypeChecker.TypeConvertibleConstraint.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:TypeChecker.TypeConvertibleConstraint.Simplify(TypeChecker.Substitution,System.Collections.Generic.IEnumerable{Yarn.TypeBase})">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeEqualityConstraint.AllVariables">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeHasMemberConstraint.AllVariables">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeHasNameConstraint.AllVariables">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:TypeChecker.Solver">
|
|
<summary>
|
|
Contains methods for solving systems of type equations.
|
|
</summary>
|
|
<remarks>
|
|
This class contains the central algorithms used for solving the system
|
|
of type equations produced by <see
|
|
cref="T:Yarn.Compiler.TypeCheckerListener"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:TypeChecker.Solver.TrySolve(System.Collections.Generic.IEnumerable{TypeChecker.TypeConstraint},System.Collections.Generic.IEnumerable{Yarn.TypeBase},System.Collections.Generic.List{Yarn.Compiler.Diagnostic},TypeChecker.Substitution@)">
|
|
<summary>
|
|
Incrementally solves a collection of type constraints, and produces
|
|
a substitution.
|
|
</summary>
|
|
<param name="typeConstraints">The collection of type constraints to
|
|
solve.</param>
|
|
<param name="knownTypes">The list of types known to the
|
|
solver.</param>
|
|
<param name="diagnostics">The list of diagnostics. If this method
|
|
returns false, the list will be added to.</param>
|
|
<param name="substitution">The Substitution containing a partial
|
|
solution to the overall type problem. If this method returns true,
|
|
<paramref name="substitution"/> is updated with the solution;
|
|
otherwise, <paramref name="substitution"/> is unmodified.</param>
|
|
<returns><see langword="true"/> if the type constraints could be
|
|
solved; <see langword="false"/> otherwise.</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when
|
|
<paramref name="typeConstraints"/> contains a type of constraint
|
|
that could not be handled.</exception>
|
|
</member>
|
|
<member name="M:TypeChecker.Solver.TryUnify(Yarn.IType,Yarn.IType,TypeChecker.Substitution)">
|
|
<summary>
|
|
Attempts to unify <paramref name="x"/> with <paramref name="y"/>,
|
|
updating <paramref name="subst"/>.
|
|
</summary>
|
|
<remarks>
|
|
<para>This method modifies <paramref name="subst"/> in place.</para>
|
|
<para>
|
|
If unifying <paramref name="x"/> with <paramref name="y"/> fails,
|
|
subst is returned unmodified.
|
|
</para>
|
|
</remarks>
|
|
<param name="x">The first term to unify.</param>
|
|
<param name="y">The second term to unify.</param>
|
|
<param name="subst">The <see cref="T:TypeChecker.Substitution"/> to use and
|
|
update.</param>
|
|
<returns>True if the unification worked; false otherwise.</returns>
|
|
</member>
|
|
<member name="M:TypeChecker.Solver.UnifyVariable(TypeChecker.TypeVariable,Yarn.IType,TypeChecker.Substitution)">
|
|
<summary>
|
|
Unifies a variable with a term, by creating a substitution from the
|
|
variable to the value represented by the term, taking into account
|
|
the existing subsitution.
|
|
</summary>
|
|
<param name="var">The variable to unify.</param>
|
|
<param name="term">The term to unify.</param>
|
|
<param name="subst">The current substitution.</param>
|
|
<returns>The updated substitution.</returns>
|
|
</member>
|
|
<member name="M:TypeChecker.Solver.OccursCheck(TypeChecker.TypeVariable,Yarn.IType,TypeChecker.Substitution)">
|
|
<summary>
|
|
Recursively determines if <paramref name="var"/> exists as a
|
|
sub-term in <paramref name="term"/>, taking into account any
|
|
existing substitutions in <paramref name="subst"/>.
|
|
</summary>
|
|
<remarks>
|
|
This function is used to prevent the creation of cyclical
|
|
substitutions (i.e. <c>X: Y, Y: X</c>).
|
|
</remarks>
|
|
<param name="var">The variable to test for use inside <paramref
|
|
name="term"/>.</param>
|
|
<param name="term">The term to test to see if <paramref name="var"/>
|
|
is used inside it.</param>
|
|
<param name="subst">The current substitution.</param>
|
|
<returns><see langword="true"/> if <paramref name="var"/> exists in
|
|
<paramref name="term"/>, <see langword="false"/>
|
|
otherwise.</returns>
|
|
</member>
|
|
<member name="M:TypeChecker.Solver.ToDisjunctiveNormalForm(TypeChecker.TypeConstraint)">
|
|
<summary>
|
|
Converts a constraint into disjunctive normal form (that is, an 'OR
|
|
of ANDs'.)
|
|
</summary>
|
|
<remarks>
|
|
Converting a conjunction containing disjunctions produces an
|
|
exponential number of new constraints, which can result in extremely
|
|
large memory and time cost. Accordingly, <paramref name="input"/>
|
|
should be kept as simple as possible.
|
|
</remarks>
|
|
<param name="input"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:TypeChecker.Substitution">
|
|
<summary>
|
|
A substitution is a mapping between type variables and types (or other
|
|
type variables). It is produced during the process of type resolution by
|
|
the <see cref="T:TypeChecker.Solver"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TypeChecker.Substitution.Clone">
|
|
<summary>
|
|
Returns a duplicate of this <see cref="T:TypeChecker.Substitution"/>.
|
|
</summary>
|
|
<returns>The cloned <see cref="T:TypeChecker.Substitution"/>.</returns>
|
|
</member>
|
|
<member name="T:TypeChecker.ITypeExtensions">
|
|
<summary>
|
|
Contains extension methods for working with types in the context of the
|
|
type solver.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TypeChecker.ITypeExtensions.Substitute(Yarn.IType,TypeChecker.Substitution)">
|
|
<summary>
|
|
Attempts to provide a substituted version of this term, given a
|
|
substitution to draw from.
|
|
</summary>
|
|
<remarks>
|
|
<para>You can use <see cref="M:TypeChecker.Solver.TrySolve(System.Collections.Generic.IEnumerable{TypeChecker.TypeConstraint},System.Collections.Generic.IEnumerable{Yarn.TypeBase},System.Collections.Generic.List{Yarn.Compiler.Diagnostic},TypeChecker.Substitution@)"/> to build a Substitution from
|
|
a system of <see cref="T:TypeChecker.TypeConstraint"/> objects. Once you have a
|
|
<see cref="T:TypeChecker.Substitution"/>, you can use this method to convert an
|
|
<see cref="T:Yarn.IType"/> into the solution's result for that type.
|
|
</para><para> (That
|
|
is: 'substitution' is how you go from a type variable to a type
|
|
literal, given a type solution.)</para>
|
|
</remarks>
|
|
<param name="term">The term to substitute.</param>
|
|
<param name="s">A <see cref="T:TypeChecker.Substitution"/> to use.</param>
|
|
<returns>A substituted term, or <paramref name="term"/>.</returns>
|
|
</member>
|
|
<member name="M:TypeChecker.ITypeExtensions.WithoutTautologies(System.Collections.Generic.IEnumerable{TypeChecker.TypeConstraint})">
|
|
<summary>
|
|
Returns a new collection of type constraints containing all items
|
|
from <paramref name="collection"/> that are not tautologies (that
|
|
is, that are not equalities of the form X == X).
|
|
</summary>
|
|
<remarks>
|
|
Tautologies are not useful when solving a system of type
|
|
constraints, because they always evaluate to true and do not provide
|
|
any useful new information. It's often useful to remove them, to
|
|
save time processing them.
|
|
</remarks>
|
|
<param name="collection">A collection of type constraints.</param>
|
|
<returns>A new collection of constraints that does not include
|
|
tautologies.</returns>
|
|
</member>
|
|
<member name="M:TypeChecker.ITypeExtensions.ApplySubstitution(TypeChecker.TypeConstraint,TypeChecker.Substitution)">
|
|
<summary>
|
|
Applies a substitution to a type constraint, returning an updated
|
|
version of that constraint.
|
|
</summary>
|
|
<param name="typeConstraint">The type constraint to apply the substitution to.</param>
|
|
<param name="substitution">The substitution to apply.</param>
|
|
<returns>An updated constraint.</returns>
|
|
</member>
|
|
<member name="T:TypeChecker.TypeVariable">
|
|
<summary>
|
|
A type variable represents a type that is not yet known.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeVariable.Name">
|
|
<summary>
|
|
Gets or sets the name of this type variable.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeVariable.Context">
|
|
<summary>
|
|
Gets the parser context associated with this type (that is, the
|
|
expression or other parse context whose type is represented by this
|
|
type variable.)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeVariable.Parent">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeVariable.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:TypeChecker.TypeVariable.TypeMembers">
|
|
<summary>
|
|
Gets the collection of members belonging to this type.
|
|
</summary>
|
|
<remarks>
|
|
This collection is always empty, because a type variable represents
|
|
an unknown type.
|
|
</remarks>
|
|
|
|
</member>
|
|
<member name="M:TypeChecker.TypeVariable.#ctor(System.String,Antlr4.Runtime.ParserRuleContext)">
|
|
<summary>
|
|
Initialises a new <see cref="T:TypeChecker.TypeVariable"/>.
|
|
</summary>
|
|
<param name="name">The name of the type variable.</param>
|
|
<param name="context">The parser context that this type variable
|
|
represents the type of.</param>
|
|
</member>
|
|
<member name="M:TypeChecker.TypeVariable.Equals(System.Object)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:TypeChecker.TypeVariable.GetHashCode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:TypeChecker.TypeVariable.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:TypeChecker.TypeVariable.Equals(Yarn.IType)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:TypeChecker.TypeVariable.Equals(TypeChecker.TypeVariable)">
|
|
<inheritdoc/>
|
|
</member>
|
|
</members>
|
|
</doc>
|