Phaser API Documentation

  Version: 
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Event: PAUSE
Phaser.Scenes.Events.PAUSE
PAUSE

Description:

The Scene Systems Pause Event.

This event is dispatched by a Scene when it is paused, either directly via the pause method, or as an action from another Scene.

Listen to it from a Scene using this.events.on('pause', listener).

Parameters:

name type arguments description
sys Phaser.Scenes.Systems

A reference to the Scene Systems class of the Scene that emitted this event.

data any <optional>

An optional data object that was passed to this Scene when it was paused.

Since: 3.0.0