Comment on page

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.
Fields
Name
Description
​CurrentProjectFileVersion​
The current version of .yarnproject file format.
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.
​LoadFromFile(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
​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.
​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.
​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.

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

Name	Description
CurrentProjectFileVersion	The current version of `.yarnproject` file format.

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.
LoadFromFile(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.

Name	Description
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.
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.
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.

Line

CurrentProjectFileVersion

Last modified 2mo ago