Class AssetManager<AssetTypes, AssetGroupNames>

Manages asset loading and access for ECSpresso

Type Parameters

AssetTypes extends Record<string, unknown> = Record<string, never>
AssetGroupNames extends string = string

Index

Constructors

Methods

createResource get getGroupKeys getGroupNames getGroupProgress getGroupProgressDetails getHandle getKeys getStatus isGroupLoaded isLoaded loadAsset loadAssetGroup loadEagerAssets register tryGet

Constructors

constructor

new AssetManager<
AssetTypes extends Record<string, unknown> = Record<string, never>,
AssetGroupNames extends string = string,
>(): AssetManager<AssetTypes, AssetGroupNames>
Type Parameters
- AssetTypes extends Record<string, unknown> = Record<string, never>
- AssetGroupNames extends string = string
Returns AssetManager<AssetTypes, AssetGroupNames>

Methods

createResource

createResource(): AssetsResource<AssetTypes, AssetGroupNames>
Create the $assets resource object

Returns AssetsResource<AssetTypes, AssetGroupNames>
- Defined in asset-manager.ts:287

get

get<K extends string | number | symbol>(key: K): AssetTypes[K]
Get a loaded asset. Throws if not loaded.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns AssetTypes[K]
- Defined in asset-manager.ts:141

getGroupKeys

getGroupKeys(groupName: string): (keyof AssetTypes)[]
Get all asset keys in a group
Parameters
- groupName: string
Returns (keyof AssetTypes)[]
- Defined in asset-manager.ts:331

getGroupNames

getGroupNames(): string[]
Get all group names

Returns string[]
- Defined in asset-manager.ts:324

getGroupProgress

getGroupProgress(groupName: AssetGroupNames): number
Get the loading progress of a group (0-1)
Parameters
- groupName: AssetGroupNames
Returns number
- Defined in asset-manager.ts:239

getGroupProgressDetails

getGroupProgressDetails(
groupName: AssetGroupNames,
): { loaded: number; progress: number; total: number }
Get detailed group progress
Parameters
- groupName: AssetGroupNames
Returns { loaded: number; progress: number; total: number }
- Defined in asset-manager.ts:246

getHandle

getHandle<K extends string | number | symbol>(
key: K,
): AssetHandle<AssetTypes[K]>
Get a handle to an asset with status information
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns AssetHandle<AssetTypes[K]>
- Defined in asset-manager.ts:171

getKeys

getKeys(): (keyof AssetTypes)[]
Get all registered asset keys

Returns (keyof AssetTypes)[]
- Defined in asset-manager.ts:317

getStatus

getStatus<K extends string | number | symbol>(key: K): AssetStatus
Get the status of an asset
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns AssetStatus
- Defined in asset-manager.ts:198

isGroupLoaded

isGroupLoaded(groupName: AssetGroupNames): boolean
Check if all assets in a group are loaded
Parameters
- groupName: AssetGroupNames
Returns boolean
- Defined in asset-manager.ts:219

isLoaded

isLoaded<K extends string | number | symbol>(key: K): boolean
Check if an asset is loaded
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns boolean
- Defined in asset-manager.ts:211

loadAsset

loadAsset<K extends string | number | symbol>(key: K): Promise<AssetTypes[K]>
Load a single asset by key
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns Promise<AssetTypes[K]>
- Defined in asset-manager.ts:76

loadAssetGroup

loadAssetGroup(groupName: AssetGroupNames): Promise<void>
Load all assets in a group
Parameters
- groupName: AssetGroupNames
Returns Promise<void>
- Defined in asset-manager.ts:126

loadEagerAssets

loadEagerAssets(): Promise<void>
Load all assets marked as eager

Returns Promise<void>
- Defined in asset-manager.ts:61

register

register<K extends string, T>(key: K, definition: AssetDefinition<T>): void
Register an asset definition
Type Parameters
- K extends string
- T
Parameters
- key: K
- definition: AssetDefinition<T>
Returns void
- Defined in asset-manager.ts:42

tryGet

tryGet<K extends string | number | symbol>(key: K): AssetTypes[K] | undefined
Get a loaded asset or undefined
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns AssetTypes[K] | undefined
- Defined in asset-manager.ts:158