Skip to main content

Editor.Assets.PackagePolicy

Enum

Enum defining how asset packages can be unpacked and their transparency handling.

Index

Example

const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const assetManager = model.project.assetManager;
const packages = assetManager.assets.filter(
a => a.isOfType('NativePackageDescriptor')
) as Editor.Assets.NativePackageDescriptor[];

// PackagePolicy values:
// CanBeUnpacked, CannotBeUnpacked, CanBeUnpackedTransparent
const exportOpts = new Editor.Model.ExportOptions();
exportOpts.packagePolicy = Editor.Assets.PackagePolicy.CanBeUnpacked;

console.log(`Found ${packages.length} NativePackageDescriptor(s); export policy set to CanBeUnpacked (${exportOpts.packagePolicy})`);

Enumeration Members

CanBeUnpacked

CanBeUnpacked: number

Package can be unpacked.


CanBeUnpackedTransparent

CanBeUnpackedTransparent: number

Package can be unpacked and uses transparent handling.


CannotBeUnpacked

CannotBeUnpacked: number

Package cannot be unpacked.


CannotBeUnpackedTransparent

CannotBeUnpackedTransparent: number

Package cannot be unpacked and uses transparent handling.


ShouldBeUnpacked

ShouldBeUnpacked: number

Package is required to be unpacked before its assets can be used.