Summary

Contains classes for compiling Yarn code.

Classes

Interfaces

Namespaces

Structs

Class in Yarn.Compiler

Inherits from System.Object

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.

public class BasicBlock

Classes

Enums

Fields

Methods

Properties

Method in BasicBlock

Summary

Adds a new destination to this block, that points to a node.

public void AddDestination(string nodeName, Condition condition)

Parameters

Method in BasicBlock

Summary

Adds a new destination to this block that points to a node, with a option's line ID for context.

public void AddDestination(BasicBlock descendant, Condition condition, string? lineID)

Parameters

Method in BasicBlock

Summary

Adds a new destination to this block, that points to another block.

public void AddDestination(BasicBlock descendant, Condition condition)

Parameters

Method in BasicBlock

Summary

public override string ToString();

Property in BasicBlock

Summary

Get the ancestors of this block - that is, blocks that may run immediately before this block.

public IEnumerable<BasicBlock> Ancestors { get };

Field in BasicBlock

Summary

Gets the Node that this block was extracted from.

public Node? Node;

Property in BasicBlock

Summary

Gets all descendants (that is, destinations, and destinations of those destinations, and so on), recursively.

public IEnumerable<BasicBlock> Descendants
{
            get; }

Remarks

Cycles are detected and avoided.

Method in BasicBlock

Summary

Adds a new destination to this block that points at any other node in the program.

public void AddDestinationToAnywhere(BasicBlock? returnToBlock = null)

Parameters

Method in BasicBlock

Summary

Gets a string containing the textual description of the instructions in this BasicBlock .

public string ToString(Library? library, CompilationResult? compilationResult)

Parameters

Returns

A string containing the text version of the instructions.

Method in BasicBlock

Summary

public void AddDetourDestination(string nodeName, Condition condition, BasicBlock returnToBlock)

Parameters

Property in

Summary

Gets the destinations of this block - that is, blocks or nodes that may run immediately after this block.

See Also

• : A destination represents a or node that may be run, following the execution of a .

Property in

Summary

Gets the index of the first instruction of the node that this block is in.

Property in

Summary

Gets the Instructions that form this block.

Property in

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.

Property in

Summary

Gets all descendants (that is, destinations, and destinations of those destinations, and so on) that have any player-visible content, recursively.

Remarks

Cycles are detected and avoided.

Property in BasicBlock

Summary

Gets the collection of player-visible content that will be delivered when this block is run.

public IEnumerable<PlayerVisibleContentElement> PlayerVisibleContent
{
            get; }

Remarks

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:

