Skip to main content

Editor.Model.ExportOptions

Class

Options controlling how a model is exported, including dependency handling and packaging policy.

Index

Example

const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;

// Construct ExportOptions and configure its properties
const opts = new Editor.Model.ExportOptions();
opts.packagePolicy = Editor.Assets.PackagePolicy.CanBeUnpacked;
opts.externalDependencies = [];

console.log('packagePolicy:', opts.packagePolicy);
console.log('externalDependencies:', opts.externalDependencies.length);

Constructors

Constructor

new ExportOptions(): ExportOptions

Constructs a new ExportOptions instance with default export configuration values.

Returns

ExportOptions

Properties

externalDependencies

externalDependencies: ExternalPackageDependency[]

List of external package dependencies required by the exported model.


packagePolicy

packagePolicy: PackagePolicy

Policy determining how packages are handled during export.


pluginsToInclude

pluginsToInclude: Path[]

Absolute paths of plugins to bundle alongside the exported package.


previewsToInclude

previewsToInclude: Path[]

Absolute paths of preview videos and images to bundle with the exported package. When the package is imported, they appear as custom sources in the Preview panel.