Editor Scripting API
    Preparing search index...

    Class AssetImportMetadata

    A handle for the metadata of an asset.

    // Get an asset by either finding an already imported one, or importing it.
    export function findOrCreate(assetManager, absolutePath) {
        let meta = assetManager.findImportedCopy(absolutePath);
        if (meta) {
            return meta.primaryAsset;
        }

        meta = assetManager.importExternalFile(absolutePath);
        return meta.primaryAsset;
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    assets assetTreePath compressionSettings id isPackageRoot isPackedPackageItem meta nativePackageDescriptor nativePackageRoot packagePolicy primaryAsset sourcePath topmostNativePackageRoot type

    Methods

    getDirectlyReferencedEntities getExtraDataItem getMeta getNativePackageItems getOwnedEntities getTypeName getTypeName isOfType isSame setExtraDataItem staticMeta

    Constructors

    Properties

    assets: Editor.Assets.Asset[]

    A list of all the available assets this handle contains.

    assetTreePath: SourcePath

    Source path of this asset within the asset tree.

    compressionSettings: AssetCompressionSettings

    Compression strategy applied when this asset is imported; assign an AssetCompressionSettings subclass such as SizeCompressionSettings or DracoCompressionSettings.

    id: Uuid

    The unique id of the entity.

    isPackageRoot: boolean

    Whether this metadata entry represents the root of a native asset package.

    isPackedPackageItem: boolean

    Indicates whether this item is packed inside a native package.

    meta: Meta

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

    nativePackageDescriptor: NativePackageDescriptor

    Descriptor identifying the native package associated with this import metadata.

    nativePackageRoot: Editor.Model.AssetImportMetadata

    Root AssetImportMetadata entry of the native package containing this item.

    packagePolicy: PackagePolicy

    Package policy describing whether and how the native package containing this asset can be unpacked.

    primaryAsset: Editor.Assets.Asset

    The primary asset of this handle. Usually, this is the asset you will assign after accessing an asset.

    sourcePath: Path

    The source file where the asset was imported from.

    topmostNativePackageRoot: Editor.Model.AssetImportMetadata

    Topmost root AssetImportMetadata in the native package hierarchy.

    type: string

    The entity's type.

    Methods

    • Retrieves a string value from the extra data store by key.

      Parameters

      • key: string

      Returns string

    • Returns the type name of this class.

      Returns string

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

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

      Parameters

      Returns boolean

    • Stores a string value in the extra data store under the given key.

      Parameters

      • key: string
      • value: string

      Returns void

    • Returns the static metadata descriptor for the AssetImportMetadata type.

      Returns Meta

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods