Constructor in Dialogue

Summary

Initializes a new instance of the Dialogue class.

public Dialogue(Yarn.IVariableStorage variableStorage)

Parameters

Method in Dialogue

Summary

Starts, or continues, execution of the current Program.

public void Continue()

Remarks

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

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

• The OptionsHandler is called. When this occurs, the Dialogue is waiting for the user to specify which of the options has been selected, and SetSelectedOption(int) must be called before Continue() is called again.)

• The Program reaches its end. When this occurs, SetNode(string) must be called before Continue() is called again.

• An error occurs while executing the Program.

This method has no effect if it is called while the Dialogue is currently in the process of executing instructions.

See Also

• LineHandler: Represents the method that is called when the Dialogue delivers a Line .

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

• CommandHandler: Represents the method that is called when the Dialogue delivers a Command .

• NodeCompleteHandler: Represents the method that is called when the Dialogue reaches the end of a node.

• DialogueCompleteHandler: Represents the method that is called when the dialogue has reached its end, and no more code remains to be run.

Field in Dialogue

Summary

The node that execution will start from.

public const string DefaultStartNodeName = "Start";

Method in

Summary

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

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

Returns

text , with the content from substitutions inserted.

Method in

Summary

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

Remarks

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

Parameters

Class in

Inherits from System.Object

Summary

Co-ordinates the execution of Yarn programs.

Constructors

Fields

Methods

Properties

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

Returns

The string ID.

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

Returns

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

Method in Dialogue

Summary

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

public bool NodeExists(string nodeName)

Parameters

Returns

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

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

Returns

The results of parsing the markup.

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

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

Property in Dialogue

Summary

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

public DialogueCompleteHandler DialogueCompleteHandler
{
            get; set; }

Method in Dialogue

Summary

Unloads all nodes from the Dialogue.

public void UnloadAll()

Method in Dialogue

Summary

Immediately stops the Dialogue .

public void Stop()

Remarks

The DialogueCompleteHandler will not be called if the dialogue is ended by calling Stop() .

Property in Dialogue

Summary

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

public CommandHandler CommandHandler
{
            get; set; }

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

See Also

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

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

• Dialogue.Continue(): Starts, or continues, execution of the current Program.

Property in Dialogue

Summary

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

public bool IsActive { get };

Property in Dialogue

Summary

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

public LineHandler LineHandler
{
            get; set; }

Property in

Summary

Gets the that this Dialogue uses to locate functions.

Remarks

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

Property in

Summary

Invoked when the Dialogue needs to report debugging information.

Property in Dialogue

Summary

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

public string LanguageCode { get; set; }

Remarks

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 Dialogue

Summary

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

public string CurrentNode
{
            get; }

Remarks

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

Property in Dialogue

Summary

Invoked when the Dialogue needs to report an error.

public Logger LogErrorMessage { get; set; }

Property in Dialogue

Summary

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

public IEnumerable<string> NodeNames
{
            get; }

Property in Dialogue

Summary

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

public NodeCompleteHandler NodeCompleteHandler
{
            get; set; }

Property in Dialogue

Summary

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

public NodeStartHandler NodeStartHandler
{
            get; set; }

Property in Dialogue

Summary

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

public PrepareForLinesHandler PrepareForLinesHandler
{
            get; set; }

Property in Dialogue

Summary

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

public IVariableStorage VariableStorage { get; set; }

Property in Dialogue

Summary

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

public OptionsHandler OptionsHandler
{
            get; set; }

Remarks

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