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.

Property in BasicBlock

Summary

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

public IEnumerable<Destination> Destinations { get };

See Also

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

Method in BasicBlock

Summary

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

public void AddDestination(string nodeName, Condition condition)

Parameters

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

Summary

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

Summary

Contains classes for compiling Yarn code.

Classes

Namespaces

Structs

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 the Instructions that form this block.

Property in

Summary

Gets a descriptive name for the block.

Remarks

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

Method in

Summary

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

Parameters

Property in BasicBlock

Summary

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

public string NodeName { get; set; }

Enumeration Member in Condition

Summary

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

DirectJump

Enumeration Member in Condition

Summary

The Destination is reached because an expression evaluated to false.

ExpressionIsFalse

Field in CommandElement

Summary

The text of the command.

public string CommandText;

Class in BasicBlock

Inherits from PlayerVisibleContentElement

Summary

A command that will be executed.

public class CommandElement : PlayerVisibleContentElement

Fields

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

Enumeration Member in

Summary

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

Property in

Summary

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

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:

Property in

Summary

The name of the node that this destination refers to.

Remarks

This value is only valid when is .

Property in

Summary

The block that this destination refers to.

Remarks

This value is only valid when is .

Enumeration Member in Condition

Summary

The Destination is reached because an expression evaluated to true.

ExpressionIsTrue

Property in Destination

Summary

Gets the Destination's type - whether the destination is a block, or a node.

public DestinationType Type { get; set; }

Enumeration Member in DestinationType

Summary

Node

Property in Destination

Summary

The condition that causes this destination to be reached.

public Condition Condition { get; set; }

Enumeration Member in DestinationType

Summary

Block

Enumeration Member in Condition

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.

Fallthrough

Struct in BasicBlock

Inherits from System.ValueType

Summary

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

public struct Destination

Remarks

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

Enums

Properties

Enum in Destination

Inherits from System.Enum

Summary

The type of a Destination.

public enum DestinationType
{
    Node,
    Block
}

Members

Class in BasicBlock

Inherits from PlayerVisibleContentElement

Summary

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

public class LineElement : PlayerVisibleContentElement

Fields

Class in

Inherits from

Summary

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

Fields

Structs

Field in

Summary

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

Struct in

Inherits from System.ValueType

Summary

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

Fields

Field in CompilationJob

Summary

The File structs that represent the content to parse..

public IEnumerable<File> Files;

Field in LineElement

Summary

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

public string LineID;

Field in CompilationJob

Summary

The type of compilation to perform.

public Type CompilationType;

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.

Field in Option

Summary

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

public string LineID;

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

Structs

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 .

Field in

Summary

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

Remarks

This will be the name of a label, or the name of a node.

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.

Struct in

Inherits from System.ValueType

Summary

Represents the contents of a file to compile.

Fields

Field in File

Summary

The source code of this file.

public string Source;

Field in CompilationJob

Summary

The Library that contains declarations for functions.

public Library Library;

Enumeration Member in Type

Summary

The compiler will generate a string table only.

StringsOnly

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 do a full compilation, and generate a Program , function declaration set, and string table.

FullCompilation

Struct in Yarn.Compiler

Inherits from System.ValueType

Summary

The result of a compilation.

public struct CompilationResult

Remarks

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

Properties

Property in

Summary

Gets the collection of objects for each node in .

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 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 DeclarationsOnly or FullCompilation .

Field in File

Summary

The name of the file.

public string FileName;

Remarks

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

Property in CompilationResult

Summary

Gets a dictionary mapping line IDs to StringInfo objects.

public IDictionary<string, StringInfo> StringTable { get; internal set; }

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

Class in Yarn.Compiler

Inherits from Yarn.Compiler.YarnSpinnerParserBaseListener

Summary

Compiles Yarn code.

public class Compiler : YarnSpinnerParserBaseListener

Methods

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)

Parameters

Returns

A new CompilationJob .

Enum in

Inherits from System.Enum

Summary

The type of compilation that the compiler will do.

Members

Method in

Summary

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

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.

Property in CompilationResult

Summary

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

public bool ContainsImplicitStringTags { get; internal set; }

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 AddTagsToLines(string,ICollection<string>) method.

Method in Compiler

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 .

public static IEnumerable<IParseTree> FlattenParseTree(IParseTree node)

Parameters

Returns

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

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 Compiler

Summary

Generates a line id for a raw text node

public static string GetLineIDForNodeName(string name)

Remarks

This should only be used when in raw text mode.

Parameters

Returns

line id for the raw text node

Class in Yarn.Compiler

Inherits from System.Object

Summary

Contains debug information for a node in a Yarn file.

public class DebugInfo

Methods

Structs

Struct in DebugInfo

Inherits from System.ValueType

Summary

Contains positional information about an instruction.

public struct LineInfo

Fields

Method in DebugInfo

Summary

Gets a LineInfo object that describes the specified instruction at the index instructionNumber .

