ClassDebugger & Diagnostics@public

FlxPreloader

Accessible, customizable HTML loading view. Dismissed automatically when a ready snapshot is received.

export declare class FlxPreloader implements FlxPreloaderView

Constructors

constructor(options?: FlxPreloaderOptions)

Constructs a new instance of the FlxPreloader class

Parameter	Type	Description
options	FlxPreloaderOptions	-

Properties

Property	Modifiers	Type	Description
state	readonly	PreloaderState	-

Methods

complete()

complete(): Promise<void>

Marks loading as complete and removes the preloader after its transition.

Returns: Promise<void>

destroy()

destroy(): void

Removes the preloader from the DOM and releases its handlers.

Returns: void

onRetry()

onRetry(handler: () => void): void

Legacy retry registration API.

Parameters:

Parameter	Type	Description
handler	() => void	-

Returns: void

setProgress()

setProgress(percent: number, statusText?: string): void

Legacy imperative progress API. Prefer update(snapshot) for new code.

Parameters:

Parameter	Type	Description
percent	number	-
statusText	string	-

Returns: void

showError()

showError(message: string): void

Legacy error API. Prefer an error snapshot for new code.

Parameters:

Parameter	Type	Description
message	string	-

Returns: void

update()

update(snapshot: FlxLoadingSnapshot): void

Render one snapshot from a shared loading session.

Parameters:

Parameter	Type	Description
snapshot	FlxLoadingSnapshot	-

Returns: void