InterfaceAssets & Loading@public

FlxAssetBackend

Injectable subset of Pixi Assets used by the engine service.

export interface FlxAssetBackend

Methods

add()

add(asset: FlxAssetDescriptor | FlxAssetDescriptor[]): void

Parameters:

Parameter	Type	Description
asset	FlxAssetDescriptor | FlxAssetDescriptor[]	-

Returns: void

addBundle()

addBundle(name: string, assets: FlxAssetDescriptor[]): void

Parameters:

Parameter	Type	Description
name	string	-
assets	FlxAssetDescriptor[]	-

Returns: void

backgroundLoad()

backgroundLoad(ids: string | string[]): Promise<void>

Parameters:

Parameter	Type	Description
ids	string | string[]	-

Returns: Promise<void>

backgroundLoadBundle()

backgroundLoadBundle(names: string | string[]): Promise<void>

Parameters:

Parameter	Type	Description
names	string | string[]	-

Returns: Promise<void>

get()

get<T>(id: string): T | undefined

Parameters:

Parameter	Type	Description
id	string	-

Returns: T | undefined

init()

init(options?: FlxAssetInitOptions): Promise<void>

Parameters:

Parameter	Type	Description
options	FlxAssetInitOptions	-

Returns: Promise<void>

load()

load<T>(id: string | FlxAssetDescriptor, options?: FlxAssetLoadOptions): Promise<T>

Parameters:

Parameter	Type	Description
id	string | FlxAssetDescriptor	-
options	FlxAssetLoadOptions	-

Returns: Promise<T>

loadBundle()

loadBundle<T>(name: string | string[], onProgress?: (progress: number) => void): Promise<T>

Parameters:

Parameter	Type	Description
name	string | string[]	-
onProgress	(progress: number) => void	-

Returns: Promise<T>

unload()

unload(id: string | string[]): Promise<void>

Parameters:

Parameter	Type	Description
id	string | string[]	-

Returns: Promise<void>

unloadBundle()

unloadBundle(name: string | string[]): Promise<void>

Parameters:

Parameter	Type	Description
name	string | string[]	-

Returns: Promise<void>