Method in Dialogue

Summary

Gets a value indicating whether a specified node exists in the Program.

Parameters

Returns

true if a node named nodeName exists in the Program, false otherwise.

Field in Dialogue

Summary

The node that execution will start from.

public const string DefaultStartNodeName = "Start";

Property in Dialogue

Summary

Invoked when the Dialogue needs to report debugging information.

public Logger LogDebugMessage { get; set; }

Method in Dialogue

Summary

Returns the tags for the node nodeName .

public IEnumerable<string> GetTagsForNode(string nodeName)

Remarks

The tags for a node are defined by setting the tags header in the node's source code. This header must be a space-separated list.

Parameters

The node's tags, or null if the node is not present in the Program.

Method in Dialogue

Summary

Returns the string ID that contains the original, uncompiled source text for a node.

public string GetStringIDForNode(string nodeName)

Remarks

A node's source text will only be present in the string table if its tags header contains rawText.

Because the Dialogue class is designed to be unaware of the contents of the string table, this method does not test to see if the string table contains an entry with the line ID. You will need to test for that yourself.

Parameters

The string ID.

Method in Dialogue

Summary

Replaces all substitution markers in a text with the given substitution list.

public static string ExpandSubstitutions(string text, IList<string> substitutions)

Remarks

This method replaces substitution markers - for example, {0}

• with the corresponding entry in substitutions . If text contains a substitution marker whose index is not present in substitutions , it is ignored.

Parameters

text , with the content from substitutions inserted.

Property in

Gets or sets the that is called when a node is started.

Property in

Gets or sets the that is called when the dialogue reaches its end.

Property in

Gets or sets the object that provides access to storing and retrieving the values of variables.

Property in

Gets or sets the that is called when a command is to be delivered to the game.

Property in

Gets a value indicating whether the Dialogue is currently executing Yarn instructions.

Constructor in

Initializes a new instance of the class.

Property in

Gets or sets the 's locale, as an IETF BCP 47 code.

This code is used to determine how the plural and ordinal markers determine the plural class of numbers.

For example, the code "en-US" represents the English language as used in the United States.

Property in

Gets the name of the node that this Dialogue is currently executing.

If has never been called, this value will be null .

Method in

Starts, or continues, execution of the current Program.

This method repeatedly executes instructions until one of the following conditions is encountered:

• The or is called. After calling either of these handlers, the Dialogue will wait until is called. Continue may be called from inside the or , or may be called at any future time.

Property in

Invoked when the Dialogue needs to report an error.

Property in

Gets the names of the nodes in the currently loaded Program.

Method in

Unloads all nodes from the Dialogue.

Property in

Gets or sets the that is called when the dialogue anticipates delivering some lines.

Property in

Gets or sets the that is called when a line is ready to be shown to the user.

Method in

Immediately stops the .

The will not be called if the dialogue is ended by calling .

Property in

Gets or sets the that is called when a node is complete.

Property in

Gets the that this Dialogue uses to locate functions.

When the Dialogue is constructed, the Library is initialized with the built-in operators like + , - , and so on.

Method in Dialogue

Summary

Loads all nodes from the provided Program .

public void SetProgram(Program program)

Remarks

This method replaces any existing nodes have been loaded. If you want to load nodes from an additional Program, use the AddProgram(Program) method.

Parameters

Method in Dialogue

Summary

Parses a line of text, and produces a MarkupParseResult containing the results.

public MarkupParseResult ParseMarkup(string line)

Remarks

The MarkupParseResult 's Text will have any select , plural or ordinal markers replaced with the appropriate text, following this Dialogue 's LanguageCode .

Parameters

The results of parsing the markup.

Method in Dialogue

Summary

Signals to the Dialogue that the user has selected a specified Option .

public void SetSelectedOption(int selectedOptionID)

Remarks

After the Dialogue delivers an OptionSet, this method must be called before Continue() is called.

The ID number that should be passed as the parameter to this method should be the ID field in the Option that represents the user's selection.

Parameters

• : Represents the method that is called when the Dialogue delivers an .

• : A set of s, sent from the to the game.

• : Starts, or continues, execution of the current Program.

Method in Dialogue

Summary

Loads the nodes from the specified Program , and adds them to the nodes already loaded.

public void AddProgram(Program program)

Remarks

If Yarn.Dialogue.Program is null , this method has the effect as calling SetProgram(Program) .

Parameters

Class in Yarn

Inherits from System.Object

Summary

Co-ordinates the execution of Yarn programs.

public class Dialogue : IAttributeMarkerProcessor

Constructors

Property in

Gets or sets the that is called when a set of options are ready to be shown to the user.

The Options Handler delivers an to the game. Before can be called to resume execution, must be called to indicate which was selected by the user. If is not called, an exception is thrown.

Method in Dialogue

Summary

Prepares the Dialogue that the user intends to start running a node.

public void SetNode(string startNode = DefaultStartNodeName)

Remarks

After this method is called, you call Continue() to start executing it.

If PrepareForLinesHandler has been set, it may be called when this method is invoked, as the Dialogue determines which lines may be delivered during the startNode node's execution.

Parameters