Yarn.Unity Namespace

Summary

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

Attributes

Name	Description
YarnActionAttribute
YarnParameterAttribute	Yarn parameter.
YarnStateInjectorAttribute	Inject state for any commands in this class using this static method.

Classes

Name	Description
Actions
AudioLineProvider
CharacterColorView
Cultures	Provides access to all Culture s supported by Yarn Spinner.
DialogueAdvanceInput	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.
DialogueCharacterNameView	A subclass of DialogueViewBase that displays character names.
DialogueOption
DialogueReference	Stores a reference to a dialogue node in a Yarn Project.
DialogueRunner	The DialogueRunner component acts as the interface between your game and Yarn Spinner.
DialogueViewBase	A UnityEngine.MonoBehaviour that can present lines and options to the user, when it receives them from a DialogueRunner .
Effects	Contains coroutine methods that apply visual effects. This class is used by LineView to handle animating the presentation of lines.
InMemoryVariableStorage	A simple implementation of VariableStorageBehaviour.
LanguageAttribute
LineMetadata
LineProviderBehaviour	A UnityEngine.MonoBehaviour that produces LocalizedLine s, for use in Dialogue Views.
LineView	A Dialogue View that presents lines of dialogue, using Unity UI elements.
Localization
LocalizedLine	Represents a line, ready to be presented to the user in the localisation they have specified.
MarkupPalette	Represents a collection of marker names and colours.
OptionsListView
OptionView
SampleRenderDetector	Detects if the render pipeline is different from the one the samples were created with, and warn you that things might look odd.
SerializedDictionary	An System.Collections.Generic.IDictionary`2 that can be serialized as part of a Unity object.
TextLineProvider
VariableStorageBehaviour	A UnityEngine.MonoBehaviour that a DialogueRunner uses to store and retrieve variables.
VoiceOverView	A subclass of DialogueViewBase that plays voice-over UnityEngine.AudioClip s for lines of dialogue.
YarnCommandAttribute	An attribute that marks a method on an object as a command.
YarnFunctionAttribute	Marks the method as a function to be registered with the running instance's library.
YarnNodeAttribute	Specifies that a field represents a reference to a named Yarn node that exists in a Yarn project.
YarnProject

Enums

Name	Description
LocalizationType

Interfaces

Name	Description
IActionRegistration
ICommand

Namespaces

Name	Description
Yarn.Unity.UnityLocalization

Structs

Name	Description
Culture	Holds information about a language.
StringTableEntry