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.
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 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 .
Effects
FindVoiceOver	Provides methods for finding voice over AudioClip s in the project matching a Yarn linetag/string ID and a language ID.
InMemoryVariableStorage	A simple implementation of VariableStorageBehaviour.
InterruptionFlag
LanguageAttribute
LineProviderBehaviour	A MonoBehaviour that produces LocalizedLine s.
LineView
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.
VoiceOverPlaybackUnity	Handles playback of voice over AudioClip s referenced on YarnScript s.
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.

Enums

Name	Description
LineStatus	The presentation status of a LocalizedLine .

Structs

Name	Description
Culture	Holds information about a language.
StringTableEntry