Class in Yarn.Unity

Inherits from System.Object

Summary

public static class AssemblyExtensions

Methods

Field in AudioLineProvider

Summary

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

Method in AssemblyExtensions

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 AudioLineProvider

Summary

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

Property in AudioLineProvider

Summary

public override bool LinesAvailable { get };

Method in AudioLineProvider

Summary

public override LocalizedLine GetLocalizedLine(Line line)

Parameters

Field in AudioLineProvider

Summary

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

Field in AudioLocalizedLine

Summary

DialogueLine's voice over clip

public AudioClip AudioClip;

Field in AudioLineProvider

Summary

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

Method in AudioLineProvider

Summary

public override void PrepareForLines(IEnumerable<string> lineIDs)

Parameters

Field in CharacterColorData

Summary

public Color displayColor = Color.white;

Field in Culture

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 CharacterColorData

Summary

public string characterName;

Method in Cultures

Summary

public static IEnumerable<Culture> GetCultures();

Field in Culture

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

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 DialogueCharacterNameView

Summary

Invoked when the dialogue is started.

public UnityEvent onDialogueStarted;

Field in DialogueOption

Summary

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

public bool IsAvailable;

Field in Culture

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;

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 DialogueOption

Summary

The ID of the dialogue option's text

public string TextID;

Method in DialogueCharacterNameView

Summary

public override void DialogueStarted()

Field in DialogueOption

Summary

The ID of this dialogue option

public int DialogueOptionID;

Field in DialogueOption

Summary

The line for this dialogue option

public LocalizedLine Line;

Field in DialogueRunner

Summary

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

public DialogueViewBase[] dialogueViews;

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.

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.

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

public LineProviderBehaviour lineProvider;

Field in DialogueRunner

Summary

Whether the DialogueRunner should automatically proceed to the next line once a line has been finished.

public bool automaticallyContinueLines;

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

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

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

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

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

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.

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 DialogueRunner

Summary

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

public bool verboseLogging = true;

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

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

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

Method in DialogueRunner

Summary

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

Parameters

Type Parameters

Method in DialogueRunner

Summary

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

Parameters

Type Parameters

Method in DialogueRunner

Summary

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

Parameters

Type Parameters

Summary

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

Classes

Enums

Structs

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

Class in Yarn.Unity

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

Class in Yarn.Unity

Inherits from LineProviderBehaviour

Summary

public class AudioLineProvider : LineProviderBehaviour

Fields

Methods

Properties

Class in Yarn.Unity

Inherits from LocalizedLine

Summary

public class AudioLocalizedLine : LocalizedLine

Fields

Class in Yarn.Unity

Inherits from DialogueViewBase

Summary

public class CharacterColorView : Yarn.Unity.DialogueViewBase

Classes

Methods

Method in CharacterColorView

Summary

public override void RunLine(LocalizedLine dialogueLine, Action onDialogueLineFinished)

Parameters

Class in CharacterColorView

Inherits from System.Object

Summary

public class CharacterColorData

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

Provides access to all Culture s supported by Yarn Spinner.

public static class Cultures

Methods

Method in Cultures

Summary

Returns the Culture represented by the language code in name .

public static Culture GetCulture(string name)

Parameters

Returns

The Culture .

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

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 DialogueRunner

Summary

Removes a command handler.

public void RemoveCommandHandler(string commandName)

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

Unloads all nodes from the Dialogue .

public void Clear()

Method in DialogueRunner

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 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 OnViewUserIntentNextLine()

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/

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 ArgumentNullException is thrown.

Parameters

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

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

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

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

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

public void SetDialogueViews(DialogueViewBase[] views)

Parameters

Method in DialogueRunner

Summary

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

public void SetProject(YarnProject newProject)

Parameters

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 DialogueRunner

Summary

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

public bool IsDialogueRunning { get; set; }

Class in DialogueRunner

