Description
The EditorReferences
property of the ProjectConfig
class is a list of package identifiers that are used by the package but do not need to be installed directly. These packages are typically used in the editor environment to enhance functionality or provide additional resources that are not required for the package's core functionality. For example, a map package might reference a model package that is not necessary to download because its usage is included in the manifest. However, when working in the editor, it might be beneficial to have these packages available.
Usage
Use the EditorReferences
property to specify packages that should be available in the editor environment but are not required to be installed with the package. This can help streamline the development process by ensuring that all necessary resources are available when editing, without bloating the package with unnecessary dependencies.
Example
// Example of accessing the EditorReferences property
var projectConfig = new ProjectConfig();
// Add a package reference to the editor references
projectConfig.EditorReferences.Add("example.model.package");
// Iterate through the editor references
foreach (var reference in projectConfig.EditorReferences)
{
// Perform actions with each reference
Console.WriteLine($"Editor Reference: {reference}");
}