ClassCore & Lifecycle@public

FlxGame

Headless game controller and atomic state boundary.

export declare class FlxGame implements FlxStateRuntime

Constructors

constructor(gameSizeX: number, gameSizeY: number, initialState: FlxStateConstructor, zoom?: number, gameFramerate?: number, flashFramerate?: number, useSystemCursor?: boolean, inputOptions?: FlxInputManagerOptions, audioBackend?: FlxAudioBackend)

Constructs a new instance of the FlxGame class

Parameter	Type	Description
gameSizeX	number	-
gameSizeY	number	-
initialState	FlxStateConstructor	-
zoom	number	-
gameFramerate	number	-
flashFramerate	number	-
useSystemCursor	boolean	-
inputOptions	FlxInputManagerOptions	-
audioBackend	FlxAudioBackend	-

Properties

Property	Modifiers	Type	Description
audio	readonly	FlxAudioManager	-
context	readonly	FlxContext	-
debugChannel	readonly	DebugChannel	Typed event bus for debug consumers. Zero cost when no listeners.
flashFramerate	readonly	number	-
forceDebugger	-	boolean	-
input	readonly	FlxInputManager	-
interpolationAlpha	readonly	number	-
log	readonly	FlxLog	Shared log service. Access via FlxG.log.
state	readonly	FlxState | null	-
updateFramerate	readonly	number	-
useSoundHotKeys	-	boolean	-
useSystemCursor	readonly	boolean	-
watch	readonly	FlxWatch	Shared watch service. Access via FlxG.watch.
zoom	readonly	number	-

Methods

advance()

advance(elapsedSeconds: number): FixedStepAdvanceResult

Feeds browser-clock time through the deterministic fixed-step loop.

Parameters:

Parameter	Type	Description
elapsedSeconds	number	-

Returns: FixedStepAdvanceResult

destroy()

destroy(): void

Returns: void

requestState()

requestState(state: FlxState): void

Parameters:

Parameter	Type	Description
state	FlxState	-

Returns: void

resetState()

resetState(): void

Returns: void

step()

step(stepSeconds?: number): void

Executes one authoritative simulation step.

Parameters:

Parameter	Type	Description
stepSeconds	number	-

Returns: void