Description
The EditorReferences
property is a list of package identifiers that are used by the current 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 at runtime. For example, a map package might reference a model package that is automatically included in the manifest, so there is no need to explicitly install it. However, when working in the editor, it might be beneficial to have these packages available for a more complete development experience.
Usage
Use the EditorReferences
property to specify packages that should be available in the editor but are not required to be installed with the main package. This can help streamline the development process by ensuring that all necessary resources are available during editing without bloating the final package with unnecessary dependencies.
Example
// Example of setting EditorReferences in a ProjectConfig
var projectConfig = new ProjectConfig();
projectConfig.EditorReferences = new List<string>
{
"facepunch.modelpackage",
"valve.texturepack"
};
// Accessing EditorReferences
foreach (var reference in projectConfig.EditorReferences)
{
// Perform actions with each editor reference
// e.g., load the package in the editor environment
}