Field in

Summary

Whether the dialogue runner will immediately start running dialogue after loading.

Field in DialogueRunner

Summary

A Unity event that is called when a node starts running.

public UnityEventString onNodeStart;

Remarks

This event receives as a parameter the name of the node that is about to start running.

See Also

• Dialogue.NodeStartHandler: Gets or sets the NodeStartHandler that is called when a node is started.

Field in

Summary

A Unity event that is called when a node is complete.

Remarks

This event receives as a parameter the name of the node that just finished running.

See Also

• : Gets or sets the that is called when a node is complete.

Field in

Summary

A Unity event that is called once the dialogue has completed.

See Also

• : Gets or sets the that is called when the dialogue reaches its end.

Field in

Summary

A Unity event that is called when the dialogue starts running.

Field in DialogueRunner

Summary

A UnityEventString that is called when a Command is received and no command handler was able to handle it.

public UnityEventString onUnhandledCommand;

Remarks

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.

This method receives the full text of the command, as it appears between the << and >> markers.

See Also

• DialogueRunner.AddCommandHandler(string,Delegate): Adds a command handler. Dialogue will pause execution after the command is called.

• YarnCommandAttribute: An attribute that marks a method on an object as a command.

Method in DialogueRunner

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

public void AddCommandHandler(string commandName, MethodInfo method);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

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.

Parameters

Field in

Summary

If this value is set, when an option is selected, the line contained in it ( ) will be delivered to the dialogue runner's dialogue views as though it had been written as a separate line.

Remarks

This allows a Yarn script to

Method in

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

Remarks

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 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.

Parameters

Field in

Summary

The name of the node that will start running immediately after loading.

Remarks

This value must be the name of a node present in .

See Also

• : Gets the asset that this dialogue runner uses.

• : Starts running a node of dialogue.

Method in DialogueRunner

Summary

Add a new function that returns a value, so that it can be called from Yarn scripts.

public void AddFunction(string name, Delegate implementation);

Remarks

When this function has been registered, it can be called from your Yarn scripts like so:

<<if myFunction(1, 2) == true>>
myFunction returned true!
<<endif>>

The call command can also be used to invoke the function:

<<call myFunction(1, 2)>>

Parameters

See Also

• Library: A collection of functions that can be called from Yarn programs.

Method in DialogueRunner

Summary

Loads all variables from the requested file in persistent storage into the Dialogue Runner's variable storage.

public bool LoadStateFromPersistentStorage(string saveFileName)

Remarks

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.

Parameters

Returns

true if the variables were successfully loaded from the player preferences; false otherwise.

Method in DialogueRunner

Summary

Loads all variables from the UnityEngine.PlayerPrefs object into the Dialogue Runner's variable storage.

public bool LoadStateFromPlayerPrefs(string SaveKey = "YarnBasicSave")

Remarks

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 VariableStorage.

The loaded information can be stored via the SaveStateToPlayerPrefs(string) method.

Parameters

Returns

true if the variables were successfully loaded from the player preferences; false otherwise.

See Also

• VariableStorageBehaviour.SetAllVariables(FloatDictionary,StringDictionary,BoolDictionary,bool): Provides a unified interface for loading many variables all at once. Will override anything already in the variable storage.

Method in DialogueRunner

Summary

Removes a command handler.

public void RemoveCommandHandler(string commandName);

Parameters

Method in DialogueRunner

Summary

Requests that all dialogue views speed up their delivery of the current line.

public void RequestHurryUpLine()

Remarks

The specific behaviour of what happens when this method is called depends on the implementation of the Dialogue Runner's current dialogue views.

If the dialogue runner is not currently running a line (for example, if it is running options, or is not running dialogue at all), this method has no effect.

Method in DialogueRunner

Summary

Remove a registered function.

public void RemoveFunction(string name);

Remarks

After a function has been removed, it cannot be called from Yarn scripts.

Parameters

See Also

• IActionRegistration.AddFunction(string,Delegate): Add a new function that returns a value, so that it can be called from Yarn scripts.

Method in DialogueRunner

