Yarn.Unity Namespace

Summary

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

Attributes

Name	Description
YarnActionAttribute

Classes

Name	Description
ActionMarkupHandler	This is an abstract monobehaviour that conforms to the IActionMarkupHandler interface.
ActionRegistrationExtension	Contains extension methods for IActionRegistration objects.
Actions
BuiltinLocalisedLineProvider
Cultures	Provides access to all Culture s supported by Yarn Spinner.
DialogueOption
DialoguePresenterBase	A UnityEngine.MonoBehaviour that can present lines and options to the user, when it receives them from a DialogueRunner .
DialogueReference	Stores a reference to a dialogue node in a Yarn Project.
DialogueRunner
Effects	Contains coroutine methods that apply visual effects. This class is used by LineView to handle animating the presentation of lines.
GeneratedVariableStorageExtensions
InMemoryVariableStorage	A simple implementation of VariableStorageBehaviour.
LineAdvancer	A dialogue presenter that listens for user input and sends requests to a DialogueRunner to advance the presentation of the current line, either by asking a dialogue runner to hurry up its delivery, advance to the next line, or cancel the entire dialogue session.
LineMetadata
LinePresenter	A Dialogue Presenter that presents lines of dialogue, using Unity UI elements.
LinePresenterButtonHandler
LineProviderBehaviour	A UnityEngine.MonoBehaviour that produces LocalizedLine s, for use in Dialogue Presenters.
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.
OptionItem
OptionsPresenter	Receives options from a DialogueRunner , and displays and manages a collection of OptionItem views for the user to choose from.
PauseEventProcessor	Allows pausing the current typewrite through [pause/] markers.
ReplacementMarkupHandler	An attribute marker processor receives a marker found in a Yarn line, and optionally rewrites the marker and its children into a new form.
SerializableDictionary
SerializableDictionary<TKey, TValue>
SerializableDictionary<TKey, TValue, TValueStorage>
SerializableDictionaryBase
SerializableDictionaryBase<TKey, TValue, TValueStorage>
StyleMarkerProcessor	An attribute marker processor that inserts TextMeshPro style tags where Yarn Spinner [style] tags appear in a line.
UnityEventString	A UnityEngine.Events.UnityEvent that takes a single string parameter.
VariableStorageBehaviour	A UnityEngine.MonoBehaviour that a DialogueRunner uses to store and retrieve variables.
VoiceOverPresenter	A subclass of DialoguePresenterBase 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.
YarnProject
YarnTaskCompletionSource
YarnTaskCompletionSource
YarnTaskExtensions

Enums

Name	Description
LocalizationType
RegistrationType

Interfaces

Name	Description
IActionMarkupHandler	A IActionMarkupHandler is an object that reacts to the delivery of a line of dialogue, and can optionally control the timing of that delivery.
IActionRegistration	Contains methods that allow adding and removing Yarn commands and functions.
IAssetProvider	Contains methods for accessing assets of a given type stored within an object.
ICommand
IGeneratedVariableStorage	An interface that works with GeneratedVariableStorageExtensions to add helper methods used by generated variable storage classes.
ILineProvider	Contains methods for retrieving user-facing localized content, given non-localized line IDs.
IYarnTask

Namespaces

Name	Description
Yarn.Unity.Legacy	Contains compatibility features for code designed to work with earlier versions of Yarn Spinner for Unity.
Yarn.Unity.Samples
Yarn.Unity.UnityLocalization	Contains classes for working with the Unity Localization system and Yarn Spinner.

Structs

Name	Description
Culture	Holds information about a language.
LineCancellationToken	A Line Cancellation Token stores information about whether a dialogue presenter should stop its delivery.
StringTableEntry
YarnTask
YarnTask