Skip to content
InterfaceBrowser DX & Viewport@public

BrowserGamePreloadContext

Loading helpers supplied to a game's custom startup preparation.

ts
export interface BrowserGamePreloadContext

Properties

PropertyModifiersTypeDescription
assetsreadonlyFlxAssets-
signalreadonlyAbortSignal-

Methods

loadBundle()

ts
loadBundle<T = Record<string, unknown>>(name: string | string[], message?: string): Promise<T>

Load an additional bundle and map its progress into the boot asset stage.

Parameters:

ParameterTypeDescription
namestring | string[]-
messagestring-

Returns: Promise<T>

report()

ts
report(progress: number | null, message?: string): void

Report preparation-local progress, or null for an indeterminate operation.

Parameters:

ParameterTypeDescription
progressnumber | null-
messagestring-

Returns: void

Released under the MIT License.