foreach (var item in block.PlayerVisibleContent) { if (item is
LineElement line) { // Do something with line } }

Property in CompilationResult

Summary

Gets the debugging information for this compiled project.

public ProjectDebugInfo? ProjectDebugInfo { get; internal set; }

Property in BlockDestination

Summary

public int DestinationInstructionIndex { get; }

Property in BasicBlock

Summary

Gets a descriptive name for the block.

public string Name
{
            get; }

Remarks

If this block begins at a labelled instruction, the name will be [NodeName].[LabelName] . Otherwise, it will be [NodeName].[FirstInstructionIndex] .

Field in CommandElement

Summary

The text of the command.

public string CommandText;

Enumeration Member in Condition

Summary

The Destination is reached because an expression evaluated to false.

ExpressionIsFalse

Class in BasicBlock

Inherits from Destination

Summary

public class AnyNodeDestination : Destination

Constructors

Class in BasicBlock

Inherits from Destination

Summary

public class BlockDestination : Destination

Constructors

Properties

Class in BasicBlock

Inherits from PlayerVisibleContentElement

Summary

A command that will be executed.

public class CommandElement : PlayerVisibleContentElement

Fields

Enumeration Member in

Summary

The Destination is reached because an expression evaluated to true.

Enumeration Member in

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.

Method in

Summary

Property in

Summary

Gets the name of the node that this block is in.

Property in

Summary

The block that this destination refers to.

Remarks

This value is only valid when System.Type is DestinationType.Block .

Property in Destination

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.

public BasicBlock? ReturnTo { get; set; }

Class in BasicBlock

Inherits from PlayerVisibleContentElement

Summary

A line of dialogue that should be shown to the player.

public class LineElement : PlayerVisibleContentElement

Fields

Constructor in

Summary

Parameters

Field in LineElement

Summary

The string table ID of the line that will be shown to the player.

public string LineID;

Enum in BasicBlock

Inherits from System.Enum

Summary

The conditions under which a Destination may be reached at the end of a BasicBlock.

public enum Condition
{
    Fallthrough,
    DirectJump,
    ExpressionIsTrue,
    ExpressionIsFalse,
    Option
}

Members

Class in

Inherits from

Summary

Constructors

Properties

Enumeration Member in Condition

Summary

The Destination is reached beacuse of an explicit instruction to go to this block or node.

DirectJump

Property in NodeDestination

Summary

The name of the node that this destination refers to.

public string NodeName { get; set; }

Remarks

This value is only valid when System.Type is DestinationType.Node .

Enumeration Member in Condition

Summary

The Destination is reached because the player made an in-game choice to go to it.

Option

Class in BasicBlock

Inherits from BlockDestination

Summary

public class OptionDestination : BlockDestination

Constructors

Methods

Properties

Constructor in AnyNodeDestination

Summary

public AnyNodeDestination(BasicBlock? returnTo = null)

Parameters

Method in

Summary

Property in OptionDestination

Summary

public string? OptionLineID { get; set; }

Property in Destination

Summary

The condition that causes this destination to be reached.

public Condition Condition { get; set; }

Class in BasicBlock

Inherits from System.Object

Summary

A destination represents a BasicBlock or node that may be run, following the execution of a BasicBlock .

public abstract class Destination

Remarks

Destination objects represent links between blocks, or between blocks and nodes.

Methods

Properties

Field in

Summary

The collection of options that will be delivered to the player.

Class in BasicBlock

Inherits from PlayerVisibleContentElement

Summary

A collection of options that should be shown to the player.

public class OptionsElement : PlayerVisibleContentElement

Fields

Structs

Field in

Summary

The destination that will be run if this option is selected by the player.

Class in BasicBlock

Inherits from System.Object

Summary

An abstract class that represents some content that is shown to the player.

public abstract class PlayerVisibleContentElement

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.

Struct in Yarn.Compiler

Inherits from System.ValueType

Summary

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

public struct CompilationJob

Remarks

Instances of this struct are used with Compile(CompilationJob) to produce CompilationResult objects.

Enums

Fields

Methods

Properties

Structs

Constructor in NodeDestination

Summary

public NodeDestination(string nodeName, Condition condition, BasicBlock? returnTo = null)

Parameters

Struct in OptionsElement

Inherits from System.ValueType

Summary

Represents a single option that may be presented to the player.

public struct Option

Fields

Field in Option

Summary

The string table ID that will be shown to the player.

public string LineID;

Field in CompilationJob

Summary

The File structs that represent the content to parse..

public IEnumerable<File> Files;

Constructor in OptionDestination

Summary

public OptionDestination(string? optionLineID, BasicBlock block)

Parameters

Method in

Summary

Creates a new using the contents of a collection of files.

Parameters

Returns

A new .

Field in

Summary

The declarations for variables.

Field in

Summary

The that contains declarations for functions.

Method in CompilationJob

Summary

Creates a new CompilationJob using the contents of a string.

public static CompilationJob CreateFromString(string fileName, string source, Library? library = null, int languageVersion = Project.CurrentProjectFileVersion)

Parameters

Returns

A new CompilationJob .

Field in

Summary

The type of compilation to perform.

Property in

Summary

Gets or sets the version of the Yarn language.

Property in

Summary

The collection of type declarations that should be imported and made available to the compiler, prior to compilation.

Field in

Summary

The name of the file.

Remarks

This may be a full path, or just the filename or anything in between. This is useful for diagnostics, and for attributing objects to their original source files.

Method in CompilationJob

Summary

Creates a new CompilationJob using the contents of a collection of files.

public static CompilationJob CreateFromFiles(params string[] paths)

Parameters

Returns

A new CompilationJob .

Enumeration Member in

Summary

The compiler will derive only the variable and function declarations, and file tags, found in the script.

Enumeration Member in Type

Summary

The compiler will generate a string table only.

StringsOnly

Enumeration Member in Type

Summary

The compiler will do a full compilation, and generate a Program , function declaration set, and string table.

FullCompilation

Struct in CompilationJob

Inherits from System.ValueType

Summary

Represents the contents of a file to compile.

public struct File

Fields

Enumeration Member in

Summary

Generate declarations only. This is equivalent to .

Method in CompilationResult

Summary

public string GetDescriptionForVariable(string variableName)

Parameters

Method in CompilationResult

Summary

public string GetStringForKey(string key)

Parameters

Class in Yarn.Compiler

Inherits from System.Object

Summary

The result of a compilation.

public class CompilationResult : ICodeDumpHelper

Remarks

Instances of this class are produced as a result of supplying a CompilationJob to Compile(CompilationJob) .

Methods

Properties

Method in CompilationResult

Summary

public IReadOnlyDictionary<int, string> GetLabelsForNode(string node)

Parameters

Property in CompilationResult

Summary

Gets the collection of variable declarations that were found during compilation.

public IEnumerable<Declaration> Declarations { get; internal set; };

Remarks

This value will be null if the CompilationJob object's CompilationType value was not TypeCheck or FullCompilation .

Property in CompilationResult

Summary

Gets the collection of Diagnostic objects that describe problems in the source code.

public IEnumerable<Diagnostic> Diagnostics { get; internal set; };

Remarks

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

Summary

Gets the collection of objects for each node in .

Property in

Summary

Gets a value indicating whether this compilation result contains any error diagnostics.

Remarks

If this value is true, then the value contained in will not contain a valid output.

Field in

Summary

The source code of this file.

Enum in

Inherits from System.Enum

Summary

The type of compilation that the compiler will do.

Members

Property in

Summary

Gets the collection of file-level tags found in the source code.

Remarks

The keys of this dictionary are the file names (as indicated by the property of the 's collection), and the values are the file tags associated with that file.

Property in

Summary

Gets a value indicating whether the compiler had to create line IDs for lines in the source code that lacked #line: tags.

Remarks

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 method.

Property in

Summary

Gets the compiled Yarn program that the produced.

Remarks

This value will be null if there were errors in the compilation. If this is the case, will contain information describing the errors.

It will also be null if the object's value was not .

Property in

Summary

Gets a dictionary mapping line IDs to StringInfo objects.

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 #line: tag, or implicitly-generated line IDs that the compiler added during compilation.

Property in CompilationResult

Summary

Gets a collection of any types that were defined by the user in the input (for example, user-defined enum types.)

public IReadOnlyCollection<IType> UserDefinedTypes { get; internal set; };

Method in Compiler

Summary

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

public static string? GetDocumentComments(CommonTokenStream tokens, ParserRuleContext context, bool allowCommentsAfter = true)

Remarks

Documentation comments begin with a triple-slash ( /// ), and are used to describe variable declarations. If documentation comments precede a declaration (that is, they're not on the same line as the declaration), then they may span multiple lines, as long as each line begins with a triple-slash.

Parameters

Returns

The text of the documentation comments, or null if no documentation comments were present.

Class in Yarn.Compiler

Inherits from System.Object

Summary

Compiles Yarn code.

public static class Compiler

Methods

Method in Compiler

Summary

Compiles Yarn code, as specified by a compilation job.

public static CompilationResult Compile(CompilationJob compilationJob)

Parameters

Returns

The results of the compilation.

See Also

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

• CompilationResult: The result of a compilation.

Method in

Summary

Generates a line id for a raw text node

Remarks

This should only be used when in raw text mode.

Parameters

Returns

line id for the raw text node

Field in

Summary

The string used for if the Declaration was found outside of a Yarn source file.

Method in

Summary

Creates a new instance of the class, using the given name, type and default value.

Parameters

Returns

A new instance of the class.

Method in

Summary

Property in

Summary

Gets the default value of this , if no value has been specified in code or is available from a 's .

Property in

Summary

Gets the collection of objects that this depends upon the value of.

Class in

Inherits from System.Object

Summary

Represents a variable declaration

Fields

Methods

Properties

Method in

Summary

Flattens a tree of Antlr4.Runtime.Tree.IParseTree objects by recursively visiting their children, and converting them into a flat System.Collections.Generic.IEnumerable`1 .

Parameters

Returns

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

Property in

Summary

Gets the collection of objects whose value depends upon this .

Property in

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.)

Property in

Summary

Gets a string describing the purpose of this .

Property in

Summary

Gets a value indicating whether this Declaration was implicitly inferred from usage.