Field in Dialogue

Summary

The node that execution will start from.

public const string DefaultStartNodeName = "Start";

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.

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.

Class in Yarn

Inherits from System.Object

Summary

Co-ordinates the execution of Yarn programs.

public class Dialogue : ISmartVariableEvaluator

Constructors

Fields

Methods

Properties

Constructor in Dialogue

Summary

Initializes a new instance of the Dialogue class.

public Dialogue(Yarn.IVariableStorage variableStorage)

Parameters

Method in

Summary

Gets a value indicating whether nodeName is the name of a valid node group in the program.

Parameters

Returns

true if nodeName is the name of a node group; false otherwise.

Method in

Summary

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

Remarks

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

If 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

Summary

Returns the tags for the node 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

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.

Method in

Summary

Loads all nodes from the provided .

Remarks

This method replaces any existing nodes have been loaded.

Parameters

Method in

Summary

Signals to the that the user has selected a specified .

Remarks

After the Dialogue delivers an , this method must be called before is called.

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

Parameters

See Also

• : 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

Queries the Dialogue for what content could possibly run if the node group nodeGroup was run.

public IEnumerable<Saliency.ContentSaliencyOption> GetSaliencyOptionsForNodeGroup(string nodeGroup)

Remarks

This method evaluates all nodes in the given node group, and returns a ContentSaliencyOption object for each node. This object contains the current number of passing and failing 'when' clauses on the node, as well as the complexity score for that node. This is the same information that's passed to a IContentSaliencyStrategy object's QueryBestContent(IEnumerable<ContentSaliencyOption>) method. This method is read-only, and calling it will not modify any variable state.

Note that this method does not filter its output, and may include content options whose FailingConditionValueCount is greater than zero. It's up to the caller of this function to filter out these options if they're not wanted.

This method can be used to see if any content will appear when a given node group is run. If the collection returned by this method is empty, then running this node group will not result in any content. This can be used, for example, to decide whether to show a 'character can be spoken to' indicator. You can also examine the individal ContentSaliencyOption objects to see if any content is available that passes a filter, such as whether content might appear that has a user-defined 'plot critical' tag.

Parameters

Returns

A collection of ContentSaliencyOption objects that may appear if and when the node group nodeGroup is run.

Method in Dialogue

Summary

Immediately stops the Dialogue .

public void Stop()

Method in Dialogue

Summary

Evaluate the value of a smart variable named name .

public bool TryGetSmartVariable<T>(string name, out T result)

Parameters

Type Parameters

Returns

true if the smart variable was evaluated, false otherwise.

Property in Dialogue

Summary

Gets or sets the content saliency strategy used by this Dialogue .

public Saliency.IContentSaliencyStrategy ContentSaliencyStrategy
{
            get; set; }

Remarks

A content saliency strategy is a class that implements IContentSaliencyStrategy and selects the most appropriate content in a line group, or any other situation where content saliency is relevant.

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

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 .

Method in Dialogue

Summary

Unloads all nodes from the Dialogue.

public void UnloadAll()

Property in Dialogue

Summary

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

public DialogueCompleteHandler DialogueCompleteHandler
{
            get; set; }

Property in

Summary

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

Property in

Summary

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

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

Summary

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

Property in

Summary

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

Remarks

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.

Property in

Summary

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

Property in

Summary

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

Property in

Summary

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

Property in

Summary

Invoked when the Dialogue needs to report an error.

Property in

Summary

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