Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Field in Project
The current version of .yarnproject file format.
public const int CurrentProjectFileVersion = YarnSpinnerProjectVersion3;Field in Project
A version number representing Yarn Spinner 3.
public const int YarnSpinnerProjectVersion3 = 3;Method in Project
Gets a value indicating whether number is a valid Yarn Spinner version number.
public static bool IsValidVersionNumber(int number)int number
public static Project LoadFromFile(string path, string? workspaceRoot = null)Property in
Gets or sets the path to a JSON file containing command and function definitions that this project references.
Definitions files are used by editing tools to provide type information and other externally-defined data used by the Yarn scripts.
Property in
Gets or sets the collection of file search patterns that should be excluded from this project.
If a file is matched by a pattern in , and is also matched by a pattern in , then it is not included in the value returned by .
public string? Definitions { get; set; }public IEnumerable<string> ExcludeFilePatterns { get; set; }Property in
Gets or sets the location at which the localized string table may be found.
Property in
Gets or sets the location at which localized assets may be found.
public string? Strings { get; set; }public string? Assets { get; set; }Method in
Gets a string containing JSON-formatted text that represents this .
The , serialized to JSON.
public string GetJson();Field in
A placeholder string that represents the location of the workspace root in paths.
public const string WorkspaceRootPlaceholder = "${workspaceRoot}";Method in
Saves a as JSON-formatted text to a file on disk.
Property in
Gets or sets a value indicating whether compiler features that are not intended for production use are allowed.
Field in
A version number representing Yarn Spinner 2.
Constructor in
Initializes a new instance of the class.
public void SaveToFile(string path);string path
The path of the file to write to.
public bool AllowLanguagePreviewFeatures { get; set; }public const int YarnSpinnerProjectVersion2 = 2;public Project()Method in Project
Gets a value indicating whether path is a path that is included in this project.
string path
The path to check.
true if path is a path that is included in this project; false otherwise.
Property in Project
Gets or sets a dictionary containing instructions that control how the Yarn Spinner compiler should compile a project.
public Dictionary<string, JsonValue> CompilerOptions { get; set; }public bool IsMatchingPath(string path)Constructor in
Initializes a new instance of the class.
public Project(string path, string? workspaceRootPath = null)string path
The value to use for the new instance's property.
string workspaceRootPath
The path to the root of the current workspace, or null .
Property in
Gets or sets the base language of the project, as an IETF BCP-47 language tag.
The base language is the language that the Yarn scripts is written in.
public string BaseLanguage { get; set; }Property in
Contains any data parsed from the source file that was not matched to a property on this type.
Property in
Gets or sets the file version of the project.
This value is required to be equal to .
Property in
Gets the path to the Definitions file, relative to this project's location.
: Gets the absolute paths to the project's Definitions files.
Property in
Gets the absolute paths to the project's Definitions files.
Property in
Gets the path that the was loaded from.
This value is not stored when the file is saved, but is instead determined when the file is loaded by , or provided when the is constructed.
public Dictionary<string, JsonElement>? ExtensionData { get; set; }public int FileVersion { get; set; }public string? DefinitionsPath { get; }This property is obsolete and may be removed from a future version of Yarn Spinner: Use DefinitionsFilesPattern.
public IEnumerable<string> DefinitionsFiles { get; }public string? Path { get; set; }Property in Project
Gets or sets the collection of LocalizationInfo objects that store information about where localized data for this project is found.
public Dictionary<string, LocalizationInfo> Localisation { get; set; }Property in Project
The location of the root of the workspace in which this project is located.
public string? WorkspaceRootPath { get; set; }Property in Project
Gets or sets the collection of file search patterns used to locate Yarn files that form this project.
public IEnumerable<string> SourceFilePatterns { get; set; }Class in Project
Inherits from System.Object
Stores the locations of where localized assets and a localized string table for a Yarn Project may be found.
public class LocalizationInfoProperty in
Gets the collection of Yarn files that should be used to compile the project.
This collection uses a Yarn.Compiler.Project.Matcher to find all files specified by , excluding those that are specified by .
public IEnumerable<string> SourceFiles { get; }Gets or sets the location at which localized assets may be found.
Gets or sets the location at which the localized string table may be found.
Class in Yarn.Compiler
Inherits from System.Object
Yarn Projects represent instructions on where to find Yarn scripts and associated assets, and how they should be compiled.
public class ProjectStores the locations of where localized assets and a localized string table for a Yarn Project may be found.
Initializes a new instance of the class.
Initializes a new instance of the class.
The current version of .yarnproject file format.
A placeholder string that represents the location of the workspace root in paths.
Gets a string containing JSON-formatted text that represents this .
Gets a value indicating whether path is a path that is included in this project.
Gets or sets a value indicating whether compiler features that are not intended for production use are allowed.
Gets or sets the base language of the project, as an IETF BCP-47 language tag.
A version number representing Yarn Spinner 2.
A version number representing Yarn Spinner 3.
Gets a value indicating whether number is a valid Yarn Spinner version number.
Loads and parses a from a file on disk.
Saves a as JSON-formatted text to a file on disk.
Gets or sets a dictionary containing instructions that control how the Yarn Spinner compiler should compile a project.
Gets or sets the path to a JSON file containing command and function definitions that this project references.
Gets the absolute paths to the project's Definitions files.
Gets the path to the Definitions file, relative to this project's location.
Gets or sets the collection of file search patterns that should be excluded from this project.
Contains any data parsed from the source file that was not matched to a property on this type.
Gets or sets the file version of the project.
Gets or sets the collection of objects that store information about where localized data for this project is found.
Gets the path that the was loaded from.
Gets or sets the collection of file search patterns used to locate Yarn files that form this project.
Gets the collection of Yarn files that should be used to compile the project.
The location of the root of the workspace in which this project is located.