Scope: static
Source: src/core/events/index.js#L7
Static functions
BLUR
BLUR
Description:
The Game Blur Event.
This event is dispatched by the Game Visibility Handler when the window in which the Game instance is embedded enters a blurred state. The blur event is raised when the window loses focus. This can happen if a user swaps tab, or if they simply remove focus from the browser to another app.
Source: src/core/events/BLUR_EVENT.js#L7
Since: 3.0.0
BOOT
BOOT
Description:
The Game Boot Event.
This event is dispatched when the Phaser Game instance has finished booting, but before it is ready to start running.
The global systems use this event to know when to set themselves up, dispatching their own ready events as required.
Source: src/core/events/BOOT_EVENT.js#L7
Since: 3.0.0
CONTEXT_LOST
CONTEXT_LOST
Description:
The Game Context Lost Event.
This event is dispatched by the Game if the WebGL Renderer it is using encounters a WebGL Context Lost event from the browser.
The renderer halts all rendering and cannot resume after this happens.
Source: src/core/events/CONTEXT_LOST_EVENT.js#L7
Since: 3.19.0
DESTROY
DESTROY
Description:
The Game Destroy Event.
This event is dispatched when the game instance has been told to destroy itself. Lots of internal systems listen to this event in order to clear themselves out. Custom plugins and game code should also do the same.
Source: src/core/events/DESTROY_EVENT.js#L7
Since: 3.0.0
FOCUS
FOCUS
Description:
The Game Focus Event.
This event is dispatched by the Game Visibility Handler when the window in which the Game instance is embedded enters a focused state. The focus event is raised when the window re-gains focus, having previously lost it.
Source: src/core/events/FOCUS_EVENT.js#L7
Since: 3.0.0
HIDDEN
HIDDEN
Description:
The Game Hidden Event.
This event is dispatched by the Game Visibility Handler when the document in which the Game instance is embedded enters a hidden state. Only browsers that support the Visibility API will cause this event to be emitted.
In most modern browsers, when the document enters a hidden state, the Request Animation Frame and setTimeout, which control the main game loop, will automatically pause. There is no way to stop this from happening. It is something your game should account for in its own code, should the pause be an issue (i.e. for multiplayer games)
Source: src/core/events/HIDDEN_EVENT.js#L7
Since: 3.0.0
PAUSE
PAUSE
Description:
The Game Pause Event.
This event is dispatched when the Game loop enters a paused state, usually as a result of the Visibility Handler.
Source: src/core/events/PAUSE_EVENT.js#L7
Since: 3.0.0
POST_RENDER
POST_RENDER
Description:
The Game Post-Render Event.
This event is dispatched right at the end of the render process.
Every Scene will have rendered and been drawn to the canvas by the time this event is fired. Use it for any last minute post-processing before the next game step begins.
Parameters:
name | type | optional | description |
|---|---|---|---|
renderer | Phaser.Renderer.Canvas.CanvasRenderer | Phaser.Renderer.WebGL.WebGLRenderer | No | A reference to the current renderer being used by the Game instance. |
Source: src/core/events/POST_RENDER_EVENT.js#L7
Since: 3.0.0
POST_STEP
POST_STEP
Description:
The Game Post-Step Event.
This event is dispatched after the Scene Manager has updated. Hook into it from plugins or systems that need to do things before the render starts.
Parameters:
name | type | optional | description |
|---|---|---|---|
time | number | No | The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout. |
delta | number | No | The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate. |
Source: src/core/events/POST_STEP_EVENT.js#L7
Since: 3.0.0
PRE_RENDER
PRE_RENDER
Description:
The Game Pre-Render Event.
This event is dispatched immediately before any of the Scenes have started to render.
The renderer will already have been initialized this frame, clearing itself and preparing to receive the Scenes for rendering, but it won't have actually drawn anything yet.
Parameters:
name | type | optional | description |
|---|---|---|---|
renderer | Phaser.Renderer.Canvas.CanvasRenderer | Phaser.Renderer.WebGL.WebGLRenderer | No | A reference to the current renderer being used by the Game instance. |
Source: src/core/events/PRE_RENDER_EVENT.js#L7
Since: 3.0.0
PRE_STEP
PRE_STEP
Description:
The Game Pre-Step Event.
This event is dispatched before the main Game Step starts. By this point in the game cycle none of the Scene updates have yet happened. Hook into it from plugins or systems that need to update before the Scene Manager does.
Parameters:
name | type | optional | description |
|---|---|---|---|
time | number | No | The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout. |
delta | number | No | The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate. |
Source: src/core/events/PRE_STEP_EVENT.js#L7
Since: 3.0.0
READY
READY
Description:
The Game Ready Event.
This event is dispatched when the Phaser Game instance has finished booting, the Texture Manager is fully ready, and all local systems are now able to start.
Source: src/core/events/READY_EVENT.js#L7
Since: 3.0.0
RESUME
RESUME
Description:
The Game Resume Event.
This event is dispatched when the game loop leaves a paused state and resumes running.
Parameters:
name | type | optional | description |
|---|---|---|---|
pauseDuration | number | No | The duration, in ms, that the game was paused for, or 0 if {@link Phaser.Game#resume} was called. |
Source: src/core/events/RESUME_EVENT.js#L7
Since: 3.0.0
STEP
STEP
Description:
The Game Step Event.
This event is dispatched after the Game Pre-Step and before the Scene Manager steps. Hook into it from plugins or systems that need to update before the Scene Manager does, but after the core Systems have.
Parameters:
name | type | optional | description |
|---|---|---|---|
time | number | No | The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout. |
delta | number | No | The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate. |
Source: src/core/events/STEP_EVENT.js#L7
Since: 3.0.0
SYSTEM_READY
SYSTEM_READY
Description:
This event is dispatched when the Scene Manager has created the System Scene, which other plugins and systems may use to initialize themselves.
This event is dispatched just once by the Game instance.
Parameters:
name | type | optional | description |
|---|---|---|---|
sys | No | A reference to the Scene Systems class of the Scene that emitted this event. |
Source: src/core/events/SYSTEM_READY_EVENT.js#L7
Since: 3.70.0
VISIBLE
VISIBLE
Description:
The Game Visible Event.
This event is dispatched by the Game Visibility Handler when the document in which the Game instance is embedded enters a visible state, previously having been hidden.
Only browsers that support the Visibility API will cause this event to be emitted.
Source: src/core/events/VISIBLE_EVENT.js#L7
Since: 3.0.0