Property in BasicBlock

Summary

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

public int FirstInstructionIndex { get; set; }

Property in Destination

Summary

The name of the node that this destination refers to.

public string NodeName { get; set; }

Remarks

This value is only valid when Type is Node .

Method in BasicBlock

Summary

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

public void AddDestination(string nodeName, Condition condition)

Parameters

Class in

Inherits from

A command that will be executed.

Enumeration Member in

Field in

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

Field in

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

Enumeration Member in

Enumeration Member in

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

Property in

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

Cycles are detected and avoided.

Property in

Gets the name of the label that this block begins at, or null if this basic block does not begin at a labelled instruction.

Class in

Inherits from

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

Property in

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.

Field in

The text of the command.

Property in

The block that this destination refers to.

This value is only valid when is .

Property in

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

Enumeration Member in

The Destination is reached because the preceding BasicBlock reached the end of its execution, and the Destination's target is the block immediately following.

Property in

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

Property in

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

Gets the Instructions that form this block.

Property in

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

Enumeration Member in

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

Struct in

Inherits from System.ValueType

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

Method in

Sets the of the .

Property in

The condition that causes this destination to be reached.

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 CompilationJob

Summary

The type of compilation to perform.

public Type CompilationType;

Field in CompilationJob

Summary

The File structs that represent the content to parse..

public IEnumerable<File> Files;

Field in CompilationJob

Summary

The declarations for variables.

public IEnumerable<Declaration> VariableDeclarations;

Field in CompilationJob

Summary

The Library that contains declarations for functions.

public Library Library;

Field in File

Summary

The source code of this file.

public string Source;

Enumeration Member in Type

Summary

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

DeclarationsOnly

Enumeration Member in Type

Summary

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

FullCompilation

Enumeration Member in Type

Summary

The compiler will generate a string table only.

StringsOnly

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.

Property in CompilationResult

Summary

Gets the collection of DebugInfo objects for each node in Program .

public IReadOnlyDictionary<string, DebugInfo> DebugInfo { get; internal set; }

Property in CompilationResult

Summary

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

Property in CompilationResult

Summary

Gets the compiled Yarn program that the Compiler produced.

public Program Program { get; internal set; }

Remarks

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.

Method in Compiler

Summary

public static string GetLineIDForNodeName(string name)

Parameters

Field in LineInfo

Summary

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

public int CharacterNumber;

Field in LineInfo

Summary

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

public string NodeName;

Method in Declaration

Summary

public override bool Equals(object obj)

Parameters

Method in Declaration

Summary

public override int GetHashCode()

Method in Declaration

Summary

public override string ToString()

Property in Declaration

Summary

Gets the name of this Declaration.

public string Name { get; internal set; }

Property in Declaration

Summary

Gets the range of text at which this declaration occurs.

public Range Range { get; internal set; };

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.

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

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 .

Enumeration Member in Condition

Summary

The Destination is reached because an expression evaluated to true.

ExpressionIsTrue

Enumeration Member in Condition

Summary

The Destination is reached because an expression evaluated to false.

ExpressionIsFalse

Field in Option

Summary

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

public string LineID;

Field in Option

Summary

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

public string Destination;

Remarks

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

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

Method in BasicBlock

Summary

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

public void AddDestination(BasicBlock descendant, Condition condition)

Parameters

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

Enum in Destination

Inherits from System.Enum

Summary

The type of a Destination.

public enum DestinationType
{
    Node,
    Block
}

Members

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 .

Struct in DebugInfo

Inherits from System.ValueType

Summary

Contains positional information about an instruction.

public struct LineInfo

Fields

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

A new instance of the class.

Struct in

Inherits from System.ValueType

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

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

Method in

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

Struct in

Inherits from System.ValueType

Represents the contents of a file to compile.

Method in

Creates a new using the contents of a string.

Enum in

Inherits from System.Enum

The type of compilation that the compiler will do.

Class in

Inherits from Yarn.Compiler.YarnSpinnerParserBaseListener

Compiles Yarn code.

Method in

Compiles Yarn code, as specified by a compilation job.

Method in

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 .

Method in

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

Method in

Sets the of the .

Class in

Inherits from

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

Property in

Gets a string describing the purpose of this .

Property in

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

Field in

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

Property in

Property in

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

Property in

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

If the compiler encounters errors while compiling source code, the it produces will have a value of null . To help figure out what the error is, users should consult the contents of this property.

Property in

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

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

Property in

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

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

Field in

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

Property in

Gets the instance constructed by this .

Field in

The name of the file.

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

Field in

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

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

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

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

Summary

Contains classes for compiling Yarn code.

Classes

Method in DeclarationBuilder

Summary

Sets the IsImplicit of the Declaration .

public DeclarationBuilder WithImplicit(bool isImplicit)

Parameters

Returns

The instance that received this method call.

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

The text of the documentation comments.

Class in Yarn.Compiler

Inherits from System.Object

Summary

Contains debug information for a node in a Yarn file.

public class DebugInfo

Methods

Method in DeclarationBuilder

Summary

Sets the Range of the Declaration .

public DeclarationBuilder WithRange(Yarn.Compiler.Range range)

Parameters

Returns

The instance that received this method call.

Class in Yarn.Compiler

Inherits from System.Object

Summary

public class DeferredTypeDiagnostic

Methods

Method in DeclarationBuilder

Summary

Sets the Type of the Declaration .

public DeclarationBuilder WithType(IType type)

Parameters

Returns

The instance that received this method call.

Method in DeclarationBuilder

Summary

Sets the DefaultValue of the Declaration .

public DeclarationBuilder WithDefaultValue(System.IConvertible defaultValue)

Parameters

Returns

The instance that received this method call.

Method in DeclarationBuilder

Summary

Sets the SourceFileName of the Declaration .

public DeclarationBuilder WithSourceFileName(string sourceFileName)

Parameters

Returns

The instance that received this method call.

Method in DeclarationBuilder

Summary

Sets the Description of the Declaration .

public DeclarationBuilder WithDescription(string description)

Parameters

Returns

The instance that received this method call.

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

Class in

Inherits from System.Object

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 .

Class in

Inherits from System.Object