Yarn.Unity Namespace

Summary

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

Attributes

Name
Description

Classes

Name
Description

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 presents lines of dialogue, using Unity UI elements.

Represents a line, ready to be presented to the user in the localisation they have specified.

Represents a collection of marker names and colours.

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.

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

Name
Description

Interfaces

Name
Description

Contains methods that allow adding and removing Yarn commands and functions.

Contains methods for accessing assets of a given type stored within an object.

Contains methods for retrieving user-facing localized content, given non-localized line IDs.

Namespaces

Name
Description

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

Name
Description

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?