Summary

Contains classes for working with Yarn Spinner in the Unity game engine.

Classes

Structs

Class in

Inherits from

Summary

public class AudioLineProvider : LineProviderBehaviour

Fields

Methods

Properties

Method in

Summary

Assembly.GetTypes() can throw in some cases. This extension will catch that exception and return only the types which were successfully loaded from the assembly.

public static IEnumerable<System.Type> GetLoadableTypes(this Assembly @this)

Parameters

Field in

Summary

public string audioLanguage = System.Globalization.CultureInfo.CurrentCulture.Name;

Field in AudioLineProvider

Summary

public System.Action<AsyncOperationHandle<AudioClip>> AssetLoadCompleteAction;

Field in AudioLineProvider

Summary

public Dictionary<string, AsyncOperationHandle<AudioClip>> completedLoadOperations = new Dictionary<string, AsyncOperationHandle<AudioClip>>();

Field in AudioLineProvider

Summary

public Dictionary<AsyncOperationHandle<AudioClip>, string> pendingLoadOperations = new Dictionary<AsyncOperationHandle<AudioClip>, string>();

Property in AudioLineProvider

Summary

public override bool LinesAvailable { get };

Method in AudioLineProvider

Summary

public override void PrepareForLines(IEnumerable<string> lineIDs)

Parameters

Field in AudioLocalizedLine

Summary

DialogueLine's voice over clip

public AudioClip AudioClip;

Class in Yarn.Unity

Inherits from LocalizedLine

Summary

public class AudioLocalizedLine : LocalizedLine

Fields

Class in

Inherits from System.Object

Summary

public class CharacterColorData

Fields

Class in

Inherits from

Summary

public class CharacterColorView : Yarn.Unity.DialogueViewBase

Classes

Methods

Field in

Summary

public string characterName;

Method in

Summary

public override void RunLine(LocalizedLine dialogueLine, Action onDialogueLineFinished)

Parameters

Field in

Summary

public Color displayColor = Color.white;

Field in

Summary

The unique language ID used to identify a language as RFC 4646. Will be "de-CH" for "German (Switzerland)". Use this for storing settings or identifying a language.

public string Name;

Field in

Summary

The languages name as called in the language itself. Will be "Deutsch (Schweiz) for "de-CH". Use this to present the language in-game so people can find their native language.

public string NativeName;

Field in

Summary

The display name of a language. Will be "German (Switzerland)" for "de-CH". Use this value to present the language in an English UI.

public string DisplayName;

Method in Cultures

Summary

Returns a boolean value indicating whether name is a valid identifier for retrieving a Culture from GetCulture(string) .

public static bool HasCulture(string name)

Parameters

Returns

true if name is a valid Culture name; false otherwise.

Field in DialogueAdvanceInput

Summary

The keyboard key that this component is listening for.

public KeyCode continueActionKeyCode = KeyCode.Space;

Remarks

Method in

Summary

public static IEnumerable<Culture> GetCultures();

Field in

Summary

The type of input that this component is listening for.

public ContinueActionType continueActionType = ContinueActionType.KeyCode;

See Also

• : The type of input that this component is listening for in order to signal that its dialogue view should advance.

Field in

Summary

The InputAction that this component is listening for.

public InputAction continueAction = new InputAction("Skip", InputActionType.Button, CommonUsages.Submit);

Remarks

Use this continue action type when you want this component to use a configurable input action, but don't want to have to set up other actions in your project.

Method in

Summary

Returns the represented by the language code in name .

public static Culture GetCulture(string name)

Parameters

Returns

The .

Property in

Summary

Gets the InputAction configured by this .

public InputAction Action
{
            get; }

Remarks

This methods returns the following potential values:

• If is , this method returns .

• If is , this method returns 's action.

• If is or , this method returns null.

Class in

Inherits from System.Object

Summary

Provides access to all s supported by Yarn Spinner.

public static class Cultures

Methods

Field in

Summary

Configures whether should be enabled on start.

public bool enableActionOnStart = true;

Remarks

If this field is false , the input action specified by will not be enabled by default, and will need to be enabled by your game's code.

Enum in

Inherits from System.Enum

Summary

The type of input that this component is listening for in order to signal that its dialogue view should advance.

public enum ContinueActionType
{
    None,
    KeyCode,
    InputSystemAction,
    InputSystemActionFromAsset
}

Members

Field in DialogueAdvanceInput

Summary

The dialogue view that will be notified when the user performs the advance input (as configured by continueActionType and related fields.)

