Project

Class in Yarn.Compiler

Inherits from System.Object

Summary

Yarn Projects represent instructions on where to find Yarn scripts and associated assets, and how they should be compiled.

public class Project

Classes

Name	Description
LocalizationInfo	Stores the locations of where localized assets and a localized string table for a Yarn Project may be found.

Constructors

Name	Description
Project()	Initializes a new instance of the Project class.
Project(string,string?)	Initializes a new instance of the Project class.

Fields

Name	Description
CurrentProjectFileVersion	The current version of .yarnproject file format.
WorkspaceRootPlaceholder	A placeholder string that represents the location of the workspace root in paths.
YarnSpinnerProjectVersion2	A version number representing Yarn Spinner 2.
YarnSpinnerProjectVersion3	A version number representing Yarn Spinner 3.

Methods

Name	Description
GetJson()	Gets a string containing JSON-formatted text that represents this Project .
IsMatchingPath(string)	Gets a value indicating whether path is a path that is included in this project.
IsValidVersionNumber(int)	Gets a value indicating whether number is a valid Yarn Spinner version number.
LoadFromFile(string,string?)	Loads and parses a Project from a file on disk.
SaveToFile(string)	Saves a Project as JSON-formatted text to a file on disk.

Properties

Name	Description
AllowLanguagePreviewFeatures	Gets or sets a value indicating whether compiler features that are not intended for production use are allowed.
BaseLanguage	Gets or sets the base language of the project, as an IETF BCP-47 language tag.
CompilerOptions	Gets or sets a dictionary containing instructions that control how the Yarn Spinner compiler should compile a project.
Definitions	Gets or sets the path to a JSON file containing command and function definitions that this project references.
DefinitionsFiles	Gets the absolute paths to the project's Definitions files.
DefinitionsPath	Gets the path to the Definitions file, relative to this project's location.
ExcludeFilePatterns	Gets or sets the collection of file search patterns that should be excluded from this project.
ExtensionData	Contains any data parsed from the source file that was not matched to a property on this type.
FileVersion	Gets or sets the file version of the project.
Localisation	Gets or sets the collection of LocalizationInfo objects that store information about where localized data for this project is found.
Path	Gets the path that the Project was loaded from.
SourceFilePatterns	Gets or sets the collection of file search patterns used to locate Yarn files that form this project.
SourceFiles	Gets the collection of Yarn files that should be used to compile the project.
WorkspaceRootPath	The location of the root of the workspace in which this project is located.