Yarn.Unity Namespace

Summary

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

Classes

Name	Description
AssemblyExtensions
AudioLineProvider
AudioLocalizedLine
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
DialogueRunner	The DialogueRunner component acts as the interface between your game and Yarn Spinner.
DialogueViewBase	A 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
LineProviderBehaviour	A 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.
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 IDictionary<TKey,TValue> that can be serialized as part of a Unity object.
TextLineProvider
VariableStorageBehaviour	A MonoBehaviour that a DialogueRunner uses to store and retrieve variables.
VoiceOverView	A subclass of DialogueViewBase that plays voice-over AudioClip s for lines of dialogue.
YarnActionAttribute
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.
YarnLinesAsCanvasText	Shows Yarn lines on Canvas Text components.
YarnParameterAttribute	Yarn parameter.
YarnProject
YarnStateInjectorAttribute	Inject state for any commands in this class using this static method.

Structs

Name	Description
Culture	Holds information about a language.
StringTableEntry