public DialogueViewBase dialogueView;

Remarks

When the input is performed, this dialogue view will have its UserRequestedViewAdvancement() method called.

Field in DialogueAdvanceInput

Summary

An InputActionReference that refers to the action that this component is listening for.

public InputActionReference continueActionReference = null;

Remarks

Use this continue action type when you want this component to make use of an input action you've configured elsewhere in your project.

Enumeration Member in ContinueActionType

Summary

The component is listening for the action configured in continueAction to be performed.

InputSystemAction

Remarks

Field in DialogueCharacterNameView

Summary

Invoked when a line is received that contains a character name. The name is given as the parameter.

public DialogueRunner.StringUnityEvent onNameUpdate;

See Also

• DialogueCharacterNameView.onNameNotPresent: Invoked when a line is received that doesn't contain a character name.

Enumeration Member in ContinueActionType

Summary

The component is listening for the action referred to by continueActionReference to be performed.

InputSystemActionFromAsset

Remarks

Field in DialogueCharacterNameView

Summary

Invoked when a line is received that doesn't contain a character name.

public UnityEvent onNameNotPresent;

Remarks

Games can use this event to hide the name UI.

See Also

• DialogueCharacterNameView.onNameUpdate: Invoked when a line is received that contains a character name. The name is given as the parameter.

Field in DialogueCharacterNameView

Summary

Invoked when the dialogue is started.

public UnityEvent onDialogueStarted;

Enumeration Member in ContinueActionType

Summary

The component is listening for no input. This component will not signal to dialogueView that it should advance.

None

Enumeration Member in ContinueActionType

Summary

The component is listening for a key on the keyboard to be pressed.

KeyCode

Remarks

Field in DialogueOption

Summary

The line for this dialogue option

public LocalizedLine Line;

Field in DialogueOption

Summary

Indicates whether this value should be presented as available or not.

public bool IsAvailable;

Method in DialogueCharacterNameView

Summary

public override void DialogueStarted()

Field in DialogueOption

Summary

The ID of the dialogue option's text

public string TextID;

Field in DialogueRunner

Summary

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

public DialogueViewBase[] dialogueViews;

Field in DialogueRunner

Summary

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

public StringUnityEvent onNodeComplete;

Remarks

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

See Also

• Dialogue.NodeCompleteHandler

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

Field in DialogueRunner

Summary

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

public bool runSelectedOptionAsLine;

Field in DialogueRunner

Summary

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

public StringUnityEvent onNodeStart;

Remarks

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

See Also

• Dialogue.NodeStartHandler

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.

Field in DialogueRunner

Summary

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

public bool verboseLogging = true;

Field in DialogueRunner

Summary

The name of the node to start from.

public string startNode = Yarn.Dialogue.DefaultStartNodeName;

Remarks

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

Field in DialogueRunner

Summary

The YarnProject asset that should be loaded on scene start.

public YarnProject yarnProject;

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 Coroutine, when the command is run, the DialogueRunner will wait for the returned 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 Coroutine, when the command is run, the DialogueRunner will wait for the returned 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.Action<T1, T2> 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 Coroutine, when the command is run, the DialogueRunner will wait for the returned 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 Coroutine, when the command is run, the DialogueRunner will wait for the returned 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 Coroutine, when the command is run, the DialogueRunner will wait for the returned 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 Coroutine, when the command is run, the DialogueRunner will wait for the returned 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.Action<T1> 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 Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

Parameters

Field in DialogueOption

Summary

The ID of this dialogue option

public int DialogueOptionID;

Method in AudioLineProvider

Summary

public override LocalizedLine GetLocalizedLine(Line line)

Parameters

Class in Yarn.Unity

Inherits from MonoBehaviour

Summary

A component that listens for user input, and uses it to notify a dialogue view that the user wishes to advance to the next step in the dialogue.

public class DialogueAdvanceInput : MonoBehaviour

Remarks

This class may be used with the Unity Input System, or the legacy Input Manager. The specific type of input it's looking for is configured via the continueActionType field.

When the configured input occurs, this component calls the UserRequestedViewAdvancement() method on its dialogueView.

Enums

Fields

Properties

Class in Yarn.Unity

Inherits from DialogueViewBase

Summary

A subclass of DialogueViewBase that displays character names.

public class DialogueCharacterNameView : Yarn.Unity.DialogueViewBase

Remarks

