Skip to content
InterfaceBrowser DX & Viewport@public

BrowserGameApplication

Running browser game application handle returned by link.

ts
export interface BrowserGameApplication

Properties

PropertyModifiersTypeDescription
appreadonlyApplication-
assetsreadonlyFlxAssetsAsset service installed into the running game's context.
autoPausereadonlybooleanWhether focus loss pauses fixed simulation updates.
focusedreadonlybooleanWhether the document is visible and its window currently has focus.
frameCountreadonlynumberNumber of completed browser render frames.
gamereadonlyFlxGame-
loadingreadonlyFlxLoadingSessionReusable loading model for optional in-game Pixi/Flixel loading screens.
rendererreadonlyFlxCameraRenderer-
rendererBackendreadonlyBrowserGameRendererBackendConcrete Pixi renderer backend selected after any startup fallback.
rendererFallbackreadonlyBrowserGameRendererFallback | nullAutomatic renderer recovery details, or null when no fallback occurred.
renderFrameratereadonlynumber | undefinedVisual frame-rate cap, or undefined when following the display.
updateFrameratereadonlynumberFixed simulation rate in updates per second.
viewportreadonlyFlxBrowserViewportBrowser canvas sizing controller.

Methods

destroy()

ts
destroy(): void

Returns: void

onFrame()

ts
onFrame(callback: (frame: BrowserGameFrame) => void): () => void

Subscribe to completed browser render frames. Returns an unsubscribe callback.

Parameters:

ParameterTypeDescription
callback(frame: BrowserGameFrame) => void-

Returns: () => void

syncRenderer()

ts
syncRenderer(): void

Re-sync all state members into the camera renderer (call after switchState or manual mutations).

Returns: void

Released under the MIT License.