> 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/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject.md).

# YarnProject

Class in [Yarn.Unity](/3.1/api/csharp/yarn.unity.md)

Inherits from `UnityEngine.ScriptableObject`

## Summary

```csharp
public sealed class YarnProject : ScriptableObject
```

## Classes

| Name                                                                                                                       | Description |
| -------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [ShadowTableDictionary](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.shadowtabledictionary.md) |             |

## Fields

| Name                                                                                                                   | Description |
| ---------------------------------------------------------------------------------------------------------------------- | ----------- |
| [baseLocalization](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.baselocalization.md)       |             |
| [compiledYarnProgram](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.compiledyarnprogram.md) |             |
| [lineMetadata](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.linemetadata.md)               |             |
| [localizations](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.localizations.md)             |             |
| [localizationType](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.localizationtype.md)       |             |

## Methods

| Name                                                                                                                              | Description                                                          |
| --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
| [GetHeaders(string)](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.getheaders.md)                      | Gets the headers for the requested node.                             |
| [GetLineIDsForNodes(IEnumerable)](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.getlineidsfornodes.md) | Returns a list of all line and option IDs within the requested nodes |
| [GetLocalization(string)](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.getlocalization.md)            | Gets a Localization given a locale code.                             |

## Properties

| Name                                                                                                       | Description                                                                                                                                                                                                            |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [InitialValues](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.initialvalues.md) | The default values of all declared or inferred variables in the [Program](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.program.md) . Organised by their name as written in the yarn files. |
| [NodeNames](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.nodenames.md)         | The names of all nodes contained within the [Program](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.program.md) .                                                                           |
| [Program](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.program.md)             | Gets the Yarn Program stored in this project.                                                                                                                                                                          |

## Structs

| Name                                                                                                             | Description |
| ---------------------------------------------------------------------------------------------------------------- | ----------- |
| [ShadowTableEntry](/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.shadowtableentry.md) |             |
