ClassCore & Lifecycle@public

FlxContext

Explicit owner of mutable engine state and replaceable services.

export declare class FlxContext

Constructors

constructor(width: number, height: number, seed?: number)

Constructs a new instance of the FlxContext class

Parameter	Type	Description
width	number	-
height	number	-
seed	number	-

Properties

Property	Modifiers	Type	Description
camera	-	FlxCamera	-
cameras	readonly	FlxCamera[]	-
elapsed	-	number	-
height	readonly	number	-
level	-	number	-
levels	readonly	unknown[]	-
paused	-	boolean	-
plugins	readonly	FlxBasic[]	-
randomSource	readonly	FlxRandom	-
renderablesDirty	-	boolean	When true, browser boot should re-run link. Cleared after a successful sync. Group membership changes set this.
score	-	number	-
scores	readonly	unknown[]	AS3-compatible cross-state values; individual games define their shape.
state	readonly	FlxState | null	-
timeScale	-	number	-
updateFramerate	-	number	Fixed update rate of the active link (updates per second). Defaults to 60 before a game attaches; link overwrites this.
visualDebug	-	boolean	-
width	readonly	number	-
worldBounds	-	FlxRect	-
worldDivisions	-	number	-

Methods

addCamera()

addCamera(camera: FlxCamera): FlxCamera

Parameters:

Parameter	Type	Description
camera	FlxCamera	-

Returns: FlxCamera

addPlugin()

addPlugin<T extends FlxBasic>(plugin: T): T

Parameters:

Parameter	Type	Description
plugin	T	-

Returns: T

attachRuntime()

attachRuntime(runtime: FlxStateRuntime): void

Parameters:

Parameter	Type	Description
runtime	FlxStateRuntime	-

Returns: void

clearRenderablesDirty()

clearRenderablesDirty(): void

Clear the renderables dirty flag after syncing.

Returns: void

clearServices()

clearServices(): void

Returns: void

destroyPlugins()

destroyPlugins(): void

Returns: void

detachRuntime()

detachRuntime(runtime: FlxStateRuntime): void

Parameters:

Parameter	Type	Description
runtime	FlxStateRuntime	-

Returns: void

drawPlugins()

drawPlugins(): void

Returns: void

getPlugin()

getPlugin<T extends FlxBasic>(pluginClass: abstract new (...args: never[]) => T): T | null

Parameters:

Parameter	Type	Description
pluginClass	abstract new (...args: never[]) => T	-

Returns: T | null

getService()

getService<T>(token: symbol): T | undefined

Parameters:

Parameter	Type	Description
token	symbol	-

Returns: T | undefined

markRenderablesDirty()

markRenderablesDirty(): void

Mark the active world's renderable membership as needing a renderer sync.

Returns: void

removeCamera()

removeCamera(camera: FlxCamera, destroy?: boolean): boolean

Parameters:

Parameter	Type	Description
camera	FlxCamera	-
destroy	boolean	-

Returns: boolean

removePlugin()

removePlugin<T extends FlxBasic>(plugin: T): T

Parameters:

Parameter	Type	Description
plugin	T	-

Returns: T

removePluginType()

removePluginType<T extends FlxBasic>(pluginClass: abstract new (...args: never[]) => T): boolean

Parameters:

Parameter	Type	Description
pluginClass	abstract new (...args: never[]) => T	-

Returns: boolean

removeService()

removeService(token: symbol): boolean

Parameters:

Parameter	Type	Description
token	symbol	-

Returns: boolean

requestState()

requestState(state: FlxState): void

Parameters:

Parameter	Type	Description
state	FlxState	-

Returns: void

resetCameras()

resetCameras(camera?: FlxCamera): FlxCamera

Parameters:

Parameter	Type	Description
camera	FlxCamera	-

Returns: FlxCamera

resetState()

resetState(): void

Returns: void

setPrimaryCamera()

setPrimaryCamera(camera: FlxCamera): void

Parameters:

Parameter	Type	Description
camera	FlxCamera	-

Returns: void

setService()

setService<T>(token: symbol, service: T): void

Parameters:

Parameter	Type	Description
token	symbol	-
service	T	-

Returns: void

updateCameras()

updateCameras(): void

Returns: void

updatePlugins()

updatePlugins(): void

Returns: void