Method in BasicBlock

Summary

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

public void AddDestination(BasicBlock descendant, Condition condition)

Parameters

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 all descendants (that is, destinations, and destinations of those destinations, and so on) that have any player-visible content, recursively.

public IEnumerable<BasicBlock> DescendantsWithPlayerVisibleContent
{
            get; }

Remarks

Cycles are detected and avoided.

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 .

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

Methods

Properties

Structs

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 BasicBlock

Summary

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

public int FirstInstructionIndex { get; set; }

Property in BasicBlock

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.

public string LabelName { get; set; }

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

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 BasicBlock

Summary

Gets the Instructions that form this block.

public IEnumerable<Instruction> Instructions { get; set; };

Property in

Summary

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

Class in BasicBlock

Inherits from PlayerVisibleContentElement

Summary

A command that will be executed.

public class CommandElement : PlayerVisibleContentElement

Fields

Field in

Summary

The text of the command.

Enumeration Member in Condition

Summary

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

DirectJump

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 Condition

Summary

The Destination is reached because an expression evaluated to false.

ExpressionIsFalse

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 the preceding BasicBlock reached the end of its execution, and the Destination's target is the block immediately following.

Fallthrough

Enumeration Member in Condition

Summary

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

Option

Property in Destination

Summary

The condition that causes this destination to be reached.

public Condition Condition { get; set; }

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

Property in

Summary

The block that this destination refers to.

Remarks

This value is only valid when is .

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 .

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

Block

Enumeration Member in DestinationType

Summary

Node

Field in

Summary

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

Enum in Destination

Inherits from System.Enum

Summary

The type of a Destination.

public enum DestinationType
{
    Node,
    Block
}

Members

Class in

Inherits from

Summary

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

Fields

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 OptionsElement

Summary

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

public IEnumerable<Option> Options;

Field in Option

Summary

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

public string LineID;

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

Struct in OptionsElement

Inherits from System.ValueType

Summary

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

public struct Option

Fields