# Yarn.Unity Namespace

## Summary

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

## Classes

| Name                                                                                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                        |
| -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [AssemblyExtensions](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.assemblyextensions)                 |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [AudioLineProvider](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.audiolineprovider)                   |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [AudioLocalizedLine](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.audiolocalizedline)                 |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [CharacterColorView](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.charactercolorview)                 |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [Cultures](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.cultures)                                     | Provides access to all [Culture](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.culture) s supported by Yarn Spinner.                                                                                                                                                                                                                                                                                           |
| [DialogueCharacterNameView](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.dialoguecharacternameview)   | A subclass of [DialogueViewBase](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.dialogueviewbase) that displays character names.                                                                                                                                                                                                                                                                                |
| [DialogueOption](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.dialogueoption)                         |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [DialogueRunner](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.dialoguerunner)                         | The DialogueRunner component acts as the interface between your game and Yarn Spinner.                                                                                                                                                                                                                                                                                                                                             |
| [DialogueViewBase](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.dialogueviewbase)                     | A `MonoBehaviour` that can present the data of a dialogue executed by a [DialogueRunner](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.dialoguerunner) to the user. The [DialogueRunner](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.dialoguerunner) uses subclasses of this type to relay information to and from the user, and to pause and resume the execution of the `YarnScript` . |
| [Effects](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.effects)                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [FindVoiceOver](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.findvoiceover)                           | Provides methods for finding voice over `AudioClip` s in the project matching a Yarn linetag/string ID and a language ID.                                                                                                                                                                                                                                                                                                          |
| [InMemoryVariableStorage](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.inmemoryvariablestorage)       | A simple implementation of VariableStorageBehaviour.                                                                                                                                                                                                                                                                                                                                                                               |
| [InterruptionFlag](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.interruptionflag)                     |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [LanguageAttribute](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.languageattribute)                   |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [LineProviderBehaviour](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.lineproviderbehaviour)           | A `MonoBehaviour` that produces [LocalizedLine](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.localizedline) s.                                                                                                                                                                                                                                                                                                |
| [LineView](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.lineview)                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [Localization](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.localization)                             |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [LocalizedLine](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.localizedline)                           | Represents a line, ready to be presented to the user in the localisation they have specified.                                                                                                                                                                                                                                                                                                                                      |
| [OptionsListView](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.optionslistview)                       |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [OptionView](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.optionview)                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [SampleRenderDetector](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.samplerenderdetector)             | Detects if the render pipeline is different from the one the samples were created with, and warn you that things might look odd.                                                                                                                                                                                                                                                                                                   |
| [SerializedDictionary](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.serializeddictionary)             | An `IDictionary<TKey,TValue>` that can be serialized as part of a Unity object.                                                                                                                                                                                                                                                                                                                                                    |
| [TextLineProvider](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.textlineprovider)                     |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [VariableStorageBehaviour](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.variablestoragebehaviour)     | A `MonoBehaviour` that a [DialogueRunner](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.dialoguerunner) uses to store and retrieve variables.                                                                                                                                                                                                                                                                  |
| [VoiceOverPlaybackUnity](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.voiceoverplaybackunity)         | Handles playback of voice over `AudioClip` s referenced on `YarnScript` s.                                                                                                                                                                                                                                                                                                                                                         |
| [YarnActionAttribute](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.yarnactionattribute)               |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [YarnCommandAttribute](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.yarncommandattribute)             | An attribute that marks a method on an object as a command.                                                                                                                                                                                                                                                                                                                                                                        |
| [YarnFunctionAttribute](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.yarnfunctionattribute)           | Marks the method as a function to be registered with the running instance's library.                                                                                                                                                                                                                                                                                                                                               |
| [YarnLinesAsCanvasText](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.yarnlinesascanvastext)           | Shows Yarn lines on Canvas Text components.                                                                                                                                                                                                                                                                                                                                                                                        |
| [YarnParameterAttribute](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.yarnparameterattribute)         | Yarn parameter.                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [YarnProject](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.yarnproject)                               |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [YarnStateInjectorAttribute](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.yarnstateinjectorattribute) | Inject state for any commands in this class using this static method.                                                                                                                                                                                                                                                                                                                                                              |

## Enums

| Name                                                                                                          | Description                                                                                                                     |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| [LineStatus](https://github.com/YarnSpinnerTool/YSDocs/blob/versions/2.0/api/csharp/yarn.unity.linestatus.md) | The presentation status of a [LocalizedLine](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.localizedline) . |

## Structs

| Name                                                                                                   | Description                         |
| ------------------------------------------------------------------------------------------------------ | ----------------------------------- |
| [Culture](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.culture)                   | Holds information about a language. |
| [StringTableEntry](https://docs.yarnspinner.dev/2.0/api/csharp/yarn.unity/yarn.unity.stringtableentry) |                                     |
