Yarn.Unity Namespace

Summary

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

Attributes

NameDescription
YarnActionAttribute

Classes

NameDescription
ActionMarkupHandlerThis is an abstract monobehaviour that conforms to the IActionMarkupHandler interface.
ActionRegistrationExtensionContains extension methods for IActionRegistration objects.
Actions
BuiltinLocalisedLineProvider
CulturesProvides access to all Culture s supported by Yarn Spinner.
DialogueOption
DialoguePresenterBaseA UnityEngine.MonoBehaviour that can present lines and options to the user, when it receives them from a DialogueRunner .
DialogueReferenceStores a reference to a dialogue node in a Yarn Project.
DialogueRunner
Effects
GeneratedVariableStorageExtensions
InMemoryVariableStorageA simple implementation of VariableStorageBehaviour.
InputSystemAvailability
InstantTypewriterAn implementation of IAsyncTypewriter that delivers all content instantly, and invokes any IActionMarkupHandler s along the way as needed.
InterfaceContainer
LetterTypewriterAn implementation of IAsyncTypewriter that delivers characters one at a time, and invokes any IActionMarkupHandler s along the way as needed.
LineAdvancerA 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
LinePresenterA Dialogue Presenter that presents lines of dialogue, using Unity UI elements.
LinePresenterButtonHandler
LineProviderBehaviourA UnityEngine.MonoBehaviour that produces LocalizedLine s, for use in Dialogue Presenters.
Localization
LocalizedLineRepresents a line, ready to be presented to the user in the localisation they have specified.
MarkupPaletteRepresents a collection of marker names and colours.
OptionItem
OptionsPresenterReceives options from a DialogueRunner , and displays and manages a collection of OptionItem views for the user to choose from.
PauseEventProcessorAllows pausing the current typewrite through [pause/] markers.
ReplacementMarkupHandlerAn 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>
StyleMarkerProcessorAn attribute marker processor that inserts TextMeshPro style tags where Yarn Spinner [style] tags appear in a line.
UnityEventStringA UnityEngine.Events.UnityEvent that takes a single string parameter.
VariableStorageBehaviourA UnityEngine.MonoBehaviour that a DialogueRunner uses to store and retrieve variables.
VoiceOverPresenterA subclass of DialoguePresenterBase that plays voice-over UnityEngine.AudioClip s for lines of dialogue.
WordTypewriterAn implementation of IAsyncTypewriter that delivers words one at a time, and invokes any IActionMarkupHandler s along the way as needed.
YarnCommandAttributeAn attribute that marks a method on an object as a command.
YarnFunctionAttributeMarks the method as a function to be registered with the running instance’s library.
YarnProject
YarnTaskCompletionSource
YarnTaskCompletionSource
YarnTaskExtensions

Enums

Interfaces

NameDescription
IActionMarkupHandlerA IActionMarkupHandler is an object that reacts to the delivery of a line of dialogue, and can optionally control the timing of that delivery.
IActionRegistrationContains methods that allow adding and removing Yarn commands and functions.
IAssetProviderContains methods for accessing assets of a given type stored within an object.
IAsyncTypewriterAn object that can handle delivery of a line’s text over time.
ICommand
IGeneratedVariableStorageAn interface that works with GeneratedVariableStorageExtensions to add helper methods used by generated variable storage classes.
ILineProviderContains methods for retrieving user-facing localized content, given non-localized line IDs.
IYarnTask

Namespaces

NameDescription
Yarn.Unity.Editor
Yarn.Unity.Samples
Yarn.Unity.UnityLocalizationContains classes for working with the Unity Localization system and Yarn Spinner.

Structs

NameDescription
CultureHolds information about a language.
LineCancellationTokenA Line Cancellation Token stores information about whether a dialogue presenter should stop its delivery.
StringTableEntry
YarnTask
YarnTask