Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Class in Yarn
Inherits from System.Object
Co-ordinates the execution of Yarn programs.
Replaces all substitution markers in a text with the given substitution list.
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.
text
, with the content from substitutions
inserted.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Field in
Constructor in
Initializes a new instance of the class.
Name | Description |
---|
Method in
Name | Description |
---|
Initializes a new instance of the Dialogue class.
The node that execution will start from.
Loads the nodes from the specified Program , and adds them to the nodes already loaded.
Starts, or continues, execution of the current Program.
Replaces all substitution markers in a text with the given substitution list.
Returns the string ID that contains the original, uncompiled source text for a node.
Returns the tags for the node nodeName
.
Gets a value indicating whether a specified node exists in the Program.
Parses a line of text, and produces a MarkupParseResult containing the results.
Prepares the Dialogue that the user intends to start running a node.
Loads all nodes from the provided Program .
Immediately stops the Dialogue .
Unloads all nodes from the Dialogue.
Gets or sets the CommandHandler that is called when a command is to be delivered to the game.
Gets the name of the node that this Dialogue is currently executing.
Gets or sets the DialogueCompleteHandler that is called when the dialogue reaches its end.
Gets a value indicating whether the Dialogue is currently executing Yarn instructions.
Gets or sets the Dialogue 's locale, as an IETF BCP 47 code.
Gets the Library that this Dialogue uses to locate functions.
Gets or sets the LineHandler that is called when a line is ready to be shown to the user.
Invoked when the Dialogue needs to report debugging information.
Invoked when the Dialogue needs to report an error.
Gets or sets the NodeCompleteHandler that is called when a node is complete.
Gets the names of the nodes in the currently loaded Program.
Gets or sets the NodeStartHandler that is called when a node is started.
Gets or sets the OptionsHandler that is called when a set of options are ready to be shown to the user.
Gets or sets the PrepareForLinesHandler that is called when the dialogue anticipates delivering some lines.
Gets or sets the object that provides access to storing and retrieving the values of variables.
| The text containing substitution markers. |
| The list of substitutions. |
Method in Dialogue
Starts, or continues, execution of the current Program.
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.
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.
Property in Dialogue
Gets or sets the LineHandler that is called when a line is ready to be shown to the user.
Method in Dialogue
Returns the tags for the node nodeName
.
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.
The node's tags, or null
if the node is not present in the Program.
variableStorage
The that this Dialogue should use.
Name | Description |
---|---|
Method in
Loads the nodes from the specified , and adds them to the nodes already loaded.
If Yarn.Dialogue.Program
is null
, this method has the effect as calling .
Name | Description |
---|
Method in
Immediately stops the .
Property in
Gets or sets the that is called when a node is started.
Method in
Because the 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.
Name | Description |
---|
Method in
Loads all nodes from the provided .
This method replaces any existing nodes have been loaded. If you want to load nodes from an additional Program, use the method.
Name | Description |
---|
Method in
Prepares the that the user intends to start running a node.
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.
Name | Description |
---|
Method in
Method in
Parses a line of text, and produces a containing the results.
The 's will have any select
, plural
or ordinal
markers replaced with the appropriate text, following this 's .
Name | Description |
---|
Method in
Name | Description |
---|
string
nodeName
The name of the node.
| The name of the node. |
| The line of text to parse. |
| The name of the node. |
Property in Dialogue
Gets a value indicating whether the Dialogue is currently executing Yarn instructions.
Property in Dialogue
Gets the name of the node that this Dialogue is currently executing.
If Continue() has never been called, this value will be null
.
Property in Dialogue
Gets or sets the CommandHandler that is called when a command is to be delivered to the game.
The additional program to load. |
|
program
program
The to use.
The name of the node that will be run. The node have been loaded by calling or .
Property in
Gets or sets the that is called when the dialogue reaches its end.
Property in Dialogue
Gets or sets the NodeCompleteHandler that is called when a node is complete.
Method in Dialogue
Signals to the Dialogue that the user has selected a specified Option .
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.
OptionsHandler: Represents the method that is called when the Dialogue delivers an OptionSet .
Dialogue.Continue(): Starts, or continues, execution of the current Program.
Name | Description |
---|---|
Property in
int
selectedOptionID
The ID number of the Option that the user selected.
Property in Dialogue
Gets or sets the PrepareForLinesHandler that is called when the dialogue anticipates delivering some lines.
Property in Dialogue
Gets or sets the object that provides access to storing and retrieving the values of variables.
Property in Dialogue
Gets or sets the OptionsHandler that is called when a set of options are ready to be shown to the user.
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.