Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Property in BasicBlock
Gets all descendants (that is, destinations, and destinations of those destinations, and so on), recursively.
Cycles are detected and avoided.
Name | Description |
---|---|
int
instructionNumber
The index of the instruction to retrieve information for.
Method in BasicBlock
Adds a new destination to this block, that points to another block.
Name | Description |
---|---|
Yarn.Compiler.BasicBlock descendant
The new descendant node.
Yarn.Compiler.BasicBlock.Condition condition
The condition under which descendant
will be run.
Property in BasicBlock
Get the ancestors of this block - that is, blocks that may run immediately before this block.
Gets the collection of player-visible content that will be delivered when this block is run.
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.
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.
To tell the difference between the different kinds of content, use the is
operator to check the type of each item:
Property in
Property in BasicBlock
Gets all descendants (that is, destinations, and destinations of those destinations, and so on) that have any player-visible content, recursively.
Cycles are detected and avoided.
Property in BasicBlock
Gets the index of the first instruction of the node that this block is in.
Property in BasicBlock
Gets the destinations of this block - that is, blocks or nodes that may run immediately after this block.
Destination: A destination represents a BasicBlock or node that may be run, following the execution of a BasicBlock .
Property in BasicBlock
Gets the name of the label that this block begins at, or null if this basic block does not begin at a labelled instruction.
Property in BasicBlock
Gets a descriptive name for the block.
If this block begins at a labelled instruction, the name will be [NodeName].[LabelName]
. Otherwise, it will be [NodeName].[FirstInstructionIndex]
.
Property in CompilationResult
Gets the collection of file-level tags found in the source code.
The keys of this dictionary are the file names (as indicated by the FileName property of the CompilationJob 's Files collection), and the values are the file tags associated with that file.
Class in Yarn.Compiler
Inherits from System.Object
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.
Method in CompilationJob
Creates a new CompilationJob using the contents of a collection of files.
A new CompilationJob .
Method in DeclarationBuilder
Sets the Description of the Declaration .
The DeclarationBuilder instance that received this method call.
Class in BasicBlock
Inherits from PlayerVisibleContentElement
A collection of options that should be shown to the player.
Method in Compiler
Generates a line id for a raw text node
This should only be used when in raw text mode.
line id for the raw text node
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Method in
Sets the of the .
Name | Description |
---|
The instance that received this method call.
Property in
Gets the default value of this , if no value has been specified in code or is available from a 's .
Method in
Method in
Name | Description |
---|
Property in
Method in
Sets the of the .
Name | Description |
---|
The instance that received this method call.
Property in
If this was not found in a Yarn source file, this will be null
.
Method in
Sets the of the .
Name | Description |
---|
The instance that received this method call.
Property in
string
nodeName
The name of the destination node.
Yarn.Compiler.BasicBlock.Condition condition
The condition under which descendant
will be run.
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.
Compiles Yarn code.
Contains debug information for a node in a Yarn file.
Represents a variable declaration
Provides methods for constructing Declaration objects.
Represents a potential type error diagnostic message.
A diagnostic message that describes an error, warning or informational message that the user can take action on.
Provides methods for constructing FunctionType objects.
A Lexer subclass that detects newlines and generates indent and dedent tokens accordingly.
Contains extension methods for producing BasicBlock objects from a Node.
Represents a position in a multi-line string.
Yarn Projects represent instructions on where to find Yarn scripts and associated assets, and how they should be compiled.
Represents a range of text in a multi-line string.
Utility methods for working with line tags.
Contains classes for upgrading Yarn code to more recent versions of the language.
An object that contains Yarn source code to compile, and instructions on how to compile it.
The result of a compilation.
Contains the result of parsing a single file of source code.
Information about a string. Stored inside a string table, which is produced from the Compiler.
A command that will be executed.
A line of dialogue that should be shown to the player.
A collection of options that should be shown to the player.
An abstract class that represents some content that is shown to the player.
The conditions under which a Destination may be reached at the end of a BasicBlock.
Adds a new destination to this block, that points to a node.
Adds a new destination to this block, that points to another block.
Get the ancestors of this block - that is, blocks that may run immediately before this block.
Gets all descendants (that is, destinations, and destinations of those destinations, and so on), recursively.
Gets all descendants (that is, destinations, and destinations of those destinations, and so on) that have any player-visible content, recursively.
Gets the destinations of this block - that is, blocks or nodes that may run immediately after this block.
Gets the index of the first instruction of the node that this block is in.
Gets the Instructions that form this block.
Gets the name of the label that this block begins at, or null if this basic block does not begin at a labelled instruction.
Gets a descriptive name for the block.
Gets the name of the node that this block is in.
Gets the collection of player-visible content that will be delivered when this block is run.
A destination represents a BasicBlock or node that may be run, following the execution of a BasicBlock .
System.Collections.Generic.IEnumerable<string>
paths
The paths to the files.
Yarn.Library library
The Library containing functions to use for this compilation.
string
description
The description to apply to the Declaration.
The collection of options that will be delivered to the player.
Represents a single option that may be presented to the player.
string
name
The name of the node
| The is-implicit value to apply to the Declaration. |
|
| The source node name to apply to the Declaration. |
| The name to apply to the Declaration. |
Enumeration Member in Condition
The Destination is reached beacuse of an explicit instruction to go to this block.
Enumeration Member in Condition
The Destination is reached because the player made an in-game choice to go to it.
Enumeration Member in Condition
The Destination is reached because an expression evaluated to true.
Enumeration Member in Condition
The Destination is reached because an expression evaluated to false.
Enumeration Member in Condition
The Destination is reached because the preceding BasicBlock reached the end of its execution, and the Destination's target is the block immediately following.
Enum in BasicBlock
Inherits from System.Enum
The conditions under which a Destination may be reached at the end of a BasicBlock.
Class in BasicBlock
Inherits from PlayerVisibleContentElement
A command that will be executed.
Name | Description |
---|---|
Name | Description |
---|---|
Enum in
Name | Description |
---|
Struct in
A destination represents a or node that may be run, following the execution of a .
Name | Description |
---|
Name | Description |
---|
Property in
This value is only valid when is .
Property in
The Destination is reached beacuse of an explicit instruction to go to this block.
The Destination is reached because an expression evaluated to false.
The Destination is reached because an expression evaluated to true.
The Destination is reached because the preceding BasicBlock reached the end of its execution, and the Destination's target is the block immediately following.
The Destination is reached because the player made an in-game choice to go to it.
The text of the command.
The type of a Destination. |
The block that this destination refers to. |
The condition that causes this destination to be reached. |
The name of the node that this destination refers to. |
Gets the Destination's type - whether the destination is a block, or a node. |
Class in BasicBlock
Inherits from PlayerVisibleContentElement
A line of dialogue that should be shown to the player.
Name | Description |
---|---|
Enumeration Member in
The string table ID of the line that will be shown to the player.
Field in
Class in BasicBlock
Inherits from System.Object
An abstract class that represents some content that is shown to the player.
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.
Field in Option
The destination that will be run if this option is selected by the player.
This will be the name of a label, or the name of a node.
Struct in OptionsElement
Inherits from System.ValueType
Represents a single option that may be presented to the player.
Name | Description |
---|---|
The destination that will be run if this option is selected by the player.
The string table ID that will be shown to the player.
Struct in Yarn.Compiler
Inherits from System.ValueType
An object that contains Yarn source code to compile, and instructions on how to compile it.
Instances of this struct are used with Compile(CompilationJob) to produce CompilationResult objects.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Method in
Creates a new using the contents of a collection of files.
Name | Description |
---|
A new .
Method in
Creates a new using the contents of a string.
Name | Description |
---|
A new .
Field in
The that contains declarations for functions.
Field in
The structs that represent the content to parse..
The type of compilation that the compiler will do.
The type of compilation to perform.
The File structs that represent the content to parse..
The Library that contains declarations for functions.
The declarations for variables.
Creates a new CompilationJob using the contents of a collection of files.
Creates a new CompilationJob using the contents of a collection of files.
Creates a new CompilationJob using the contents of a string.
Represents the contents of a file to compile.
| The paths to the files. |
| The name to assign to the compiled file. |
| The text to compile. |
Library of function definitions to use during compilation. |
library
Enumeration Member in
The compiler will do a full compilation, and generate a , function declaration set, and string table.
Enumeration Member in
Enum in
Name | Description |
---|
Struct in
Name | Description |
---|
Property in CompilationResult
Gets a value indicating whether the compiler had to create line IDs for lines in the source code that lacked #line:
tags.
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 #line:
tag), the compiler will create one.
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 #line:
tag to the line. This may be done by hand, or added using the AddTagsToLines(string,ICollection<string>) method.
Property in CompilationResult
Gets the collection of variable declarations that were found during compilation.
This value will be null
if the CompilationJob object's CompilationType value was not DeclarationsOnly or FullCompilation .
Enumeration Member in Type
The compiler will derive only the variable and function declarations, and file tags, found in the script.
Property in CompilationResult
Gets the collection of Diagnostic objects that describe problems in the source code.
If the compiler encounters errors while compiling source code, the CompilationResult it produces will have a Program value of null
. To help figure out what the error is, users should consult the contents of this property.
Property in CompilationResult
Gets the compiled Yarn program that the Compiler produced.
This value will be null
if there were errors in the compilation. If this is the case, Diagnostics will contain information describing the errors.
It will also be null
if the CompilationJob object's CompilationType value was not FullCompilation.
Property in CompilationResult
Gets the collection of DebugInfo objects for each node in Program .
The compiler will derive only the variable and function declarations, and file tags, found in the script. |
The compiler will generate a string table only. |
The name of the file. |
The source code of this file. |
Gets a dictionary mapping line IDs to StringInfo objects.
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 #line:
tag, or implicitly-generated line IDs that the compiler added during compilation.
Gets the text of the documentation comments that either immediately precede context
, or are on the same line as context
.
Documentation comments begin with a triple-slash ( ///
), and are used to describe variable declarations. If documentation comments precede a declaration (that is, they're not on the same line as the declaration), then they may span multiple lines, as long as each line begins with a triple-slash.
The text of the documentation comments.
Flattens a tree of Antlr4.Runtime.Tree.IParseTree
objects by recursively visiting their children, and converting them into a flat System.Collections.Generic.IEnumerable`1
.
An System.Collections.Generic.IEnumerable`1
that contains a flattened version of the hierarchy rooted at node
.
The compiler will do a full compilation, and generate a , function declaration set, and string table.
Property in
Method in
Name | Description |
---|
: An object that contains Yarn source code to compile, and instructions on how to compile it.
: The result of a compilation.
Method in
Name | Description |
---|
Struct in
Instances of this struct are produced as a result of supplying a to .
Name | Description |
---|
Class in
Name | Description |
---|
Name | Description |
---|
Method in
Name | Description |
---|
Class in
Name | Description |
---|
| The token stream to search. |
| The parser rule context to get documentation comments for. |
| If true, this method will search for documentation comments that come after |
| The root node to begin work from. |
The compilation job to perform. |
Gets a value indicating whether the compiler had to create line IDs for lines in the source code that lacked |
Gets the collection of variable declarations that were found during compilation. |
Gets the collection of file-level tags found in the source code. |
Gets a dictionary mapping line IDs to StringInfo objects. |
Contains positional information about an instruction. |
Compiles Yarn code, as specified by a compilation job. |
Flattens a tree of |
Gets the text of the documentation comments that either immediately precede |
Generates a line id for a raw text node |
Struct in DebugInfo
Inherits from System.ValueType
Contains positional information about an instruction.
Class in Yarn.Compiler
Inherits from System.Object
Represents a variable declaration
compilationJob
Gets the collection of objects for each node in .
Gets the collection of objects that describe problems in the source code.
Gets the compiled Yarn program that the produced.
Gets a object that describes the specified instruction at the index instructionNumber
.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Method in
The zero-indexed character number in FileName that contains the statement or expression that this line was produced from.
The file name of the source that this intruction was produced from.
The zero-indexed line number in FileName that contains the statement or expression that this line was produced from.
The node name of the source that this intruction was produced from.
The string used for SourceFileName if the Declaration was found outside of a Yarn source file.
Creates a new instance of the Declaration class, using the given name, type and default value.
Gets the default value of this Declaration , if no value has been specified in code or is available from a Dialogue 's IVariableStorage .
Gets a string describing the purpose of this Declaration .
Gets a value indicating whether get or sets a value indicating whether this Declaration was implicitly inferred from usage.
Gets a value indicating whether this Declaration represents a variable.
Gets the name of this Declaration.
Gets the range of text at which this declaration occurs.
Gets the line number at which this Declaration was found in the source file.
Gets the name of the file in which this Declaration was found.
Gets the name of the node in which this Declaration was found.
Gets the type of the variable, as represented by an object that implements IType .
Field in Declaration
The string used for SourceFileName if the Declaration was found outside of a Yarn source file.
Method in Declaration
Creates a new instance of the Declaration class, using the given name, type and default value.
A new instance of the Declaration class.
Name | Description |
---|---|
Property in
If this was not found in a Yarn source file, this will be -1.
Property in
Gets the type of the variable, as represented by an object that implements .
Property in
Class in
Provides methods for constructing objects.
To use this class, create an instance of it, and call the With
-prefixed methods to set properties. When you're done, access the property to get the final, constructed .
Name | Description |
---|
Name | Description |
---|
Property in
If this was not found in a Yarn source file, this will be .
string
name
The name of the new declaration.
Yarn.IType type
The type of the declaration.
System.IConvertible
defaultValue
The default value of the declaration. This must be a string, a number (integer or floating-point), or boolean value.
string
description
The description of the new declaration.
Sets the of the .
Sets the of the .
Sets the of the .
Sets the of the .
Sets the of the .
Sets the of the .
Sets the of the .
Sets the of the .
Gets the instance constructed by this .
Property in DeclarationBuilder
Gets the Declaration instance constructed by this DeclarationBuilder .
Method in DeclarationBuilder
Sets the SourceFileName of the Declaration .
The DeclarationBuilder instance that received this method call.
Method in DeclarationBuilder
Sets the DefaultValue of the Declaration .
The DeclarationBuilder instance that received this method call.
Method in DeclarationBuilder
Sets the Range of the Declaration .
The DeclarationBuilder instance that received this method call.
Method in DeclarationBuilder
Sets the Type of the Declaration .
The DeclarationBuilder instance that received this method call.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
string
sourceFileName
The source file name to apply to the Declaration.
System.IConvertible
defaultValue
The default value to apply to the Declaration.
Yarn.Compiler.Range range
The range to apply to the Declaration.
Yarn.IType type
The type to apply to the Declaration.
Class in Yarn.Compiler
Inherits from System.Object
Represents a potential type error diagnostic message.
Because a variable can be declared in a scope different from the current yarn file, or even externally, when we first hit upon any variables of which we don't know the type of we create a deferred diagnostic. The idea being that we are hoping another file or step will give the information needed to resolved the type. Later once the compiler has finished parsing every file we can see if any of these weren't resolved. If they were not they will be promoted into a full diagnostic and presented to the user.
Name | Description |
---|---|
Name | Description |
---|---|
Convenience method for constructing new deferred type diagnostics
The Diagnostic that has been deferred.
The name of the variable who's type error is being deferred