public LineInfo GetLineInfo(int instructionNumber)

Parameters

Returns

A LineInfo object that describes the position of the instruction.

Field in

Summary

The node name of the source that this intruction was produced from.

Field in

Summary

The zero-indexed character number in that contains the statement or expression that this line was produced from.

Field in

Summary

The zero-indexed line number in that contains the statement or expression that this line was produced from.

Method in Declaration

Summary

public override string ToString()

Property in CompilationResult

Summary

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

public Dictionary<string, IEnumerable<string>> FileTags { get; internal set; }

Remarks

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.

Field in LineInfo

Summary

The file name of the source that this intruction was produced from.

public string FileName;

Field in Declaration

Summary

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

public const string ExternalDeclaration = "(External)";

Property in Declaration

Summary

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

public IConvertible DefaultValue { get; internal set; }

Property in Declaration

Summary

Gets a string describing the purpose of this Declaration .

public string Description { get; internal set; }

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 };

Class in Yarn.Compiler

Inherits from System.Object

Summary

Represents a variable declaration

public class Declaration

Fields

Methods

Properties

Method in Declaration

Summary

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

public static Declaration CreateVariable(string name, Yarn.IType type, IConvertible defaultValue, string description = null)

Parameters

Returns

A new instance of the Declaration class.

Property in

Summary

Gets the range of text at which this declaration occurs.

Remarks

This range refers to the declaration of the symbol itself, and not any syntax surrounding it. For example, the declaration <<declare $x = 1>> would have a Range referring to the $x symbol.

Class in

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.

Classes

Enums

Methods

Properties

Structs

Property in Declaration

Summary

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

public bool IsImplicit { get; internal set; }

Property in Declaration

Summary

Gets the name of the file in which this Declaration was found.

public string SourceFileName { get; internal set; }

Remarks

If this Declaration was not found in a Yarn source file, this will be ExternalDeclaration .

Method in Declaration

Summary

public override int GetHashCode()

Method in Declaration

Summary

public override bool Equals(object obj)

Parameters

Property in

Summary

Gets the name of this Declaration.

Property in Declaration

Summary

Gets the line number at which this Declaration was found in the source file.

public int SourceFileLine { get };

Remarks

If this Declaration was not found in a Yarn source file, this will be -1.

Property in Declaration

Summary

Gets the name of the node in which this Declaration was found.

public string SourceNodeName { get; internal set; }

Remarks

If this Declaration was not found in a Yarn source file, this will be null .

Method in DeclarationBuilder

Summary

Sets the DefaultValue of the Declaration .

public DeclarationBuilder WithDefaultValue(System.IConvertible defaultValue)

Parameters

Returns

The DeclarationBuilder instance that received this method call.

Method in DeclarationBuilder

Summary

Sets the IsImplicit of the Declaration .

public DeclarationBuilder WithImplicit(bool isImplicit)

Parameters

Returns

The DeclarationBuilder instance that received this method call.

Method in DeclarationBuilder

Summary

Sets the Description of the Declaration .

public DeclarationBuilder WithDescription(string description)

Parameters

Returns

The DeclarationBuilder instance that received this method call.

Method in DeclarationBuilder

Summary

Sets the Type of the Declaration .

public DeclarationBuilder WithType(IType type)

Parameters

Returns

The DeclarationBuilder instance that received this method call.

Method in DeclarationBuilder

Summary

Sets the SourceFileName of the Declaration .

public DeclarationBuilder WithSourceFileName(string sourceFileName)

Parameters

Returns

The DeclarationBuilder instance that received this method call.

Method in

Summary

Sets the of the .

Parameters

Returns

The instance that received this method call.

Property in Declaration

Summary

Gets a value indicating whether this Declaration represents a variable.

public bool IsVariable { get };

Method in DeclarationBuilder

Summary

Sets the Range of the Declaration .

public DeclarationBuilder WithRange(Yarn.Compiler.Range range)

Parameters

Returns

The DeclarationBuilder instance that received this method call.

Class in Yarn.Compiler

Inherits from System.Object

Summary

Represents a potential type error diagnostic message.

public class DeferredTypeDiagnostic

Remarks

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.

Methods

Properties

Class in Yarn.Compiler

Inherits from System.Object

Summary

Provides methods for constructing Declaration objects.

public class DeclarationBuilder

Remarks

To use this class, create an instance of it, and call the With -prefixed methods to set properties. When you're done, access the Declaration property to get the final, constructed Declaration .

Methods

Properties

Property in

Summary

Gets the instance constructed by this .

Property in Declaration

Summary

Gets the type of the variable, as represented by an object that implements IType .

public Yarn.IType Type { get; internal set; }

Method in DeclarationBuilder

Summary

Sets the SourceNodeName of the Declaration .

public DeclarationBuilder WithSourceNodeName(string sourceNodeName)

Parameters

Returns

The DeclarationBuilder instance that received this method call.