This class uses the character attribute on lines that it receives to determine its content. When the view's RunLine(LocalizedLine,Action) method is called with a line whose Text contains a character attribute, the onNameUpdate event is fired. If the line does not contain such an attribute, the onNameNotPresent event is fired instead.

This view does not present any options or handle commands. It's intended to be used alongside other subclasses of DialogueViewBase.

Fields

Methods

See Also

• DialogueUI

Method in DialogueCharacterNameView

Summary

public override void RunLine(LocalizedLine dialogueLine, Action onDialogueLineFinished)

Parameters

Class in Yarn.Unity

Inherits from System.Object

Summary

public class DialogueOption

Fields

Struct in Yarn.Unity

Inherits from System.ValueType

Summary

Holds information about a language.

public struct Culture

Fields

Class in Yarn.Unity

Inherits from System.Object

Summary

public static class AssemblyExtensions

Methods

Method in

Summary

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

public void AddCommandHandler<T1>(string commandName, System.Func<T1, 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 Coroutine, when the command is run, the will wait for the returned 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.

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 Coroutine, when the command is run, the will wait for the returned 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.

public void AddCommandHandler<T1, T2, T3, T4>(string commandName, System.Func<T1, T2, T3, T4, 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 Coroutine, when the command is run, the will wait for the returned 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.

public void AddCommandHandler<T1, T2, T3, T4>(string commandName, System.Action<T1, T2, T3, T4> 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 Coroutine, when the command is run, the will wait for the returned 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.

public void AddCommandHandler<T1, T2, T3, T4, T5>(string commandName, System.Func<T1, T2, T3, T4, T5, 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 Coroutine, when the command is run, the will wait for the returned 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.

public void AddCommandHandler<T1, T2, T3, T4, T5, T6>(string commandName, System.Action<T1, T2, T3, T4, T5, T6> 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 Coroutine, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.

Parameters

Method in

Summary

public void AddFunction<TResult, T1, T2, T3, T4, T5>(string name, System.Func<TResult, T1, T2, T3, T4, T5> implementation)

Parameters

Type Parameters

Method in

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

Method in

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 Coroutine, when the command is run, the will wait for the returned coroutine to stop before delivering any more content.

Parameters

Method in

Summary

public void AddFunction<TResult, T1, T2, T3>(string name, System.Func<TResult, T1, T2, T3> implementation)

Parameters

Type Parameters

Method in

Summary

public void AddFunction<TResult, T1, T2>(string name, System.Func<TResult, T1, T2> implementation)

Parameters

Type Parameters

Method in

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/

Method in

Summary

public void AddFunction<TResult, T1, T2, T3, T4>(string name, System.Func<TResult, T1, T2, T3, T4> implementation)

Parameters

Type Parameters

Method in

Summary

public void AddFunction<TResult, T1>(string name, System.Func<TResult, T1> implementation)

Parameters

Type Parameters

Method in

Summary

public void AddFunction<TResult, T1, T2, T3, T4, T5, T6>(string name, System.Func<TResult, T1, T2, T3, T4, T5, T6> implementation)

Parameters

Type Parameters

Method in

Summary

Unloads all nodes from the .

public void Clear()

Method in

Summary

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

public void SetDialogueViews(DialogueViewBase[] views)

Parameters

Method in

Summary

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

public void OnViewRequestedInterrupt()

Method in

Summary

Removes a command handler.

public void RemoveCommandHandler(string commandName)

Parameters

Method in

Summary

Start the dialogue from a specific node.

public void StartDialogue(string startNode)

Parameters

Method in

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

• AddFunction<TResult>(string, Func<TResult>)

Method in

Summary

Starts running the dialogue again.

public void ResetDialogue(string nodeName = null)

Remarks

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

Parameters

Property in

Summary

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

public string CurrentNodeName { get };

See Also

• Dialogue.currentNode

Method in

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

Property in

Summary

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

public bool IsDialogueRunning { get; set; }

Method in

Summary

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

public void SetProject(YarnProject newProject)

Parameters

Method in

Summary

Stops the .

public void Stop()

Method in

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 string.Split(char[], StringSplitOptions) method with the StringSplitOptions parameter set to 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.

Property in

Summary

Gets the underlying object that runs the Yarn code.

public Dialogue Dialogue { get };

Field in

Summary

public LineProviderBehaviour lineProvider;

Class in

Inherits from MonoBehaviour

Summary

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

public class DialogueRunner : MonoBehaviour

Classes

Fields

Methods

Properties

Property in

Summary

The variable storage object.

public VariableStorageBehaviour VariableStorage
{
            get; set; }

Method in

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.