Enumeration Member in ContinueActionType

Summary

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

None

Method in Actions

Summary

public void AddCommandHandler(string commandName, Delegate handler)

Parameters

Method in

Returns a boolean value indicating whether name is a valid identifier for retrieving a from .

Method in

Method in

Property in

Property in

Method in

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 CharacterColorData

Summary

public string characterName;

Summary

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

Attributes

Method in Actions

Summary

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

Parameters

Method in AudioLineProvider

Summary

public override LocalizedLine GetLocalizedLine(Line line)

Parameters

Field in

Field in

The ID of this dialogue option

Method in

Field in

Enumeration Member in ContinueActionType

Summary

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

InputSystemActionFromAsset

Remarks

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 AudioLineProvider

Summary

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

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 CharacterColorData

Summary

public Color displayColor = Color.white;

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.

Class in Yarn.Unity

Inherits from LineProviderBehaviour

Summary

public class AudioLineProvider : LineProviderBehaviour

Fields

Method in Actions

Summary

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

Parameters

Class in CharacterColorView

Inherits from System.Object

Summary

public class CharacterColorData

Fields

Method in Actions

Summary

public void SetupForProject(YarnProject yarnProject)

Parameters

Class in

Inherits from System.Object

Field in

The keyboard key that this component is listening for.

Enumeration Member in

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

Field in

Field in

The line for this dialogue option

Property in

Field in

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

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

Method in

Property in

Field in

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

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

Method in

Property in

Gets the UnityEngine.InputSystem.InputAction configured by this .

This methods returns the following potential values:

• If is , this method returns .

Property in

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.

Field in DialogueReference

Summary

The name of the dialogue node in the project.

public string nodeName;

Enumeration Member in ContinueActionType

Summary

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

KeyCode

Remarks

Field in AudioLineProvider

Summary

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

TYPENAME_UNKNOWN in DialogueReference

Summary

(no declaration available)

Field in DialogueReference

Summary

The Yarn Project asset containing the dialogue node.

public YarnProject project;

Field in DialogueCharacterNameView

Summary

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

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;

Constructor in DialogueReference

Summary

Creates an empty dialogue reference.

public DialogueReference()

Enum in DialogueAdvanceInput

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

Method in Cultures

Summary

Returns the Culture represented by the language code in name .

public static Culture GetCulture(string name)

Parameters

The .

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

Method in Actions

Summary

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

Parameters

Method in CharacterColorView

Summary

public override void RunLine(LocalizedLine dialogueLine, Action onDialogueLineFinished)

Parameters

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.

Constructor in DialogueReference

Summary

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

public DialogueReference(YarnProject project, string nodeName)

Parameters

Class in

Inherits from System.Object

Provides access to all s supported by Yarn Spinner.

Class in

Inherits from

Field in

Configures whether should be enabled on start.

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.

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

• DialogueUI

Class in

Inherits from UnityEngine.MonoBehaviour

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.

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

When the configured input occurs, this component calls the method on its .

Method in

Method in

Method in Actions

Summary

public void AddCommandHandler(string commandName, Action handler);

Parameters

Method in Actions

Summary

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

Parameters

Method in

Field in

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.

Method in

Property in

Method in Actions

Summary

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

Parameters

Field in

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.

Field in

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

Struct in Yarn.Unity

Inherits from System.ValueType

Summary

Holds information about a language.

public struct Culture

Constructors

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

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

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

Method in Actions

Summary

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

Parameters

Method in

Property in

Method in Actions

Summary

public void AddFunction(string name, Delegate implementation)

Parameters

Method in Actions

Summary

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

Parameters

Field in

Method in

Method in

Method in Actions

Summary

public static Yarn.Library GetLibrary()

Class in Yarn.Unity

Inherits from System.Object

Summary

public class Actions : ICommandDispatcher

Constructors

Methods

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

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

Parameters

Method in Actions

Summary

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

Parameters

Constructor in

Method in Actions

Summary

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

Parameters

Method in

Constructor in Actions

Summary

public Actions(DialogueRunner dialogueRunner, Library library)

Parameters

Method in Actions

Summary

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

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 Actions

Summary

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

Parameters

Method in Actions

Summary

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

Parameters