Inherits from UnityEvent1`

Summary

A type of UnityEvent that takes a single string parameter.

public class StringUnityEvent : UnityEvent<string>

Remarks

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

Method in DialogueRunner

Summary

Start the dialogue from a specific node.

public void StartDialogue(string startNode)

Parameters

Method in DialogueRunner

Summary

Stops the Dialogue .

public void Stop()

Method in DialogueViewBase

Summary

Called by the DialogueRunner to signal that the dialogue has ended, and no more lines will be delivered.

public virtual void DialogueComplete()

Remarks

The default implementation does nothing.

Property in

Summary

The variable storage object.

public VariableStorageBehaviour VariableStorage
{
            get; set; }

Property in DialogueRunner

Summary

Gets the underlying Dialogue object that runs the Yarn code.

public Dialogue Dialogue { get };

Class in Yarn.Unity

Inherits from MonoBehaviour

Summary

A MonoBehaviour that can present the data of a dialogue executed by a DialogueRunner to the user. The DialogueRunner uses subclasses of this type to relay information to and from the user, and to pause and resume the execution of the YarnScript .

public abstract class DialogueViewBase : MonoBehaviour

Remarks

The term "view" is meant in the broadest sense, e.g. a view on the dialogue (MVVM pattern). Therefore, this abstract class only defines how a specific view on the dialogue should communicate with the DialogueRunner (e.g. display text or trigger a voice over clip). How to present the content to the user will be the responsibility of all classes inheriting from this class.

The inheriting classes will receive a LocalizedLine and can be in one of the stages defined in DialogueLineStatus while presenting it.

Methods

See Also

• DialogueRunner.dialogueViews: The View classes that will present the dialogue to the user.

• DialogueUI

Method in DialogueViewBase

Summary

Called by the DialogueRunner to signal that the view should dismiss its current line from display, and clean up.

public virtual void DismissLine(Action onDismissalComplete)

Parameters

Method in

Summary

Signals that a conversation has started.

public virtual void DialogueStarted()

Method in DialogueViewBase

Summary

Called by the DialogueRunner to signal that a set of options should be displayed to the user.

public virtual void RunOptions(DialogueOption[] dialogueOptions, Action<int> onOptionSelected)

Remarks

When this method is called, the DialogueRunner will pause execution until the `onOptionSelected` method is called.

If your scene includes multiple dialogue views that override this method, they will all receive a call each time the dialogue system presents options to the player. You must ensure that only one of them calls the onOptionSelected method.

Parameters

Method in DialogueViewBase

Summary

Signals that the user wants to go to the next line.

public void ReadyForNextLine()

Remarks

This method is generally called by a "continue" button, and causes the DialogueUI to signal the DialogueRunner to proceed to the next piece of content.

If this method is called before the line has finished appearing (that is, before the line's status changes to FinishedPresenting ), the line's status will change to Interrupted , and OnLineStatusChanged(LocalizedLine) will be called to notify the view.

Method in DialogueViewBase

Summary

Called by the DialogueRunner to signal that the end of a node has been reached.

public virtual void NodeComplete(string nextNode, Action onComplete)

Remarks

This method may be called multiple times before DialogueComplete() is called. If this method returns Dialogue.HandlerExecutionType.ContinueExecution , do not call the onComplete method.

The default implementation does nothing.

Parameters

Method in Effects

Summary

A coroutine that fades a CanvasGroup object's opacity from from to to over the course of fadeTime seconds, and then invokes onComplete . An InterruptionFlag may be used to signal that the fade should be interrupted; if this happens, the opacity is set to to .

public static IEnumerator FadeAlpha(CanvasGroup canvasGroup, float from, float to, float fadeTime, Action onComplete = null, InterruptionFlag interruption = null)

Parameters

Class in Yarn.Unity

Inherits from System.Object

Summary

public static class Effects

Methods

Method in DialogueViewBase

Summary

Called by the DialogueRunner to indicate that the line that this view is delivering has changed state.

public virtual void OnLineStatusChanged(LocalizedLine dialogueLine)

Remarks

Subclasses of DialogueViewBase should override this method to be notified when a line has become interrupted, and when the line has finished being delivered by all views.

The default implementation does nothing.

Parameters

See Also

• LineStatus: The presentation status of a LocalizedLine .

Method in

Summary

Called by the to signal that a line should be displayed to the user.

public virtual void RunLine(LocalizedLine dialogueLine, Action onDialogueLineFinished)

Parameters