phaser
Version:
A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers.
28 lines (26 loc) • 875 B
JavaScript
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2020 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* The Sound Mute Event.
*
* This event is dispatched by both Web Audio and HTML5 Audio Sound objects when their mute state changes.
*
* Listen to it from a Sound instance using `Sound.on('mute', listener)`, i.e.:
*
* ```javascript
* var music = this.sound.add('key');
* music.on('mute', listener);
* music.play();
* music.setMute(true);
* ```
*
* @event Phaser.Sound.Events#MUTE
* @since 3.0.0
*
* @param {(Phaser.Sound.WebAudioSound|Phaser.Sound.HTML5AudioSound)} sound - A reference to the Sound that emitted the event.
* @param {boolean} mute - The mute value. `true` if the Sound is now muted, otherwise `false`.
*/
module.exports = 'mute';