Field in DialogueRunner

Summary

A StringUnityEvent that is called when a Command is received.

public StringUnityEvent onCommand;

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

• AddCommandHandler(string, CommandHandler)

• AddCommandHandler(string, CommandHandler)

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

Field in DialogueRunner

Summary

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

public UnityEvent onDialogueComplete;

See Also

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

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

Fields

Methods

Properties

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

Field in

Summary

If true, when an option is selected, it's as though it were a line.

Field in

Summary

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

Remarks

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

See Also

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

Field in

Summary

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

Field in

Summary

If true, will print Debug.Log messages every time it enters a node, and other frequent events.

Field in DialogueRunner

Summary

The YarnProject asset that should be loaded on scene start.

public YarnProject yarnProject;

Field in DialogueRunner

Summary

Whether the DialogueRunner should automatically start running dialogue after the scene loads.

public bool startAutomatically = true;

Remarks

The node specified by startNode will be used.

Method in DialogueRunner

Summary

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

public void AddCommandHandler(string commandName, System.Func<IEnumerator> handler);

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

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

Method in DialogueRunner

Summary

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

public void AddCommandHandler(string commandName, System.Func<Coroutine> handler);

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

Method in DialogueRunner

Summary

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

public void AddCommandHandler(string commandName, Delegate handler);

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

Method in DialogueRunner

Summary

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

public void AddCommandHandler(string commandName, System.Action handler);

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

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

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

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 to start from.

Remarks

This value is used to select a node to start from when is called.

Method in DialogueRunner

Summary

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

public void AddCommandHandler<T1, T2, T3>(string commandName, System.Func<T1, T2, T3, IEnumerator> handler);

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

Method in DialogueRunner

Summary

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

public void AddCommandHandler<T1, T2>(string commandName, System.Func<T1, T2, Coroutine> handler);

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

Method in DialogueRunner

Summary

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

public void AddCommandHandler<T1>(string commandName, System.Func<T1, IEnumerator> handler);

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

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

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

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

Method in DialogueRunner

Summary

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

public void AddCommandHandler<T1, T2, T3, T4, T5>(string commandName, System.Action<T1, T2, T3, T4, T5> handler);

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

Method in DialogueRunner

Summary

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

public void AddCommandHandler<T1, T2, T3>(string commandName, System.Func<T1, T2, T3, Coroutine> handler);

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

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

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

Method in DialogueRunner

Summary

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

public void AddCommandHandler<T1, T2, T3>(string commandName, System.Action<T1, T2, T3> handler);

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

Method in DialogueRunner

Summary

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

public void AddFunction<TResult>(string name, System.Func<TResult> 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

Type Parameters

See Also

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

Method in DialogueRunner

Summary

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

public void AddFunction<TResult, T1>(string name, System.Func<TResult, T1> 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

Type Parameters

See Also

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

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

Method in

Summary

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

Remarks

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:

Parameters

See Also

Method in DialogueRunner

Summary

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

public void AddFunction<TResult, T1, T2, T3, T4, T5>(string name, System.Func<TResult, T1, T2, T3, T4, T5> 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

Type Parameters

See Also

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

Method in

Summary

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

Remarks

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:

Parameters

Type Parameters

See Also

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

Method in

Summary

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

Remarks

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:

Parameters

Type Parameters

See Also

Field in

Summary

The View classes that will present the dialogue to the user.

Method in DialogueRunner

Summary

Called by a DialogueViewBase derived class from dialogueViews to inform the DialogueRunner that the user intents to proceed to the next line.

public void OnViewRequestedInterrupt()

Method in DialogueRunner

Summary

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

public void AddFunction<TResult, T1, T2, T3, T4, T5, T6>(string name, System.Func<TResult, T1, T2, T3, T4, T5, T6> 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

Type Parameters

See Also

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

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

• DialogueRunner.AddFunction(string,System.Func<TResult>): Add a new function that returns a value, so that it can be called from Yarn scripts.

Method in

Summary

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

Remarks

This method serializes all variables in 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 method.

Parameters

See Also

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

Method in

Summary

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

Remarks

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:

Parameters

Type Parameters

See Also

Method in DialogueRunner

Summary

Unloads all nodes from the Dialogue .

public void Clear()

Property in DialogueRunner

Summary

Gets the name of the current node that is being run.

public string CurrentNodeName { get };

See Also

• Dialogue.currentNode

Method in DialogueRunner

Summary

Starts running the dialogue again.

public void ResetDialogue(string nodeName = null)

Remarks

If nodeName is null, the node specified by startNode is attempted, followed the currently running node. If none of these options are available, an System.ArgumentNullException is thrown.

Parameters

Method in DialogueRunner

Summary

Returns the collection of tags that the node associated with the node named nodeName.

public IEnumerable<string> GetTagsForNode(String nodeName);

Parameters

Returns

The collection of tags associated with the node, or null if no node with that name exists.

Method in DialogueRunner

Summary

Sets the dialogue views and makes sure the callback DialogueViewBase.MarkLineComplete will respond correctly.

public void SetDialogueViews(DialogueViewBase[] views)

Parameters

Method in DialogueRunner

Summary

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.

public void SetInitialVariables(bool overrideExistingValues = false)

Parameters

Method in DialogueRunner

Summary

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

public void AddCommandHandler<T1, T2, T3, T4, T5, T6>(string commandName, System.Func<T1, T2, T3, T4, T5, T6, Coroutine> handler);

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

Method in DialogueRunner

Summary

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

public void AddCommandHandler<T1, T2, T3, T4, T5, T6>(string commandName, System.Func<T1, T2, T3, T4, T5, T6, IEnumerator> handler);

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

Method in DialogueRunner

Summary

Returns true when a node named nodeName has been loaded.

public bool NodeExists(string nodeName);

Parameters

Returns

true if the node is loaded, false otherwise/

Property in

Summary

Gets the underlying object that runs the Yarn code.

Property in

Summary

The variable storage object.

Method in

Summary

Removes a command handler.

Parameters

Property in

Summary

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

Method in DialogueRunner

Summary

Stops the Dialogue .

public void Stop()

Method in DialogueRunner

Summary

Replaces this DialogueRunner's yarn project with the provided project.

public void SetProject(YarnProject newProject)

Parameters

Method in

Summary

Start the dialogue from a specific node.

Parameters

Method in

Summary

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

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 .

The loaded information can be stored via the method.

Parameters

Returns

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

See Also

• : Provides a unified interface for loading many variables all at once. Will override anything already in the variable storage.

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.

Class in DialogueRunner

Inherits from UnityEngine.Events.UnityEvent1`

Summary

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

public class StringUnityEvent : UnityEvent<string>

Remarks

A concrete subclass of UnityEngine.Events.UnityEvent is needed in order for Unity to serialise the type correctly.