Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2025-02-17 06:28:30 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fixed sounds property docs

Browse source
This commit is contained in:
Pavle Goloskokovic 2018-02-18 17:16:19 +01:00
parent 472da3dc22
commit 3faaf28596
1 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
src/sound/BaseSoundManager.js
View file

@ -48,7 +48,7 @@ var BaseSoundManager = new Class({
* An array containing all added sounds.
*
* @name Phaser.Sound.BaseSoundManager#sounds
* @type {array}
* @type {Phaser.Sound.BaseSound[]}
* @default []
* @private
* @since 3.0.0
@ -183,10 +183,10 @@ var BaseSoundManager = new Class({
* @method Phaser.Sound.BaseSoundManager#add
* @override
* @since 3.0.0
*
*
* @param {string} key - Asset key for the sound.
* @param {ISoundConfig} [config] - An optional config object containing default sound settings.
*
*
* @return {ISound} The new sound instance.
*/
add: NOOP,
@ -196,10 +196,10 @@ var BaseSoundManager = new Class({
*
* @method Phaser.Sound.BaseSoundManager#addAudioSprite
* @since 3.0.0
*
*
* @param {string} key - Asset key for the sound.
* @param {ISoundConfig} [config] - An optional config object containing default sound settings.
*
*
* @return {IAudioSpriteSound} The new audio sprite sound instance.
*/
addAudioSprite: function (key, config)
@ -239,10 +239,10 @@ var BaseSoundManager = new Class({
*
* @method Phaser.Sound.BaseSoundManager#play
* @since 3.0.0
*
*
* @param {string} key - Asset key for the sound.
* @param {ISoundConfig | ISoundMarker} [extra] - An optional additional object containing settings to be applied to the sound. It could be either config or marker object.
*
*
* @return {boolean} Whether the sound started playing successfully.
*/
play: function (key, extra)
@ -275,11 +275,11 @@ var BaseSoundManager = new Class({
*
* @method Phaser.Sound.BaseSoundManager#playAudioSprite
* @since 3.0.0
*
*
* @param {string} key - Asset key for the sound.
* @param {string} spriteName - The name of the sound sprite to play.
* @param {ISoundConfig} [config] - An optional config object containing default sound settings.
*
*
* @return {boolean} Whether the audio sprite sound started playing successfully.
*/
playAudioSprite: function (key, spriteName, config)
@ -297,9 +297,9 @@ var BaseSoundManager = new Class({
*
* @method Phaser.Sound.BaseSoundManager#remove
* @since 3.0.0
*
*
* @param {ISound} sound - The sound object to remove.
*
*
* @return {boolean} True if the sound was removed successfully, otherwise false.
*/
remove: function (sound)
@ -320,9 +320,9 @@ var BaseSoundManager = new Class({
*
* @method Phaser.Sound.BaseSoundManager#removeByKey
* @since 3.0.0
*
*
* @param {string} key - The key to match when removing sound objects.
*
*
* @return {number} The number of matching sound objects that were removed.
*/
removeByKey: function (key)
@ -443,7 +443,7 @@ var BaseSoundManager = new Class({
* @method Phaser.Sound.BaseSoundManager#update
* @protected
* @since 3.0.0
*
*
* @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.
* @param {number} delta - The delta time elapsed since the last frame.
*/
@ -501,7 +501,7 @@ var BaseSoundManager = new Class({
* @method Phaser.Sound.BaseSoundManager#forEachActiveSound
* @private
* @since 3.0.0
*
*
* @param {function} callbackfn - Callback function. (sound: ISound, index: number, array: ISound[]) => void
* @param [scope] - Callback context.
*/