phaser
Version:
A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers from the team at Phaser Studio Inc.
23 lines (21 loc) • 818 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 Manager Unlocked Event.
*
* This event is dispatched by the Base Sound Manager, or more typically, an instance of the Web Audio Sound Manager,
* or the HTML5 Audio Manager. It is dispatched during the update loop when the Sound Manager becomes unlocked. For
* Web Audio this is on the first user gesture on the page.
*
* Listen to it from a Scene using: `this.sound.on('unlocked', listener)`.
*
* @event Phaser.Sound.Events#UNLOCKED
* @type {string}
* @since 3.0.0
*
* @param {Phaser.Sound.BaseSoundManager} soundManager - A reference to the sound manager that emitted the event.
*/
module.exports = 'unlocked';