Summary

Requests that all dialogue views stop showing the current line, and prepare to show the next piece of content.

public void RequestNextLine()

Remarks

The specific behaviour of what happens when this method is called depends on the implementation of the Dialogue Runner's current dialogue views.

If the dialogue runner is not currently running a line (for example, if it is running options, or is not running dialogue at all), this method has no effect.

Method in DialogueRunner

Summary

Saves all variables in the Dialogue Runner's variable storage into the UnityEngine.PlayerPrefs object.

public void SaveStateToPlayerPrefs(string SaveKey = "YarnBasicSave")

Remarks

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.

Parameters

See Also

• VariableStorageBehaviour.GetAllVariables(): Provides a unified interface for exporting all variables. Intended to be a point for custom saving, editors, etc.

Method in DialogueRunner

Summary

Saves all variables from variable storage into the persistent storage.

public bool SaveStateToPersistentStorage(string saveFileName)

Remarks

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.

Parameters

Returns

true if the variables were successfully written into the player preferences; false otherwise.

Method in DialogueRunner

Summary

Splits input into a number of non-empty sub-strings, separated by whitespace, and grouping double-quoted strings into a single sub-string.

public static IEnumerable<string> SplitCommandText(string input)

Remarks

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 ".

Parameters

Returns

A collection of sub-strings.

Method in DialogueRunner

Summary

Starts running a node of dialogue.

public void StartDialogue(string nodeName)

Remarks

nodeName must be the name of a node in YarnProject .

Parameters

Property in DialogueRunner

Summary

Gets a value that indicates if the dialogue is actively running.

public bool IsDialogueRunning { get };

Property in DialogueRunner

Summary

Gets a YarnTask that completes when the dialogue runner finishes its dialogue.

public YarnTask DialogueTask
{
            get; }

Remarks

If the dialogue is not currently running when this property is accessed, the property returns a task that is already complete.

Property in DialogueRunner

Summary

Gets or sets the collection of dialogue views attached to this dialogue runner.

public IEnumerable<AsyncDialogueViewBase?> DialogueViews
{
            get; set; }

Property in DialogueRunner

Summary

public static bool IsInPlaymode
{
            get; }

Property in DialogueRunner

Summary

Gets the internal Dialogue object that reads and executes the Yarn script.

public Dialogue Dialogue
{
            get; }

Property in DialogueRunner

Summary

Gets the ILineProvider that this dialogue runner uses to fetch localized line content.

public ILineProvider LineProvider
{
            get; }

Property in DialogueRunner

Summary

Gets the VariableStorage that this dialogue runner uses to store and access Yarn variables.

public VariableStorageBehaviour VariableStorage
{
            get; }

Class in Yarn.Unity

Inherits from UnityEngine.MonoBehaviour

Summary

public class DialogueRunner : IActionRegistration

Fields

Methods

Properties

Method in DialogueRunner

Summary

Creates a stack of typewriter pauses to use to temporarily halt the typewriter effect.

public static Stack<(int position, float duration)> GetPauseDurationsInsideLine(Markup.MarkupParseResult line)

Remarks

This is intended to be used in conjunction with the PausableTypewriter(TextMeshProUGUI,float,Action,Action,Action,Stack<(int position, float duration)>,CoroutineInterruptToken) effect. The stack of tuples created are how the typewriter effect knows when, and for how long, to halt the effect.

The pause duration property is in milliseconds but all the effects code assumes seconds So here we will be dividing it by 1000 to make sure they interconnect correctly.

Parameters

Returns

A stack of positions and duration pause tuples from within the line

Method in DialogueRunner

Summary

Sets the dialogue runner's Yarn Project.

public void SetProject(YarnProject project)

Remarks

If the dialogue runner is currently running (that is, IsDialogueRunning is true ), an System.InvalidOperationException is thrown.

Parameters

Property in

Summary

Gets the asset that this dialogue runner uses.

See Also

• : Sets the dialogue runner's Yarn Project.

Method in

Summary

Stops the dialogue immediately, and cancels any currently running dialogue views.

Property in

Summary