Yarn.Unity Namespace
Contains classes for using compiled Yarn programs in the Unity game engine.
Classes
| Name | Description |
|---|---|
| DialogueRunner | The DialogueRunner component acts as the interface between your game and Yarn Spinner. |
| DialogueRunner.StringUnityEvent | A type of UnityEvent that takes a single string parameter. |
| DialogueUI | Displays dialogue lines to the player, and sends user choices back to the dialogue system. |
| DialogueUIBehaviour | A MonoBehaviour that can display lines, options and commands to the user, and receive input regarding their choices. |
| InMemoryVariableStorage | An simple implementation of DialogueUnityVariableStorage, which stores everything in memory. |
| InMemoryVariableStorage.DefaultVariable | A default value to apply when the object wakes up, or when ResetToDefaults is called. |
| VariableStorageBehaviour | A MonoBehaviour that a DialogueRunner uses to store and retrieve variables. |
| YarnCommandAttribute | An attribute that marks a method on a MonoBehaviour as a command. |
Delegates
| Name | Description |
|---|---|
| DialogueRunner.BlockingCommandHandler | Represents a method that can be called when the DialogueRunner encounters a command. |
| DialogueRunner.CommandHandler | Represents a method that can be called when the DialogueRunner encounters a command. |
Interfaces
| Name | Description |
|---|---|
| ILineLocalisationProvider | Provides a mechanism for determining the user-facing localised content for a Line. |