phaser
Version:
A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers.
22 lines (20 loc) • 779 B
JavaScript
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2020 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* The Scene Systems Sleep Event.
*
* This event is dispatched by a Scene when it is sent to sleep, either directly via the `sleep` method,
* or as an action from another Scene.
*
* Listen to it from a Scene using `this.scene.events.on('sleep', listener)`.
*
* @event Phaser.Scenes.Events#SLEEP
* @since 3.0.0
*
* @param {Phaser.Scenes.Systems} sys - A reference to the Scene Systems class of the Scene that emitted this event.
* @param {any} [data] - An optional data object that was passed to this Scene when it was sent to sleep.
*/
module.exports = 'sleep';