Yarn.Unity Namespace
Summary
Contains classes for working with Yarn Spinner in the Unity game engine.
Attributes
Classes
This is an abstract monobehaviour that conforms to the IActionMarkupHandler interface.
Contains extension methods for IActionRegistration objects.
A UnityEngine.MonoBehaviour that can present lines and options to the user, when it receives them from a DialogueRunner .
Stores a reference to a dialogue node in a Yarn Project.
Contains coroutine methods that apply visual effects. This class is used by LineView to handle animating the presentation of lines.
A simple implementation of VariableStorageBehaviour.
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.
A Dialogue Presenter that presents lines of dialogue, using Unity UI elements.
A UnityEngine.MonoBehaviour that produces LocalizedLine s, for use in Dialogue Presenters.
Represents a line, ready to be presented to the user in the localisation they have specified.
Represents a collection of marker names and colours.
Receives options from a DialogueRunner , and displays and manages a collection of OptionItem views for the user to choose from.
Allows pausing the current typewrite through [pause/] markers.
An attribute marker processor receives a marker found in a Yarn line, and optionally rewrites the marker and its children into a new form.
An attribute marker processor that inserts TextMeshPro style tags where Yarn Spinner [style] tags appear in a line.
A UnityEngine.Events.UnityEvent that takes a single string parameter.
A UnityEngine.MonoBehaviour that a DialogueRunner uses to store and retrieve variables.
A subclass of DialoguePresenterBase that plays voice-over UnityEngine.AudioClip s for lines of dialogue.
An attribute that marks a method on an object as a command.
Marks the method as a function to be registered with the running instance's library.
Enums
Interfaces
A IActionMarkupHandler is an object that reacts to the delivery of a line of dialogue, and can optionally control the timing of that delivery.
Contains methods that allow adding and removing Yarn commands and functions.
Contains methods for accessing assets of a given type stored within an object.
An interface that works with GeneratedVariableStorageExtensions to add helper methods used by generated variable storage classes.
Contains methods for retrieving user-facing localized content, given non-localized line IDs.
Namespaces
Contains compatibility features for code designed to work with earlier versions of Yarn Spinner for Unity.
Contains classes for working with the Unity Localization system and Yarn Spinner.
Structs
Holds information about a language.
A Line Cancellation Token stores information about whether a dialogue presenter should stop its delivery.
Last updated
Was this helpful?