Method in BasicBlock

Summary

public override string ToString();

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

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

Field in

The text of the command.

Enumeration Member in

The Destination is reached because an expression evaluated to true.

Enumeration Member in

The Destination is reached because an expression evaluated to false.

Property in

Gets the index of the first instruction 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:

Enumeration Member in

Enum in

Inherits from System.Enum

The type of a Destination.

Class in

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.

Property in

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

Cycles are detected and avoided.

Property in

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

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 command that will be executed.

Property in

Gets the Instructions that form this block.

Property in Destination

Summary

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

public DestinationType Type { 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 .

Field in OptionsElement

Summary

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

public IEnumerable<Option> Options;

Enumeration Member in DestinationType

Summary

Node

Enumeration Member in Condition

Summary

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

DirectJump

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.

Field in

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

Class in

Inherits from

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

Field in LineElement

Summary

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

public string LineID;

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

Class in

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.

Property in

The block that this destination refers to.

This value is only valid when is .

Property in

The condition that causes this destination to be reached.

Field in

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.

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.

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

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

Method in BasicBlock

Summary

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

public void AddDestination(BasicBlock descendant, Condition condition)

Parameters

Struct in OptionsElement

Inherits from System.ValueType

Summary

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

public struct Option

Fields

Property in

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

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

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.

Class in

Inherits from

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