Method in Actions

Summary

public void AddCommandHandler(string commandName, Delegate handler)

Parameters

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

public void AddCommandHandler(string commandName, MethodInfo methodInfo)

Parameters

Method in Actions

Summary

public void AddCommandHandler(string commandName, Action handler);

Parameters

Method in Actions

Summary

public void AddCommandHandler<T1, T2>(string commandName, Func<T1, T2, IEnumerator> handler)

Parameters

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

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

Parameters

Class in Yarn.Unity

Inherits from System.Object

Summary

public class Actions : ICommandDispatcher

Constructors

Methods

Properties

Summary

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

Attributes

Classes

Enums

Interfaces

Namespaces

Structs

Constructor in Actions

Summary

public Actions(DialogueRunner dialogueRunner, Library library)

Parameters

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

public void AddCommandHandler<T1>(string commandName, Action<T1> handler);

Parameters

Method in

Summary

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

Parameters

Method in

Summary

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

Parameters

Method in

Summary

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

Parameters

Method in

Summary

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

Parameters

Method in

Summary

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

Parameters

Method in

Summary

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

Parameters

Method in Actions

Summary

public void AddFunction(string name, Delegate implementation)

Parameters

Method in Actions

Summary

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

Parameters

Method in

Summary

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

Parameters

Method in Actions

Summary

public void AddFunction<TResult>(string name, Func<TResult> implementation);

Parameters

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

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

Parameters

Method in

Summary

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

Parameters

Method in Actions

Summary

public static Yarn.Library GetLibrary()

Method in Actions

Summary

public static void AddRegistrationMethod(Action<IActionRegistration> registerActions)

Parameters

Method in Actions

Summary

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

Parameters

Method in

Summary

public void RegisterActions()

Method in Actions

Summary

public void RemoveCommandHandler(string commandName)

Parameters

Method in Actions

Summary

public void RemoveFunction(string name)

Parameters

Method in Actions

Summary

public void SetupForProject(YarnProject yarnProject)

Parameters

Property in Actions

Summary

public IEnumerable<ICommand> Commands { get };

Property in Actions

Summary

public DialogueRunner DialogueRunner { get; }

Class in Yarn.Unity

Inherits from LineProviderBehaviour

Summary

public class AudioLineProvider : LineProviderBehaviour

Fields

Methods

Properties

Field in

Summary

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

Field in

Summary

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

Field in

Summary

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

Property in

Summary

public Library Library { get; }

Field in

Summary

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

Field in

Summary

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

Property in

Summary

public override string LocaleCode { get };

Property in AudioLineProvider

Summary

public override bool LinesAvailable { get };

Method in AudioLineProvider

Summary

public override LocalizedLine GetLocalizedLine(Line line)

Parameters

Method in

Summary

public override void PrepareForLines(IEnumerable<string> lineIDs)

Parameters

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;

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;

Field in

Summary

public Color displayColor = Color.white;

Method in CharacterColorView

Summary

public override void RunLine(LocalizedLine dialogueLine, Action onDialogueLineFinished)

Parameters

Field in

Summary

public bool IsNeutralCulture;

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;

Constructor in Culture

Summary

public Culture(System.Globalization.CultureInfo cultureInfo)

Parameters

Class in Yarn.Unity

Inherits from System.Object

Summary

Provides access to all Culture s supported by Yarn Spinner.

public static class Cultures

Methods

Properties

Struct in

Inherits from System.ValueType

Summary

Holds information about a language.

public struct Culture

Constructors

Fields

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;

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

Field in DialogueAdvanceInput

Summary

An UnityEngine.InputSystem.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.

Property in

Summary

public static Culture CurrentNeutralCulture
{
            get; }

Field in DialogueAdvanceInput

Summary

The keyboard key that this component is listening for.

public KeyCode continueActionKeyCode = KeyCode.Space;

Remarks

Property in DialogueAdvanceInput

Summary

Gets the UnityEngine.InputSystem.InputAction configured by this DialogueAdvanceInput .

public InputAction Action
{
            get; }

Remarks

This methods returns the following potential values:

• If continueActionType is InputSystemAction, this method returns continueAction.

• If continueActionType is InputSystemActionFromAsset, this method returns continueActionReference's action.

• If continueActionType is KeyCode or None, this method returns null.

Field in DialogueAdvanceInput

Summary

The type of input that this component is listening for.

public ContinueActionType continueActionType = ContinueActionType.KeyCode;

See Also

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

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

Enumeration Member in ContinueActionType

Summary

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

InputSystemActionFromAsset

Remarks

Class in Yarn.Unity

Inherits from UnityEngine.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

Method in Cultures

Summary

Returns the Culture represented by the language code in name .

public static Culture GetCulture(string name)

Parameters

Returns

The Culture .

Field in

Summary

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

public DialogueViewBase dialogueView;

Remarks

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

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.

Enumeration Member in ContinueActionType

Summary

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

InputSystemAction

Remarks

Enumeration Member in

Summary

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

KeyCode

Remarks

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

Field in

Summary

Invoked when the dialogue is started.

public UnityEvent onDialogueStarted;

Enumeration Member in

Summary

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

None

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.

Method in

Summary

public override void DialogueStarted()

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.

Class in Yarn.Unity

Inherits from System.Object

Summary

public class DialogueOption

Fields

Method in DialogueCharacterNameView

Summary

public override void RunLine(LocalizedLine dialogueLine, Action onDialogueLineFinished)

Parameters

Field in

Summary

The ID of this dialogue option

public int DialogueOptionID;

Field in

Summary

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

public bool IsAvailable;

Field in

Summary

The line for this dialogue option

public LocalizedLine Line;

Field in

Summary

The ID of the dialogue option's text

public string TextID;

Class in Yarn.Unity

Inherits from System.Object

Summary

Stores a reference to a dialogue node in a Yarn Project.

public class DialogueReference

Remarks

A Dialogue Reference is a reference to a named node inside a given Yarn Project. This allows the editor to warn the user if node doesn't exist in the specified project.

Constructors

Fields

Properties

TYPENAME_UNKNOWN_PLURAL

Field in

Summary

The name of the dialogue node in the project.

public string nodeName;

Constructor in DialogueReference

Summary

Creates a dialogue reference with a given project and node name.

public DialogueReference(YarnProject project, string nodeName)

Parameters

Field in

Summary

The Yarn Project asset containing the dialogue node.

public YarnProject project;

TYPENAME_UNKNOWN in

Summary

(no declaration available)

Constructor in

Summary

Creates an empty dialogue reference.

public DialogueReference()

Property in

Summary

Gets a value indicating that this reference is valid - that is, the project and node name are set, and the node exists in the project.

public bool IsValid { get };