Dialogue

Class in Yarn​
Inherits from System.Object
Summary
Co-ordinates the execution of Yarn programs.
public class Dialogue : IAttributeMarkerProcessor
Constructors
Name
Description
​Dialogue(Yarn.IVariableStorage)​
Initializes a new instance of the Dialogue class.
Fields
Name
Description
​DefaultStartNodeName​
The node that execution will start from.
Methods
Name
Description
​AddProgram(Program)​
Loads the nodes from the specified Program , and adds them to the nodes already loaded.
​Continue()​
Starts, or continues, execution of the current Program.
​ExpandSubstitutions(string,IList)​
Replaces all substitution markers in a text with the given substitution list.
​GetStringIDForNode(string)​
Returns the string ID that contains the original, uncompiled source text for a node.
​GetTagsForNode(string)​
Returns the tags for the node nodeName .
​NodeExists(string)​
Gets a value indicating whether a specified node exists in the Program.
​ParseMarkup(string)​
Parses a line of text, and produces a MarkupParseResult containing the results.
​SetNode(string)​
Prepares the Dialogue that the user intends to start running a node.
​SetProgram(Program)​
Loads all nodes from the provided Program .
​SetSelectedOption(int)​
Signals to the Dialogue that the user has selected a specified Option .
​Stop()​
Immediately stops the Dialogue .
​UnloadAll()​
Unloads all nodes from the Dialogue.
Properties
Name
Description
​CommandHandler​
Gets or sets the CommandHandler that is called when a command is to be delivered to the game.
​CurrentNode​
Gets the name of the node that this Dialogue is currently executing.
​DialogueCompleteHandler​
Gets or sets the DialogueCompleteHandler that is called when the dialogue reaches its end.
​IsActive​
Gets a value indicating whether the Dialogue is currently executing Yarn instructions.
​LanguageCode​
Gets or sets the Dialogue 's locale, as an IETF BCP 47 code.
​Library​
Gets the Library that this Dialogue uses to locate functions.
​LineHandler​
Gets or sets the LineHandler that is called when a line is ready to be shown to the user.
​LogDebugMessage​
Invoked when the Dialogue needs to report debugging information.
​LogErrorMessage​
Invoked when the Dialogue needs to report an error.
​NodeCompleteHandler​
Gets or sets the NodeCompleteHandler that is called when a node is complete.
​NodeNames​
Gets the names of the nodes in the currently loaded Program.
​NodeStartHandler​
Gets or sets the NodeStartHandler that is called when a node is started.
​OptionsHandler​
Gets or sets the OptionsHandler that is called when a set of options are ready to be shown to the user.
​PrepareForLinesHandler​
Gets or sets the PrepareForLinesHandler that is called when the dialogue anticipates delivering some lines.
​VariableStorage​
Gets or sets the object that provides access to storing and retrieving the values of variables.

Name	Description
Dialogue(Yarn.IVariableStorage)	Initializes a new instance of the Dialogue class.

Name	Description
DefaultStartNodeName	The node that execution will start from.

Name	Description
AddProgram(Program)	Loads the nodes from the specified Program , and adds them to the nodes already loaded.
Continue()	Starts, or continues, execution of the current Program.
ExpandSubstitutions(string,IList)	Replaces all substitution markers in a text with the given substitution list.
GetStringIDForNode(string)	Returns the string ID that contains the original, uncompiled source text for a node.
GetTagsForNode(string)	Returns the tags for the node `nodeName` .
NodeExists(string)	Gets a value indicating whether a specified node exists in the Program.
ParseMarkup(string)	Parses a line of text, and produces a MarkupParseResult containing the results.
SetNode(string)	Prepares the Dialogue that the user intends to start running a node.
SetProgram(Program)	Loads all nodes from the provided Program .
SetSelectedOption(int)	Signals to the Dialogue that the user has selected a specified Option .
Stop()	Immediately stops the Dialogue .
UnloadAll()	Unloads all nodes from the Dialogue.

Name	Description
CommandHandler	Gets or sets the CommandHandler that is called when a command is to be delivered to the game.
CurrentNode	Gets the name of the node that this Dialogue is currently executing.
DialogueCompleteHandler	Gets or sets the DialogueCompleteHandler that is called when the dialogue reaches its end.
IsActive	Gets a value indicating whether the Dialogue is currently executing Yarn instructions.
LanguageCode	Gets or sets the Dialogue 's locale, as an IETF BCP 47 code.
Library	Gets the Library that this Dialogue uses to locate functions.
LineHandler	Gets or sets the LineHandler that is called when a line is ready to be shown to the user.
LogDebugMessage	Invoked when the Dialogue needs to report debugging information.
LogErrorMessage	Invoked when the Dialogue needs to report an error.
NodeCompleteHandler	Gets or sets the NodeCompleteHandler that is called when a node is complete.
NodeNames	Gets the names of the nodes in the currently loaded Program.
NodeStartHandler	Gets or sets the NodeStartHandler that is called when a node is started.
OptionsHandler	Gets or sets the OptionsHandler that is called when a set of options are ready to be shown to the user.
PrepareForLinesHandler	Gets or sets the PrepareForLinesHandler that is called when the dialogue anticipates delivering some lines.
VariableStorage	Gets or sets the object that provides access to storing and retrieving the values of variables.

CommandHandler

DefaultStartNodeName

Last modified 1yr ago