phaser
Version:
A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers from the team at Phaser Studio Inc.
28 lines (26 loc) • 756 B
JavaScript
/**
* @author Richard Davey <rich@phaser.io>
* @copyright 2013-2025 Phaser Studio Inc.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* The Sound Pause Event.
*
* This event is dispatched by both Web Audio and HTML5 Audio Sound objects when they are paused.
*
* Listen to it from a Sound instance using `Sound.on('pause', listener)`, i.e.:
*
* ```javascript
* var music = this.sound.add('key');
* music.on('pause', listener);
* music.play();
* music.pause();
* ```
*
* @event Phaser.Sound.Events#PAUSE
* @type {string}
* @since 3.0.0
*
* @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.
*/
module.exports = 'pause';