Class: StateManager

Phaser. StateManager

new StateManager(game [, pendingState])

The State Manager is responsible for loading, setting up and switching game states.

Parameters:
Name Type Argument Default Description
game Phaser.Game

A reference to the currently running game.

pendingState Phaser.State | Object <optional>
null

A State object to seed the manager with.

Source:
src/core/StateManager.js line 15

Members

<readonly> created : boolean

True if the current state has had its create method run (if it has one, if not this is true by default).

Type:
  • boolean
Source:
src/core/StateManager.js line 780

current : string

The current active State object.

Type:
  • string
Source:
src/core/StateManager.js line 66

game : Phaser.Game

A reference to the currently running game.

Type:
Source:
src/core/StateManager.js line 20

onCreateCallback : function

This is called when the state preload has finished and creation begins.

Type:
  • function
Source:
src/core/StateManager.js line 98

onInitCallback : function

This is called when the state is set as the active state.

Type:
  • function
Source:
src/core/StateManager.js line 86

onLoadRenderCallback : function

This is called when the State is rendered during the preload phase.

Type:
  • function
Source:
src/core/StateManager.js line 134

onLoadUpdateCallback : function

This is called when the State is updated during the preload phase.

Type:
  • function
Source:
src/core/StateManager.js line 128

onPausedCallback : function

This is called when the game is paused.

Type:
  • function
Source:
src/core/StateManager.js line 140

onPauseUpdateCallback : function

This is called every frame while the game is paused.

Type:
  • function
Source:
src/core/StateManager.js line 152

onPreloadCallback : function

This is called when the state starts to load assets.

Type:
  • function
Source:
src/core/StateManager.js line 92

onPreRenderCallback : function

This is called before the state is rendered and before the stage is cleared but after all game objects have had their final properties adjusted.

Type:
  • function
Source:
src/core/StateManager.js line 122

onRenderCallback : function

This is called post-render. It doesn't happen during preload (see onLoadRenderCallback).

Type:
  • function
Source:
src/core/StateManager.js line 110

onResizeCallback : function

This is called if ScaleManager.scalemode is RESIZE and a resize event occurs. It's passed the new width and height.

Type:
  • function
Source:
src/core/StateManager.js line 116

onResumedCallback : function

This is called when the game is resumed from a paused state.

Type:
  • function
Source:
src/core/StateManager.js line 146

onShutDownCallback : function

This is called when the state is shut down (i.e. swapped to another state).

Type:
  • function
Source:
src/core/StateManager.js line 158

onStateChange : Phaser.Signal

onStateChange is a Phaser.Signal that is dispatched whenever the game changes state.

It is dispatched only when the new state is started, which isn't usually at the same time as StateManager.start is called because state swapping is done in sync with the game loop. It is dispatched before any of the new states methods (init, preload, create, etc.) are called, and after the previous state's shutdown method has been run.

The callback you specify is sent two parameters: the string based key of the new state, and the second parameter is the string based key of the old / previous state.

Type:
Source:
src/core/StateManager.js line 80

onUpdateCallback : function

This is called when the state is updated, every game loop. It doesn't happen during preload (@see onLoadUpdateCallback).

Type:
  • function
Source:
src/core/StateManager.js line 104

states : object

The object containing Phaser.States.

Type:
  • object
Source:
src/core/StateManager.js line 25

Methods

add(key, state [, autoStart])

Adds a new State into the StateManager. You must give each State a unique key by which you'll identify it.

The State can be any of

  • a plain JavaScript object containing at least one required callback (see checkState)
  • an instance of Phaser.State
  • an instance of a class extending Phaser.State
  • a constructor function (class)

If a function is given a new state object will be created by calling it, passing the current game as the first argument.

Parameters:
Name Type Argument Default Description
key string

A unique key you use to reference this state, i.e. "MainMenu", "Level1".

state Phaser.State | object | function

The state you want to switch to.

autoStart boolean <optional>
false

If true the State will be started immediately after adding it.

Source:
src/core/StateManager.js line 179

checkState(key)

Checks if a given phaser state is valid. A State is considered valid if it has at least one of the core functions: preload, create, update or render.

Parameters:
Name Type Description
key string

The key of the state you want to check.

Source:
src/core/StateManager.js line 419
Returns:

true if the State has the required functions, otherwise false.

Type
boolean

clearCurrentState()

This method clears the current State, calling its shutdown callback. The process also removes any active tweens, resets the camera, resets input, clears physics, removes timers and if set clears the world and cache too.

Source:
src/core/StateManager.js line 375

destroy()

Removes all StateManager callback references to the State object, nulls the game reference and clears the States object. You don't recover from this without rebuilding the Phaser instance again.

Source:
src/core/StateManager.js line 742

getCurrentState()

Gets the current State.

Source:
src/core/StateManager.js line 573
Returns:
Type
Phaser.State

Links game properties to the State given by the key.

Parameters:
Name Type Description
key string

State key.

Source:
src/core/StateManager.js line 449

<protected> loadComplete()

Source:
src/core/StateManager.js line 585
See:

<protected> loadUpdate()

Source:
src/core/StateManager.js line 603
See:
  • Phaser.Loader#finishedLoading

<protected> pause()

Source:
src/core/StateManager.js line 616

<protected> pauseUpdate()

Source:
src/core/StateManager.js line 668

<protected> preRender()

Source:
src/core/StateManager.js line 688

preUpdate()

preUpdate is called right at the start of the game loop. It is responsible for changing to a new state that was requested previously.

Source:
src/core/StateManager.js line 324

remove(key)

Delete the given state.

Parameters:
Name Type Description
key string

A unique key you use to reference this state, i.e. "MainMenu", "Level1".

Source:
src/core/StateManager.js line 233

<protected> render()

Source:
src/core/StateManager.js line 712

<protected> resize()

Source:
src/core/StateManager.js line 700

restart( [clearWorld] [, clearCache], parameter)

Restarts the current State. State.shutDown will be called (if it exists) before the State is restarted.

Parameters:
Name Type Argument Default Description
clearWorld boolean <optional>
true

Clear everything in the world? This clears the World display list fully (but not the Stage, so if you've added your own objects to the Stage they will need managing directly)

clearCache boolean <optional>
false

Clear the Game.Cache? This purges out all loaded assets. The default is false and you must have clearWorld=true if you want to clearCache as well.

parameter * <repeatable>

Additional parameters that will be passed to the State.init function if it has one.

Source:
src/core/StateManager.js line 291

<protected> resume()

Source:
src/core/StateManager.js line 628

start(key [, clearWorld] [, clearCache], parameter)

Start the given State. If a State is already running then State.shutDown will be called (if it exists) before switching to the new State.

Parameters:
Name Type Argument Default Description
key string

The key of the state you want to start.

clearWorld boolean <optional>
true

Clear everything in the world? This clears the World display list fully (but not the Stage, so if you've added your own objects to the Stage they will need managing directly)

clearCache boolean <optional>
false

Clear the Game.Cache? This purges out all loaded assets. The default is false and you must have clearWorld=true if you want to clearCache as well.

parameter * <repeatable>

Additional parameters that will be passed to the State.init function (if it has one).

Source:
src/core/StateManager.js line 263

Nulls all State level Phaser properties, including a reference to Game.

Parameters:
Name Type Description
key string

State key.

Source:
src/core/StateManager.js line 481

<protected> update()

Source:
src/core/StateManager.js line 640

phaser-ce@2.18.0 is on GitHub and NPM

Documentation generated by JSDoc 3.6.3 on 2021-05-06 using Tomorrow.