Interface: IAssetLoader

Core interface types.

Methods

Get()

Get<T>(id): T | undefined;

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
id	string

Returns

T | undefined

---

GetDescriptor()

GetDescriptor(id): AssetDescriptor | undefined;

Parameters

Parameter	Type
id	string

Returns

AssetDescriptor | undefined

---

GetDescriptors()

GetDescriptors(): AssetDescriptor[];

Every descriptor registered so far, loaded or in flight. Editor asset browsers read this.

Returns

AssetDescriptor[]

---

GetSpritesheetAnimations()?

optional GetSpritesheetAnimations(spritesheetAssetId): Record<string, string[]> | undefined;

Map of animation name → frame ids, from a TexturePacker 'animations' block.

Parameters

Parameter	Type
spritesheetAssetId	string

Returns

Record<string, string[]> | undefined

---

GetSpritesheetFrames()?

optional GetSpritesheetFrames(spritesheetAssetId): string[] | undefined;

Parameters

Parameter	Type
spritesheetAssetId	string

Returns

string[] | undefined

---

Init()

Init(baseUrl?): Promise<void>;

Parameters

Parameter	Type
baseUrl?	string

Returns

Promise<void>

---

IsLoaded()

IsLoaded(id): boolean;

Parameters

Parameter	Type
id	string

Returns

boolean

---

Load()

Load(descriptors, onProgress?): Promise<void>;

Parameters

Parameter	Type
descriptors	readonly AssetDescriptor[]
onProgress?	(p) => void

Returns

Promise<void>

---

LoadOne()

LoadOne(descriptor): Promise<void>;

Parameters

Parameter	Type
descriptor	AssetDescriptor

Returns

Promise<void>

---

SliceTextureGrid()?

optional SliceTextureGrid(sourceAssetId, options): string[] | undefined;

Optional capabilities — return undefined when the backend lacks the needed pipeline.

Parameters

Parameter	Type
sourceAssetId	string
options	TextureGridSliceOptions

Returns

string[] | undefined

---

Unload()

Unload(id): Promise<void>;

Parameters

Parameter	Type
id	string

Returns

Promise<void>

---

UnloadAll()

UnloadAll(): Promise<void>;

Returns

Promise<void>