Skip to main content

Editor.Assets.NativePackageDescriptor

Class

Metadata descriptor for a native package asset.

Index

Example

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

const selectedAssets = selection.assets;
if (selectedAssets.length === 0) return;

const asset = selectedAssets[0];

// Walk the package chain: asset -> fileMeta -> topmostNativePackageRoot -> nativePackageDescriptor
const meta = asset.fileMeta;
if (Editor.isNull(meta)) return;

const rootMeta = meta.topmostNativePackageRoot;
if (Editor.isNull(rootMeta)) return;

const descriptor = rootMeta.nativePackageDescriptor;
if (Editor.isNull(descriptor)) return;

// Only instantiate if the package has a non-empty setupScript
if (Editor.isNull(descriptor.setupScript) || descriptor.setupScript.code.length === 0) return;

console.log(`Instantiating package "${descriptor.packageName}" for asset: ${asset.name}`);
const result = await assetManager.instantiate([asset]);

Extends

Properties

attachments

attachments: Asset[]

Array of asset files included in the package.


cacheFile

readonly cacheFile: Path

Path to the cached asset file.

Inherited from

Asset.cacheFile


componentId

readonly componentId: Uuid

Unique identifier for the package component.


description

description: string

Human-readable description of the package.


exportId

readonly exportId: Uuid

Unique identifier for the package export.


fileMeta

readonly fileMeta: AssetImportMetadata

Import metadata for the asset.

Inherited from

Asset.fileMeta


icon

icon: Icon

Visual icon representing the package.


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Asset.id


meta

readonly meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

Inherited from

Asset.meta


name

readonly name: string

The name of the asset.

Inherited from

Asset.name


packageName

readonly packageName: string

Name of the package.


readMe

readMe: MarkdownAsset

Documentation text for the package.


setupScript

setupScript: SetupScript

Script executed during package setup.


tags

tags: string[]

Keywords or categories for package discovery.


type

readonly type: string

The entity's type.

Inherited from

Asset.type


version

version: Version

Version number of the package.

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

Asset.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Asset.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

Asset.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Asset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Asset.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Asset.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

Asset.isSame