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...
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|---|
string
commandName
The name of the command.
handler
The CommandHandler that will be invoked when the command is called.
MethodInfo
method
The method that will be invoked when the command is called.
Field in DialogueRunner
A StringUnityEvent that is called when a Command is received.
Use this method to dispatch a command to other parts of your game. This method is only called if the Command has not been handled by a command handler that has been added to the DialogueRunner, or by a method on a UnityEngine.MonoBehaviour
in the scene with the attribute YarnCommandAttribute.
When a command is delivered in this way, the DialogueRunner will not pause execution. If you want a command to make the DialogueRunner pause execution, see AddCommandHandler(string, CommandHandler)
.
This method receives the full text of the command, as it appears between the <<
and >>
markers.
AddCommandHandler(string, CommandHandler)
AddCommandHandler(string, CommandHandler)
YarnCommandAttribute: An attribute that marks a method on an object as a command.
Field in
: Gets or sets the that is called when the dialogue reaches its end.
Property in DialogueRunner
Gets the name of the current node that is being run.
Dialogue.currentNode
Method in DialogueRunner
This method is obsolete and may be removed from a future version of Yarn Spinner.
Saves all variables in the Dialogue Runner's variable storage into the UnityEngine.PlayerPrefs
object.
This method serializes all variables in VariableStorage into a string containing JSON, and then stores that string in the UnityEngine.PlayerPrefs
object under the key SaveKey
.
The stored information can be restored via the LoadStateFromPlayerPrefs(string) method.
VariableStorageBehaviour.GetAllVariables(): Provides a unified interface for exporting all variables. Intended to be a point for custom saving, editors, etc.
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Method in DialogueRunner
Add a new function that returns a value, so that it can be called from Yarn scripts.
When this function has been registered, it can be called from your Yarn scripts like so:
The call
command can also be used to invoke the function:
Library: A collection of functions that can be called from Yarn programs.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Field in
Field in
Field in
This value is used to select a node to start from when is called.
Field in
The node specified by will be used.
Field in
: Gets or sets the that is called when a node is started.
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
Field in
: Gets or sets the that is called when a node is complete.
string
SaveKey
The key to use when storing the variables.
string
commandName
The name of the command.
Func<T1, T2, T3, T4, T5, IEnumerator>
handler
The CommandHandler that will be invoked when the command is called.
Func<TResult>
implementation
The System.Delegate
that should be invoked when this function is called.
string
name
TResult
The type of the value that the function should return.
| The name of the command. |
|
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Class in Yarn.Unity
Inherits from UnityEngine.MonoBehaviour
The DialogueRunner component acts as the interface between your game and Yarn Spinner.
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Method in DialogueRunner
Returns the collection of tags that the node associated with the node named nodeName
.
The collection of tags associated with the node, or null
if no node with that name exists.
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
The that will be invoked when the command is called.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
Method in
Name | Description |
---|
: A collection of functions that can be called from Yarn programs.
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
string
commandName
The name of the command.
Func<T1, T2, Coroutine>
handler
The CommandHandler that will be invoked when the command is called.
string
commandName
The name of the command.
Func<IEnumerator>
handler
The CommandHandler that will be invoked when the command is called.
A type of UnityEngine.Events.UnityEvent
that takes a single string parameter.
The View classes that will present the dialogue to the user.
A StringUnityEvent that is called when a Command is received.
A Unity event that is called once the dialogue has completed.
A Unity event that is called when the dialogue starts running.
A Unity event that is called when a node is complete.
A Unity event that is called when a node starts running.
If true, when an option is selected, it's as though it were a line.
Whether the DialogueRunner should automatically start running dialogue after the scene loads.
The name of the node to start from.
If true, will print Debug.Log messages every time it enters a node, and other frequent events.
The YarnProject asset that should be loaded on scene start.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Adds a command handler. Dialogue will pause execution after the command is called.
Add a new function that returns a value, so that it can be called from Yarn scripts.
Add a new function that returns a value, so that it can be called from Yarn scripts.
Add a new function that returns a value, so that it can be called from Yarn scripts.
Add a new function that returns a value, so that it can be called from Yarn scripts.
Add a new function that returns a value, so that it can be called from Yarn scripts.
Add a new function that returns a value, so that it can be called from Yarn scripts.
Add a new function that returns a value, so that it can be called from Yarn scripts.
Add a new function that returns a value, so that it can be called from Yarn scripts.
Add a new function that returns a value, so that it can be called from Yarn scripts.
Add a new function that returns a value, so that it can be called from Yarn scripts.
Add a new function that returns a value, so that it can be called from Yarn scripts.
Add a new function that returns a value, so that it can be called from Yarn scripts.
Unloads all nodes from the Dialogue .
Returns the collection of tags that the node associated with the node named nodeName
.
Loads all variables from the requested file in persistent storage into the Dialogue Runner's variable storage.
Loads all variables from the UnityEngine.PlayerPrefs
object into the Dialogue Runner's variable storage.
Returns true
when a node named nodeName
has been loaded.
Called by a DialogueViewBase derived class from dialogueViews to inform the DialogueRunner that the user intents to proceed to the next line.
Removes a command handler.
Remove a registered function.
Saves all variables from variable storage into the persistent storage.
Saves all variables in the Dialogue Runner's variable storage into the UnityEngine.PlayerPrefs
object.
Sets the dialogue views and makes sure the callback DialogueViewBase.MarkLineComplete
will respond correctly.
Loads any initial variables declared in the program and loads that variable with its default declaration value into the variable storage. Any variable that is already in the storage will be skipped, the assumption is that this means the value has been overridden at some point and shouldn't be otherwise touched. Can force an override of the existing values with the default if that is desired.
Replaces this DialogueRunner's yarn project with the provided project.
Splits input into a number of non-empty sub-strings, separated by whitespace, and grouping double-quoted strings into a single sub-string.
Start the dialogue from a specific node.
Stops the Dialogue .
Gets the name of the current node that is being run.
Gets the underlying Dialogue object that runs the Yarn code.
Gets a value that indicates if the dialogue is actively running.
The variable storage object.
string
commandName
The name of the command.
Action
handler
The CommandHandler that will be invoked when the command is called.
string
commandName
The name of the command.
Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, IEnumerator>
handler
The CommandHandler that will be invoked when the command is called.
string
nodeName
The name of the node.
string
commandName
The name of the command.
Func<Coroutine>
handler
The CommandHandler that will be invoked when the command is called.
string
commandName
The name of the command.
Func<T1, T2, T3, IEnumerator>
handler
The CommandHandler that will be invoked when the command is called.
| The |
|
| The name of the command. |
|
| The name of the command. |
|
| The name of the command. |
|
| The name of the command. |
|
| The name of the command. |
|
| The name of the command. |
|
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
The that will be invoked when the command is called.
The that will be invoked when the command is called.
The that will be invoked when the command is called.
The that will be invoked when the command is called.
The that will be invoked when the command is called.
The that will be invoked when the command is called.
Name | Description |
---|---|
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
string
commandName
The name of the command.
Func<T1, T2, T3, Coroutine>
handler
The CommandHandler that will be invoked when the command is called.
| The name of the command. |
|
| The name of the command. |
|
| The name of the command. |
|
| The name of the command. |
|
| The name of the command. |
|
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Method in DialogueRunner
Loads any initial variables declared in the program and loads that variable with its default declaration value into the variable storage. Any variable that is already in the storage will be skipped, the assumption is that this means the value has been overridden at some point and shouldn't be otherwise touched. Can force an override of the existing values with the default if that is desired.
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
The that will be invoked when the command is called.
The that will be invoked when the command is called.
The that will be invoked when the command is called.
The that will be invoked when the command is called.
The that will be invoked when the command is called.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
string
commandName
The name of the command.
Action<T1, T2, T3, T4, T5>
handler
The CommandHandler that will be invoked when the command is called.
bool
overrideExistingValues
string
commandName
The name of the command.
Func<T1, T2, T3, T4, T5, T6, Coroutine>
handler
The CommandHandler that will be invoked when the command is called.
string
commandName
The name of the command.
Action<T1, T2, T3, T4, T5, T6>
handler
The CommandHandler that will be invoked when the command is called.
string
commandName
The name of the command.
Func<T1, T2, T3, T4, T5, T6, T7, IEnumerator>
handler
The CommandHandler that will be invoked when the command is called.
string
commandName
The name of the command.
Func<T1, T2, T3, T4, T5, T6, T7, Coroutine>
handler
The CommandHandler that will be invoked when the command is called.
| The name of the command. |
|
| The name of the command. |
|
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
The that will be invoked when the command is called.
The that will be invoked when the command is called.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
string
commandName
The name of the command.
Func<T1, T2, T3, T4, T5, T6, T7, T8, IEnumerator>
handler
The CommandHandler that will be invoked when the command is called.
string
commandName
The name of the command.
Action<T1, T2, T3, T4, T5, T6, T7, T8>
handler
The CommandHandler that will be invoked when the command is called.
string
commandName
The name of the command.
Action<T1, T2, T3, T4, T5, T6, T7, T8, T9>
handler
The CommandHandler that will be invoked when the command is called.
| The name of the command. |
|
The that will be invoked when the command is called.
Method in
Name | Description |
---|
Name | Description |
---|
: A collection of functions that can be called from Yarn programs.
Method in
Name | Description |
---|
Name | Description |
---|
: A collection of functions that can be called from Yarn programs.
Method in
Name | Description |
---|
Name | Description |
---|
: A collection of functions that can be called from Yarn programs.
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
Method in
Name | Description |
---|
Name | Description |
---|
: A collection of functions that can be called from Yarn programs.
Method in
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Name | Description |
---|
Method in
Name | Description |
---|
Name | Description |
---|
: A collection of functions that can be called from Yarn programs.
Method in
Name | Description |
---|
Name | Description |
---|
: A collection of functions that can be called from Yarn programs.
| The |
|
TResult | The type of the value that the function should return. |
T1 | The type of the first parameter to the function. |
| The |
|
TResult | The type of the value that the function should return. |
T1 | The type of the first parameter to the function. |
T2 | The type of the second parameter to the function. |
T3 | The type of the third parameter to the function. |
T4 | The type of the fourth parameter to the function. |
T5 | The type of the fifth parameter to the function. |
T6 | The type of the sixth parameter to the function. |
T7 | The type of the seventh parameter to the function. |
T8 | The type of the eighth parameter to the function. |
T9 | The type of the ninth parameter to the function. |
| The |
|
TResult | The type of the value that the function should return. |
T1 | The type of the first parameter to the function. |
T2 | The type of the second parameter to the function. |
| The |
|
TResult | The type of the value that the function should return. |
T1 | The type of the first parameter to the function. |
T2 | The type of the second parameter to the function. |
T3 | The type of the third parameter to the function. |
T4 | The type of the fourth parameter to the function. |
T5 | The type of the fifth parameter to the function. |
T6 | The type of the sixth parameter to the function. |
T7 | The type of the seventh parameter to the function. |
T8 | The type of the eighth parameter to the function. |
T9 | The type of the ninth parameter to the function. |
T10 | The type of the tenth parameter to the function. |
| The |
|
TResult | The type of the value that the function should return. |
T1 | The type of the first parameter to the function. |
T2 | The type of the second parameter to the function. |
T3 | The type of the third parameter to the function. |
T4 | The type of the fourth parameter to the function. |
T5 | The type of the fifth parameter to the function. |
| The |
|
TResult | The type of the value that the function should return. |
T1 | The type of the first parameter to the function. |
T2 | The type of the second parameter to the function. |
T3 | The type of the third parameter to the function. |
| The name of the command. |
|
| The name of the command. |
|
Method in DialogueRunner
Add a new function that returns a value, so that it can be called from Yarn scripts.
When this function has been registered, it can be called from your Yarn scripts like so:
The call
command can also be used to invoke the function:
Library: A collection of functions that can be called from Yarn programs.
Method in DialogueRunner
Add a new function that returns a value, so that it can be called from Yarn scripts.
When this function has been registered, it can be called from your Yarn scripts like so:
The call
command can also be used to invoke the function:
Library: A collection of functions that can be called from Yarn programs.
Method in DialogueRunner
Loads all variables from the requested file in persistent storage into the Dialogue Runner's variable storage.
This method loads the file saveFileName
from the persistent data storage and attempts to read it as JSON. This is then deserialised and loaded into the VariableStorage.
The loaded information can be stored via the SaveStateToPersistentStorage(string) method.
true
if the variables were successfully loaded from the player preferences; false
otherwise.
Method in DialogueRunner
Add a new function that returns a value, so that it can be called from Yarn scripts.
When this function has been registered, it can be called from your Yarn scripts like so:
The call
command can also be used to invoke the function:
Library: A collection of functions that can be called from Yarn programs.
This method is obsolete and may be removed from a future version of Yarn Spinner.
Loads all variables from the UnityEngine.PlayerPrefs
object into the Dialogue Runner's variable storage.
true
if the variables were successfully loaded from the player preferences; false
otherwise.
The that will be invoked when the command is called.
The that will be invoked when the command is called.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Method in
Name | Description |
---|
: Add a new function that returns a value, so that it can be called from Yarn scripts.
Method in
This method loads a string containing JSON from the UnityEngine.PlayerPrefs
object under the key SaveKey
, deserializes that JSON, and then uses the resulting object to set all variables in .
The loaded information can be stored via the method.
Name | Description |
---|
: Provides a unified interface for loading many variables all at once. Will override anything already in the variable storage.
Method in
Called by a derived class from to inform the that the user intents to proceed to the next line.
Method in
Name | Description |
---|
Func<T1, T2, T3, T4, T5, T6, TResult>
implementation
The System.Delegate
that should be invoked when this function is called.
string
name
TResult
The type of the value that the function should return.
T1
The type of the first parameter to the function.
T2
The type of the second parameter to the function.
T3
The type of the third parameter to the function.
T4
The type of the fourth parameter to the function.
T5
The type of the fifth parameter to the function.
T6
The type of the sixth parameter to the function.
Func<T1, T2, T3, T4, TResult>
implementation
The System.Delegate
that should be invoked when this function is called.
string
name
TResult
The type of the value that the function should return.
T1
The type of the first parameter to the function.
T2
The type of the second parameter to the function.
T3
The type of the third parameter to the function.
T4
The type of the fourth parameter to the function.
string
saveFileName
the name the save file should have on disc, including any file extension
Func<T1, T2, T3, T4, T5, T6, T7, TResult>
implementation
The System.Delegate
that should be invoked when this function is called.
string
name
TResult
The type of the value that the function should return.
T1
The type of the first parameter to the function.
T2
The type of the second parameter to the function.
T3
The type of the third parameter to the function.
T4
The type of the fourth parameter to the function.
T5
The type of the fifth parameter to the function.
T6
The type of the sixth parameter to the function.
T7
The type of the seventh parameter to the function.
| The name of the function to remove. |
| The key to use when storing the variables. |
| The name of the node. |
Method in DialogueRunner
Adds a command handler. Dialogue will pause execution after the command is called.
When this command handler has been added, it can be called from your Yarn scripts like so:
If handler
is a method that returns a UnityEngine.Coroutine
, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.
If handler
is a method that returns an System.Collections.IEnumerator
, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.
Method in DialogueRunner
Saves all variables from variable storage into the persistent storage.
This method attempts to writes the contents of VariableStorage as a JSON file and saves it to the persistent data storage under the file name saveFileName
. The saved information can be loaded via the LoadStateFromPersistentStorage(string) method.
If saveFileName
already exists, it will be overwritten, not appended.
true
if the variables were successfully written into the player preferences; false
otherwise.
Method in DialogueRunner
Splits input into a number of non-empty sub-strings, separated by whitespace, and grouping double-quoted strings into a single sub-string.
This method behaves similarly to the System.String.Split(System.Char[],System.StringSplitOptions)
method with the System.StringSplitOptions
parameter set to System.StringSplitOptions.RemoveEmptyEntries
, with the following differences:
Text that appears inside a pair of double-quote characters will not be split.
Text that appears after a double-quote character and before the end of the input will not be split (that is, an unterminated double-quoted string will be treated as though it had been terminated at the end of the input.)
When inside a pair of double-quote characters, the string \\
will be converted to \
, and the string \"
will be converted to "
.
A collection of sub-strings.
Method in DialogueRunner
Replaces this DialogueRunner's yarn project with the provided project.
Method in DialogueRunner
Sets the dialogue views and makes sure the callback DialogueViewBase.MarkLineComplete
will respond correctly.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Method in
Name | Description |
---|
Property in
Gets the underlying object that runs the Yarn code.
string
commandName
The name of the command.
Action<T1, T2>
handler
The CommandHandler that will be invoked when the command is called.
string
saveFileName
the name the save file should have on disc, including any file extension
string
commandName
The name of the command to remove.
string
input
The string to split.
Yarn.Unity.YarnProject newProject
The array of views to be assigned.
| The name of the node to start running from. |
Class in DialogueRunner
Inherits from UnityEngine.Events.UnityEvent
1`
A type of UnityEngine.Events.UnityEvent
that takes a single string parameter.
A concrete subclass of UnityEngine.Events.UnityEvent
is needed in order for Unity to serialise the type correctly.
Method in DialogueRunner
Add a new function that returns a value, so that it can be called from Yarn scripts.
When this function has been registered, it can be called from your Yarn scripts like so:
The call
command can also be used to invoke the function:
Library: A collection of functions that can be called from Yarn programs.
Name | Description |
---|---|
Name | Description |
---|---|
Func<T1, T2, T3, T4, T5, T6, T7, T8, TResult>
implementation
The System.Delegate
that should be invoked when this function is called.
string
name
TResult
The type of the value that the function should return.
T1
The type of the first parameter to the function.
T2
The type of the second parameter to the function.
T3
The type of the third parameter to the function.
T4
The type of the fourth parameter to the function.
T5
The type of the fifth parameter to the function.
T6
The type of the sixth parameter to the function.
T7
The type of the seventh parameter to the function.
T8
The type of the eighth parameter to the function.