Interface IAssetImporter<TE>

interface IAssetImporter<
    TE extends IAssetImporterEventMap = IAssetImporterEventMap,
> {
    cachedAssets: IAsset[];
    loadingManager: LoadingManager;
    addURLModifier(modifier: (url: string) => string): void;
    import<T extends ImportResult = ImportResult>(
        assetOrPath?: string | IAsset,
        options?: ImportAssetOptions,
    ): Promise<(undefined | T)[]>;
    importFiles(
        files: Map<string, IFile>,
        options?: ImportFilesOptions,
    ): Promise<undefined | Map<string, any[]>>;
    importSingle<T extends ImportResult = ImportResult>(
        asset?: string | IAsset,
        options?: ImportAssetOptions,
    ): Promise<undefined | T>;
    processRaw(res: any, options: ProcessRawOptions): Promise<any[]>;
    registerFile(path: string, file?: IFile): undefined | ILoader<any, any>;
    removeURLModifier(modifier: (url: string) => string): void;
    unregisterFile(path: string): void;
}

Type Parameters

TE extends IAssetImporterEventMap = IAssetImporterEventMap

Hierarchy

EventDispatcher<TE>
IDisposable
- IAssetImporter

Implemented by

AssetImporter

Index

Properties

cachedAssets loadingManager

Methods

addURLModifier import importFiles importSingle processRaw registerFile removeURLModifier unregisterFile

Properties

`Readonly`cachedAssets

cachedAssets: IAsset[]

`Readonly`loadingManager

loadingManager: LoadingManager

Methods

addURLModifier

addURLModifier(modifier: (url: string) => string): void
Parameters
- modifier: (url: string) => string
Returns void
- Defined in src/assetmanager/IAssetImporter.ts:290

import

import<T extends ImportResult = ImportResult>(
assetOrPath?: string | IAsset,
options?: ImportAssetOptions,
): Promise<(undefined | T)[]>
Import single or multiple assets(like in case of zip files) from a path(url) or an IAsset.
Type Parameters
- T extends ImportResult = ImportResult
Parameters
- OptionalassetOrPath: string | IAsset
  The path or asset to import
- Optionaloptions: ImportAssetOptions
  Options for the import
Returns Promise<(undefined | T)[]>
- Defined in src/assetmanager/IAssetImporter.ts:253

importFiles

importFiles(
files: Map<string, IFile>,
options?: ImportFilesOptions,
): Promise<undefined | Map<string, any[]>>
Import multiple local files/blobs from a map of files.
Parameters
- files: Map<string, IFile>
- Optionaloptions: ImportFilesOptions
Returns Promise<undefined | Map<string, any[]>>
- Defined in src/assetmanager/IAssetImporter.ts:267

importSingle

importSingle<T extends ImportResult = ImportResult>(
asset?: string | IAsset,
options?: ImportAssetOptions,
): Promise<undefined | T>
Import a single asset from a path(url) or an IAsset.
Type Parameters
- T extends ImportResult = ImportResult
Parameters
- Optionalasset: string | IAsset
- Optionaloptions: ImportAssetOptions
Returns Promise<undefined | T>
- Defined in src/assetmanager/IAssetImporter.ts:260

processRaw

processRaw(res: any, options: ProcessRawOptions): Promise<any[]>
Process the raw output from the loaders and return the updated/patched-objects.
Parameters
- res: any
- options: ProcessRawOptions
Returns Promise<any[]>
- Defined in src/assetmanager/IAssetImporter.ts:288

registerFile

registerFile(path: string, file?: IFile): undefined | ILoader<any, any>
Register a file to a specific path, so this file will be used when importing the path.
Parameters
- path: string
- Optionalfile: IFile
Returns undefined | ILoader<any, any>
- Defined in src/assetmanager/IAssetImporter.ts:275

removeURLModifier

removeURLModifier(modifier: (url: string) => string): void
Parameters
- modifier: (url: string) => string
Returns void
- Defined in src/assetmanager/IAssetImporter.ts:291

unregisterFile

unregisterFile(path: string): void
Unregister a file from a specific path.
Parameters
- path: string
Returns void
- Defined in src/assetmanager/IAssetImporter.ts:281