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...
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...
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...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Class in Yarn
Inherits from System.Object
Contains the built-in types available in the Yarn language.
Name | Description |
---|---|
Gets the type representing any value.
Gets the type representing boolean values.
Gets the type representing numbers.
Gets the type representing strings.
Gets a dictionary that maps CLR types to their corresponding Yarn types.
Property in Dialogue
Gets or sets the PrepareForLinesHandler that is called when the dialogue anticipates delivering some lines.
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 |
---|---|
Name | Description |
---|---|
Property in
Property in
Method in
Name | Description |
---|
Class in
An exception that is thrown by when there is an error in executing a .
Method in
Name | Description |
---|
Name | Description |
---|
Class in
You do not create instances of this class yourself. The class creates one of its own, which you can access via the property.
Name | Description |
---|
: Co-ordinates the execution of Yarn programs.
Field in
Field in
Property in
Property in
Class in
Name | Description |
---|
Name | Description |
---|
Name | Description |
---|
Name | Description |
---|
Struct in
A command, sent from the to the game.
You do not create instances of this struct yourself. They are created by the during program execution.
Name | Description |
---|
: Gets or sets the that is called when a command is to be delivered to the game.
Property in
Contains the built-in types available in the Yarn language.
Co-ordinates the execution of Yarn programs.
A type that represents functions.
A collection of functions that can be called from Yarn programs.
A simple concrete implementation of IVariableStorage that keeps all variables in memory.
A node of Yarn script, contained within a Program , and containing Yarn.Instruction
s.
A compiled Yarn program.
Represents the method that is called when the Dialogue delivers a Command .
Represents the method that is called when the dialogue has reached its end, and no more code remains to be run.
Represents the method that is called when the Dialogue delivers a Line .
Represents a method that receives diagnostic messages and error information from a Dialogue .
Represents the method that is called when the Dialogue reaches the end of a node.
Represents the method that is called when the Dialogue begins executing a node.
Represents the method that is called when the Dialogue delivers an OptionSet .
Represents the method that is called when the dialogue anticipates that it will deliver lines.
Defines properties that describe a type in the Yarn language.
Provides a mechanism for storing and retrieving instances of the Yarn.Value
class.
Contains classes for compiling Yarn code.
Contains classes for working with markup in Yarn lines.
Contains classes for working with Yarn Spinner in the Unity game engine.
A command, sent from the Dialogue to the game.
A line of dialogue, sent from the Dialogue to the game.
| The text containing substitution markers. |
| The list of substitutions. |
| The name of the function. |
| The method to be invoked when the function is called. |
TResult | The return type of the function. |
TResult | The return type of the function. |
T1 | The type of the function's first argument. |
T2 | The type of the function's second argument. |
T3 | The type of the function's third argument. |
T4 | The type of the function's fourth argument. |
T5 | The type of the function's fifth argument. |
Removes a function from the Library. |
Returns a |
Registers a new function that returns a value, which can be called from a Yarn program. |
Registers a new function that returns a value, which can be called from a Yarn program. |
Registers a new function that returns a value, which can be called from a Yarn program. |
Registers a new function that returns a value, which can be called from a Yarn program. |
Registers a new function that returns a value, which can be called from a Yarn program. |
Registers a new function that returns a value, which can be called from a Yarn program. |
Registers a new function that returns a value, which can be called from a Yarn program. |
The node that execution will start from. |
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 |
Gets a value indicating whether a specified node exists in the Program. |
Unloads all nodes from the Dialogue. |
Gets the name of the node that this Dialogue is currently executing. |
Gets a value indicating whether the Dialogue is currently executing Yarn instructions. |
Invoked when the Dialogue needs to report debugging information. |
Invoked when the Dialogue needs to report an error. |
Gets the names of the nodes in the currently loaded Program. |
Gets or sets the object that provides access to storing and retrieving the values of variables. |
Gets the text of the command. |
Method in Library
Registers a new function that returns a value, which can be called from a Yarn program.
Method in Dialogue
Returns the string ID that contains the original, uncompiled source text for a node.
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.
The string ID.
Gets a value indicating whether this contains a function named name
.
Loads functions from another .
Initializes a new instance of the class.
Loads the nodes from the specified , and adds them to the nodes already loaded.
Parses a line of text, and produces a containing the results.
Prepares the that the user intends to start running a node.
Loads all nodes from the provided .
Signals to the that the user has selected a specified .
Immediately stops the .
Gets or sets the that is called when a command is to be delivered to the game.
Gets or sets the that is called when the dialogue reaches its end.
Gets or sets the 's locale, as an IETF BCP 47 code.
Gets the that this Dialogue uses to locate functions.
Gets or sets the that is called when a line is ready to be shown to the user.
Gets or sets the that is called when a node is complete.
Gets or sets the that is called when a node is started.
Gets or sets the that is called when a set of options are ready to be shown to the user.
Gets or sets the that is called when the dialogue anticipates delivering some lines.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Constructor in
Initializes a new instance of the class.
Name | Description |
---|
Class in
A simple concrete implementation of that keeps all variables in memory.
Name | Description |
---|
Method in
Name | Description |
---|
Method in
Name | Description |
---|
Method in
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.
The is called. When this occurs, the Dialogue is waiting for the user to specify which of the options has been selected, and must be called before is called again.)
The Program reaches its end. When this occurs, must be called before is called again.
This method has no effect if it is called while the is currently in the process of executing instructions.
: Represents the method that is called when the Dialogue delivers a .
: Represents the method that is called when the Dialogue delivers an .
: Represents the method that is called when the Dialogue delivers a .
: Represents the method that is called when the Dialogue reaches the end of a node.
: Represents the method that is called when the dialogue has reached its end, and no more code remains to be run.
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
Name | Description |
---|
Delegate in
Represents the method that is called when the Dialogue delivers a .
Name | Description |
---|
: Represents the method that is called when the Dialogue delivers a .
: Represents the method that is called when the Dialogue delivers an .
: Represents the method that is called when the Dialogue begins executing a node.
: Represents the method that is called when the Dialogue reaches the end of a node.
: Represents the method that is called when the dialogue has reached its end, and no more code remains to be run.
string
name
The name of the function.
System.Func<T1, T2, T3, T4, TResult>
implementation
The method to be invoked when the function is called.
TResult
The return type of the function.
TResult
The return type of the function.
T1
The type of the function's first argument.
T2
The type of the function's second argument.
T3
The type of the function's third argument.
T4
The type of the function's fourth argument.
string
nodeName
The name of the node.
| The name to associate with this variable. |
| The string to store. |
| The name of the node. |
| The name of the node. |
Method in Dialogue
Immediately stops the Dialogue .
The DialogueCompleteHandler will not be called if the dialogue is ended by calling Stop() .
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.
Removes all variables from storage. |
Stores a |
Stores a |
Stores a |
Retrieves a value of type |
The additional program to load. |
Method in Dialogue
Loads all nodes from the provided Program .
This method replaces any existing nodes have been loaded. If you want to load nodes from an additional Program, use the AddProgram(Program) method.
Method in Dialogue
Prepares the Dialogue that the user intends to start running a node.
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.
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.
Method in Dialogue
Parses a line of text, and produces a MarkupParseResult containing the results.
The MarkupParseResult 's Text will have any select
, plural
or ordinal
markers replaced with the appropriate text, following this Dialogue 's LanguageCode .
The results of parsing the markup.
variableStorage
The that this Dialogue should use.
program
command
The that has been delivered.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Property in
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
Property in
Gets or sets the that is called when a node is complete.
Property in
Yarn.Program program
The Program to use.
string
startNode
The name of the node that will be run. The node have been loaded by calling SetProgram(Program) or AddProgram(Program) .
int
selectedOptionID
The ID number of the Option that the user selected.
string
line
The line of text to parse.
Property in Dialogue
Gets or sets the LineHandler that is called when a line is ready to be shown to the user.
Delegate in Yarn
Inherits from System.MulticastDelegate
Represents the method that is called when the dialogue has reached its end, and no more code remains to be run.
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 .
NodeStartHandler: Represents the method that is called when the Dialogue begins executing a node.
NodeCompleteHandler: Represents the method that is called when the Dialogue reaches the end of a node.
Class in Yarn
Inherits from System.Object
A type that represents functions.
Functions have parameters and a return type, and can be called from script. Instances of this type are created when the host application registers new functions (such as through using the RegisterFunction(string,Delegate) methods or similar.)
Name | Description |
---|---|
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.
Gets a more verbose description of this type.
Gets the collection of methods that are available on this type.
Gets the name of this type.
Gets the list of the parameter types that this function is called with.
Gets the parent of this type.
Gets the type of value that this function returns.
Property in FunctionType
Gets the parent of this type.
All types have Any as their ultimate parent type (except for Any itself.)
Property in
Interface in
Name | Description |
---|
Property in
Property in
All types have as their ultimate parent type (except for itself.)
Property in
Interface in
Name | Description |
---|
Removes all variables from storage. |
Stores a |
Stores a |
Stores a |
Retrieves a value of type |
Gets a more verbose description of this type. |
Gets the collection of methods that are available on this type. |
Gets the name of this type. |
Gets the parent of this type. |
Method in IVariableStorage
Retrieves a value of type T
by name.
true
if a value named variableName
of type T
was retrieved; false
otherwise.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Method in
Name | Description |
---|
Method in
Loads functions from another .
Name | Description |
---|
Method in
Name | Description |
---|
string
variableName
The name to associate with this variable.
bool
boolValue
The boolean value to store.
string
variableName
The name of the variable to retrieve the value of.
T
result
On return, if this method returned true, contains the retrieved value. If this method returned false, contains the default value of T
(for example, 0
for float
values, null
for strings, and so on.)
T
The type of the variable to retrieve.
string
variableName
The name to associate with this variable.
string
stringValue
The string to store.
| The name to associate with this variable. |
| The number to store. |
| The name of the function to remove. |
The library to import functions from. |
Method in Library
Returns a System.Delegate
with a given name.
The System.Delegate
.
Method in Library
Registers a new function that returns a value, which can be called from a Yarn program.
Method in Library
Registers a new function that returns a value, which can be called from a Yarn program.
otherLibrary
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Method in
Name | Description |
---|
Name | Description |
---|
Method in
Name | Description |
---|
Name | Description |
---|
string
name
The name of the function to retrieve.
string
name
The name of the function to look for.
string
name
The name of the function.
System.Func<TResult>
implementation
The method to be invoked when the function is called.
TResult
The return type of the function.
string
name
The name of the function.
System.Func<T1, TResult>
implementation
The method to be invoked when the function is called.
TResult
The return type of the function.
TResult
The return type of the function.
T1
The type of the function's first argument.
| The name of the function. |
| The method to be invoked when the function is called. |
TResult | The return type of the function. |
TResult | The return type of the function. |
T1 | The type of the function's first argument. |
T2 | The type of the function's second argument. |
| The name of the function. |
| The method to be invoked when the function is called. |
TResult | The return type of the function. |
Method in Library
Registers a new function that returns a value, which can be called from a Yarn program.
Struct in Yarn
Inherits from System.ValueType
A line of dialogue, sent from the Dialogue to the game.
When the game receives a Line, it should do the following things to prepare the line for presentation to the user.
Use the value in the ID field to look up the appropriate user-facing text in the string table.
Use ExpandSubstitutions(string,IList<string>) to replace all substitutions in the user-facing text.
Use ParseMarkup(string) to parse all markup in the line.
You do not create instances of this struct yourself. They are created by the Dialogue during program execution.
Dialogue.LineHandler: Gets or sets the LineHandler that is called when a line is ready to be shown to the user.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Method in
Name | Description |
---|
Delegate in
Represents the method that is called when the Dialogue delivers a .
Name | Description |
---|
: Represents the method that is called when the Dialogue delivers an .
: Represents the method that is called when the Dialogue delivers a .
: Represents the method that is called when the Dialogue begins executing a node.
: Represents the method that is called when the Dialogue reaches the end of a node.
: Represents the method that is called when the dialogue has reached its end, and no more code remains to be run.
Class in
A node of Yarn script, contained within a , and containing Yarn.Instruction
s.
Name | Description |
---|
Name | Description |
---|
string
name
The name of the function.
System.Func<T1, T2, T3, TResult>
implementation
The method to be invoked when the function is called.
TResult
The return type of the function.
TResult
The return type of the function.
T1
The type of the function's first argument.
T2
The type of the function's second argument.
T3
The type of the function's third argument.
The string ID for this line.
The values that should be inserted into the user-facing text before delivery.
string
message
The text that should be logged.
string
variableName
The name to associate with this variable.
float
floatValue
The number to store.
| The name to associate with this variable. |
| The boolean value to store. |
Property in Node
A jump table, mapping the names of labels to positions in the instructions list.
Property in Node
the entry in the program's string table that contains the original text of this node; null if this is not available
The list of instructions in this node. |
A jump table, mapping the names of labels to positions in the instructions list. |
The name of this node. |
the entry in the program's string table that contains the original text of this node; null if this is not available |
The tags associated with this node. |
Delegate in Yarn
Inherits from System.MulticastDelegate
Represents the method that is called when the Dialogue reaches the end of a node.
This method may be called multiple times over the course of code execution. A node being complete does not necessarily represent the end of the conversation.
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 .
NodeStartHandler: Represents the method that is called when the Dialogue begins executing 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 MemoryVariableStore
Retrieves a value of type T
by name.
true
if a value named variableName
of type T
was retrieved; false
otherwise.
Delegate in Yarn
Inherits from System.MulticastDelegate
Represents the method that is called when the Dialogue begins executing a node.
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.
line
The that has been delivered.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Property in
When the user selects this option, this value should be used as the parameter for .
Struct in
Name | Description |
---|
string
completedNodeName
The name of the node.
string
variableName
The name of the variable to retrieve the value of.
T
result
On return, if this method returned true, contains the retrieved value. If this method returned false, contains the default value of T
(for example, 0
for float
values, null
for strings, and so on.)
T
The type of the variable to retrieve.
string
startedNodeName
The name of the node.
Property in Option
Gets a value indicating whether the player should be permitted to select this option.
If this value is false
, this option had a line condition on it that failed. The option will still be delivered to the game, but, depending on the needs of the game, the game may decide to not allow the player to select it, or not offer it to the player at all.
This is intended for situations where games wish to show options that the player _could_ have taken, if some other condition had been met (e.g. having enough "charisma" points).
Gets the name of the node that will be run if this option is selected. |
Gets the identifying number for this option. |
Gets a value indicating whether the player should be permitted to select this option. |
Struct in Yarn
Inherits from System.ValueType
A set of Option s, sent from the Dialogue to the game.
You do not create instances of this struct yourself. They are created by the Dialogue during program execution.
Dialogue.OptionsHandler: Gets or sets the OptionsHandler that is called when a set of options are ready to be shown to the user.
Gets the that should be presented to the user for this option.
Name | Description |
---|---|
Name | Description |
---|---|
Delegate in
Represents the method that is called when the Dialogue delivers an .
Name | Description |
---|
: Represents the method that is called when the Dialogue delivers a .
: Represents the method that is called when the Dialogue delivers a .
: Represents the method that is called when the Dialogue begins executing a node.
: Represents the method that is called when the Dialogue reaches the end of a node.
: Represents the method that is called when the dialogue has reached its end, and no more code remains to be run.
Property in
Gets the Option s that should be presented to the user.
An option to be presented to the user.
options
The that has been delivered.