DialogueRunner

Class in Yarn.Unity

Inherits from UnityEngine.MonoBehaviour

Summary

The DialogueRunner component acts as the interface between your game and Yarn Spinner.

public class DialogueRunner : MonoBehaviour, IActionRegistration

Classes

Name	Description
StringUnityEvent	A type of UnityEngine.Events.UnityEvent that takes a single string parameter.

Fields

Name	Description
dialogueViews	The View classes that will present the dialogue to the user.
lineProvider
onCommand	A StringUnityEvent that is called when a Command is received.
onDialogueComplete	A Unity event that is called once the dialogue has completed.
onDialogueStart	A Unity event that is called when the dialogue starts running.
onNodeComplete	A Unity event that is called when a node is complete.
onNodeStart	A Unity event that is called when a node starts running.
runSelectedOptionAsLine	If true, when an option is selected, it's as though it were a line.
startAutomatically	Whether the DialogueRunner should automatically start running dialogue after the scene loads.
startNode	The name of the node to start from.
verboseLogging	If true, will print Debug.Log messages every time it enters a node, and other frequent events.
yarnProject	The YarnProject asset that should be loaded on scene start.

Methods

Name	Description
AddCommandHandler(string,System.Action)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,Delegate)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,MethodInfo)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Action)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, IEnumerator>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, Coroutine>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Action<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, IEnumerator>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, Coroutine>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Action<T1, T2>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, IEnumerator>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, Coroutine>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Action<T1, T2, T3>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, IEnumerator>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, Coroutine>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Action<T1, T2, T3, T4>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, T4, IEnumerator>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, T4, Coroutine>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Action<T1, T2, T3, T4, T5>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, IEnumerator>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, Coroutine>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Action<T1, T2, T3, T4, T5, T6>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, T6, IEnumerator>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, T6, Coroutine>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Action<T1, T2, T3, T4, T5, T6, T7>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, T6, T7, IEnumerator>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, T6, T7, Coroutine>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Action<T1, T2, T3, T4, T5, T6, T7, T8>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, T6, T7, T8, IEnumerator>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, T6, T7, T8, Coroutine>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Action<T1, T2, T3, T4, T5, T6, T7, T8, T9>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, IEnumerator>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddCommandHandler(string,System.Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, Coroutine>)	Adds a command handler. Dialogue will pause execution after the command is called.
AddFunction(string,Delegate)	Add a new function that returns a value, so that it can be called from Yarn scripts.
AddFunction(string,System.Func)	Add a new function that returns a value, so that it can be called from Yarn scripts.
AddFunction(string,System.Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, TResult>)	Add a new function that returns a value, so that it can be called from Yarn scripts.
AddFunction(string,System.Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, TResult>)	Add a new function that returns a value, so that it can be called from Yarn scripts.
AddFunction(string,System.Func<T1, TResult>)	Add a new function that returns a value, so that it can be called from Yarn scripts.
AddFunction(string,System.Func<T1, T2, TResult>)	Add a new function that returns a value, so that it can be called from Yarn scripts.
AddFunction(string,System.Func<T1, T2, T3, TResult>)	Add a new function that returns a value, so that it can be called from Yarn scripts.
AddFunction(string,System.Func<T1, T2, T3, T4, TResult>)	Add a new function that returns a value, so that it can be called from Yarn scripts.
AddFunction(string,System.Func<T1, T2, T3, T4, T5, TResult>)	Add a new function that returns a value, so that it can be called from Yarn scripts.
AddFunction(string,System.Func<T1, T2, T3, T4, T5, T6, TResult>)	Add a new function that returns a value, so that it can be called from Yarn scripts.
AddFunction(string,System.Func<T1, T2, T3, T4, T5, T6, T7, TResult>)	Add a new function that returns a value, so that it can be called from Yarn scripts.
AddFunction(string,System.Func<T1, T2, T3, T4, T5, T6, T7, T8, TResult>)	Add a new function that returns a value, so that it can be called from Yarn scripts.
Clear()	Unloads all nodes from the Dialogue .
GetTagsForNode(String)	Returns the collection of tags that the node associated with the node named nodeName.
LoadStateFromPersistentStorage(string)	Loads all variables from the requested file in persistent storage into the Dialogue Runner's variable storage.
LoadStateFromPlayerPrefs(string)	Loads all variables from the UnityEngine.PlayerPrefs object into the Dialogue Runner's variable storage.
NodeExists(string)	Returns true when a node named nodeName has been loaded.
OnViewRequestedInterrupt()	Called by a DialogueViewBase derived class from dialogueViews to inform the DialogueRunner that the user intents to proceed to the next line.
RemoveCommandHandler(string)	Removes a command handler.
RemoveFunction(string)	Remove a registered function.
SaveStateToPersistentStorage(string)	Saves all variables from variable storage into the persistent storage.
SaveStateToPlayerPrefs(string)	Saves all variables in the Dialogue Runner's variable storage into the UnityEngine.PlayerPrefs object.
SetDialogueViews(DialogueViewBase[])	Sets the dialogue views and makes sure the callback DialogueViewBase.MarkLineComplete will respond correctly.
SetInitialVariables(bool)	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.
SetProject(YarnProject)	Replaces this DialogueRunner's yarn project with the provided project.
SplitCommandText(string)	Splits input into a number of non-empty sub-strings, separated by whitespace, and grouping double-quoted strings into a single sub-string.
StartDialogue(string)	Start the dialogue from a specific node.
Stop()	Stops the Dialogue .

Properties

Name	Description
CurrentNodeName	Gets the name of the current node that is being run.
Dialogue	Gets the underlying Dialogue object that runs the Yarn code.
IsDialogueRunning	Gets a value that indicates if the dialogue is actively running.
VariableStorage	The variable storage object.