> For the complete documentation index, see [llms.txt](https://docs.yarnspinner.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yarnspinner.dev/2.3/api/csharp/yarn.unity.md). # Yarn.Unity Namespace ## Summary Contains classes for working with Yarn Spinner in the Unity game engine. ## Attributes | Name | Description | | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | [YarnActionAttribute](/2.3/api/csharp/yarn.unity/yarn.unity.yarnactionattribute.md) | | | [YarnParameterAttribute](/2.3/api/csharp/yarn.unity/yarn.unity.yarnparameterattribute.md) | Yarn parameter. | | [YarnStateInjectorAttribute](/2.3/api/csharp/yarn.unity/yarn.unity.yarnstateinjectorattribute.md) | Inject state for any commands in this class using this static method. | ## Classes | Name | Description | | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Actions](/2.3/api/csharp/yarn.unity/yarn.unity.actions.md) | | | [AudioLineProvider](/2.3/api/csharp/yarn.unity/yarn.unity.audiolineprovider.md) | | | [CharacterColorView](/2.3/api/csharp/yarn.unity/yarn.unity.charactercolorview.md) | | | [Cultures](/2.3/api/csharp/yarn.unity/yarn.unity.cultures.md) | Provides access to all [Culture](/2.3/api/csharp/yarn.unity/yarn.unity.culture.md) s supported by Yarn Spinner. | | [DialogueAdvanceInput](/2.3/api/csharp/yarn.unity/yarn.unity.dialogueadvanceinput.md) | A component that listens for user input, and uses it to notify a dialogue view that the user wishes to advance to the next step in the dialogue. | | [DialogueCharacterNameView](/2.3/api/csharp/yarn.unity/yarn.unity.dialoguecharacternameview.md) | A subclass of [DialogueViewBase](/2.3/api/csharp/yarn.unity/yarn.unity.dialogueviewbase.md) that displays character names. | | [DialogueOption](/2.3/api/csharp/yarn.unity/yarn.unity.dialogueoption.md) | | | [DialogueReference](/2.3/api/csharp/yarn.unity/yarn.unity.dialoguereference.md) | Stores a reference to a dialogue node in a Yarn Project. | | [DialogueRunner](/2.3/api/csharp/yarn.unity/yarn.unity.dialoguerunner.md) | The DialogueRunner component acts as the interface between your game and Yarn Spinner. | | [DialogueViewBase](/2.3/api/csharp/yarn.unity/yarn.unity.dialogueviewbase.md) | A `UnityEngine.MonoBehaviour` that can present lines and options to the user, when it receives them from a [DialogueRunner](/2.3/api/csharp/yarn.unity/yarn.unity.dialoguerunner.md) . | | [Effects](/2.3/api/csharp/yarn.unity/yarn.unity.effects.md) | Contains coroutine methods that apply visual effects. This class is used by [LineView](/2.3/api/csharp/yarn.unity/yarn.unity.lineview.md) to handle animating the presentation of lines. | | [InMemoryVariableStorage](/2.3/api/csharp/yarn.unity/yarn.unity.inmemoryvariablestorage.md) | A simple implementation of VariableStorageBehaviour. | | [LanguageAttribute](/2.3/api/csharp/yarn.unity/yarn.unity.languageattribute.md) | | | [LineMetadata](/2.3/api/csharp/yarn.unity/yarn.unity.linemetadata.md) | | | [LineProviderBehaviour](/2.3/api/csharp/yarn.unity/yarn.unity.lineproviderbehaviour.md) | A `UnityEngine.MonoBehaviour` that produces [LocalizedLine](/2.3/api/csharp/yarn.unity/yarn.unity.localizedline.md) s, for use in Dialogue Views. | | [LineView](/2.3/api/csharp/yarn.unity/yarn.unity.lineview.md) | A Dialogue View that presents lines of dialogue, using Unity UI elements. | | [Localization](/2.3/api/csharp/yarn.unity/yarn.unity.localization.md) | | | [LocalizedLine](/2.3/api/csharp/yarn.unity/yarn.unity.localizedline.md) | Represents a line, ready to be presented to the user in the localisation they have specified. | | [OptionsListView](/2.3/api/csharp/yarn.unity/yarn.unity.optionslistview.md) | | | [OptionView](/2.3/api/csharp/yarn.unity/yarn.unity.optionview.md) | | | [SampleRenderDetector](/2.3/api/csharp/yarn.unity/yarn.unity.samplerenderdetector.md) | Detects if the render pipeline is different from the one the samples were created with, and warn you that things might look odd. | | [SerializedDictionary](/2.3/api/csharp/yarn.unity/yarn.unity.serializeddictionary.md) | An ``System.Collections.Generic.IDictionary`2`` that can be serialized as part of a Unity object. | | [TextLineProvider](/2.3/api/csharp/yarn.unity/yarn.unity.textlineprovider.md) | | | [VariableStorageBehaviour](/2.3/api/csharp/yarn.unity/yarn.unity.variablestoragebehaviour.md) | A `UnityEngine.MonoBehaviour` that a [DialogueRunner](/2.3/api/csharp/yarn.unity/yarn.unity.dialoguerunner.md) uses to store and retrieve variables. | | [VoiceOverView](/2.3/api/csharp/yarn.unity/yarn.unity.voiceoverview.md) | A subclass of [DialogueViewBase](/2.3/api/csharp/yarn.unity/yarn.unity.dialogueviewbase.md) that plays voice-over `UnityEngine.AudioClip` s for lines of dialogue. | | [YarnCommandAttribute](/2.3/api/csharp/yarn.unity/yarn.unity.yarncommandattribute.md) | An attribute that marks a method on an object as a command. | | [YarnFunctionAttribute](/2.3/api/csharp/yarn.unity/yarn.unity.yarnfunctionattribute.md) | Marks the method as a function to be registered with the running instance's library. | | [YarnLinesAsCanvasText](/2.3/api/csharp/yarn.unity/yarn.unity.yarnlinesascanvastext.md) | Shows Yarn lines on Canvas Text components. | | [YarnNodeAttribute](/2.3/api/csharp/yarn.unity/yarn.unity.yarnnodeattribute.md) | Specifies that a field represents a reference to a named Yarn node that exists in a Yarn project. | | [YarnProject](/2.3/api/csharp/yarn.unity/yarn.unity.yarnproject.md) | | ## Enums | Name | Description | | ----------------------------------------------------------------------------- | ----------- | | [LocalizationType](/2.3/api/csharp/yarn.unity/yarn.unity.localizationtype.md) | | ## Interfaces | Name | Description | | ----------------------------------------------------------------------------------- | ----------- | | [IActionRegistration](/2.3/api/csharp/yarn.unity/yarn.unity.iactionregistration.md) | | | [ICommand](/2.3/api/csharp/yarn.unity/yarn.unity.icommand.md) | | ## Namespaces | Name | Description | | ------------------------------------------------------------------------------- | ----------- | | [Yarn.Unity.UnityLocalization](/2.3/api/csharp/yarn.unity.unitylocalization.md) | | ## Structs | Name | Description | | ----------------------------------------------------------------------------- | ----------------------------------- | | [Culture](/2.3/api/csharp/yarn.unity/yarn.unity.culture.md) | Holds information about a language. | | [StringTableEntry](/2.3/api/csharp/yarn.unity/yarn.unity.stringtableentry.md) | |