Skip to content

Commit 3faaf28

Browse files
Fixed sounds property docs
1 parent 472da3d commit 3faaf28

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

src/sound/BaseSoundManager.js

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ var BaseSoundManager = new Class({
4848
* An array containing all added sounds.
4949
*
5050
* @name Phaser.Sound.BaseSoundManager#sounds
51-
* @type {array}
51+
* @type {Phaser.Sound.BaseSound[]}
5252
* @default []
5353
* @private
5454
* @since 3.0.0
@@ -183,10 +183,10 @@ var BaseSoundManager = new Class({
183183
* @method Phaser.Sound.BaseSoundManager#add
184184
* @override
185185
* @since 3.0.0
186-
*
186+
*
187187
* @param {string} key - Asset key for the sound.
188188
* @param {ISoundConfig} [config] - An optional config object containing default sound settings.
189-
*
189+
*
190190
* @return {ISound} The new sound instance.
191191
*/
192192
add: NOOP,
@@ -196,10 +196,10 @@ var BaseSoundManager = new Class({
196196
*
197197
* @method Phaser.Sound.BaseSoundManager#addAudioSprite
198198
* @since 3.0.0
199-
*
199+
*
200200
* @param {string} key - Asset key for the sound.
201201
* @param {ISoundConfig} [config] - An optional config object containing default sound settings.
202-
*
202+
*
203203
* @return {IAudioSpriteSound} The new audio sprite sound instance.
204204
*/
205205
addAudioSprite: function (key, config)
@@ -239,10 +239,10 @@ var BaseSoundManager = new Class({
239239
*
240240
* @method Phaser.Sound.BaseSoundManager#play
241241
* @since 3.0.0
242-
*
242+
*
243243
* @param {string} key - Asset key for the sound.
244244
* @param {ISoundConfig | ISoundMarker} [extra] - An optional additional object containing settings to be applied to the sound. It could be either config or marker object.
245-
*
245+
*
246246
* @return {boolean} Whether the sound started playing successfully.
247247
*/
248248
play: function (key, extra)
@@ -275,11 +275,11 @@ var BaseSoundManager = new Class({
275275
*
276276
* @method Phaser.Sound.BaseSoundManager#playAudioSprite
277277
* @since 3.0.0
278-
*
278+
*
279279
* @param {string} key - Asset key for the sound.
280280
* @param {string} spriteName - The name of the sound sprite to play.
281281
* @param {ISoundConfig} [config] - An optional config object containing default sound settings.
282-
*
282+
*
283283
* @return {boolean} Whether the audio sprite sound started playing successfully.
284284
*/
285285
playAudioSprite: function (key, spriteName, config)
@@ -297,9 +297,9 @@ var BaseSoundManager = new Class({
297297
*
298298
* @method Phaser.Sound.BaseSoundManager#remove
299299
* @since 3.0.0
300-
*
300+
*
301301
* @param {ISound} sound - The sound object to remove.
302-
*
302+
*
303303
* @return {boolean} True if the sound was removed successfully, otherwise false.
304304
*/
305305
remove: function (sound)
@@ -320,9 +320,9 @@ var BaseSoundManager = new Class({
320320
*
321321
* @method Phaser.Sound.BaseSoundManager#removeByKey
322322
* @since 3.0.0
323-
*
323+
*
324324
* @param {string} key - The key to match when removing sound objects.
325-
*
325+
*
326326
* @return {number} The number of matching sound objects that were removed.
327327
*/
328328
removeByKey: function (key)
@@ -443,7 +443,7 @@ var BaseSoundManager = new Class({
443443
* @method Phaser.Sound.BaseSoundManager#update
444444
* @protected
445445
* @since 3.0.0
446-
*
446+
*
447447
* @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.
448448
* @param {number} delta - The delta time elapsed since the last frame.
449449
*/
@@ -501,7 +501,7 @@ var BaseSoundManager = new Class({
501501
* @method Phaser.Sound.BaseSoundManager#forEachActiveSound
502502
* @private
503503
* @since 3.0.0
504-
*
504+
*
505505
* @param {function} callbackfn - Callback function. (sound: ISound, index: number, array: ISound[]) => void
506506
* @param [scope] - Callback context.
507507
*/

0 commit comments

Comments
 (0)