# YarnProject

Class in [Yarn.Unity](https://docs.yarnspinner.dev/3.1/api/csharp/yarn.unity)

Inherits from `UnityEngine.ScriptableObject`

## Summary

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

## Classes

| Name                                                                                                                                                | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [ShadowTableDictionary](https://docs.yarnspinner.dev/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.shadowtabledictionary) |             |

## Fields

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

## Methods

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

## Properties

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

## Structs

| Name                                                                                                                                      | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [ShadowTableEntry](https://docs.yarnspinner.dev/3.1/api/csharp/yarn.unity/yarn.unity.yarnproject/yarn.unity.yarnproject.shadowtableentry) |             |