ClassCore & Lifecycle@public

FlxState

Base game state; initialize state-owned objects in create.

export declare class FlxState extends FlxGroup

Properties

Property	Modifiers	Type	Description
destroySubStates	-	boolean	-
persistentDraw	-	boolean	-
persistentUpdate	-	boolean	-
physicsWorld	readonly	FlxPhysicsWorld | null	Optional state-owned physics world, advanced after ordinary members.
subState	-	FlxSubState | null	-
subStateClosed	readonly	FlxSignal<FlxSubState>	Dispatched after the current substate has closed.
subStateOpened	readonly	FlxSignal<FlxSubState>	Dispatched after a requested substate has opened.

Methods

closeSubState()

closeSubState(): void

Returns: void

create()

create(): void

Returns: void

destroy()

destroy(): void

Returns: void

draw()

draw(): void

Returns: void

openSubState()

openSubState(subState: FlxSubState): void

Parameters:

Parameter	Type	Description
subState	FlxSubState	-

Returns: void

removePhysicsWorld()

removePhysicsWorld(destroy?: boolean): FlxPhysicsWorld | null

Remove the current physics world and optionally release it.

Parameters:

Parameter	Type	Description
destroy	boolean	-

Returns: FlxPhysicsWorld | null

resetSubState()

resetSubState(): void

Applies a deferred substate request. Normally called by the game loop.

Returns: void

setPhysicsWorld()

setPhysicsWorld(world: FlxPhysicsWorld | null, destroyPrevious?: boolean): FlxPhysicsWorld | null

Install a physics world and optionally destroy the previous one. The same world may be installed repeatedly without resetting it.

Parameters:

Parameter	Type	Description
world	FlxPhysicsWorld | null	-
destroyPrevious	boolean	-

Returns: FlxPhysicsWorld | null