Skip to content

Commit 5dbfbae

Browse files
committed
Updated jsdoc types. Fix phaserjs#4308
1 parent 0f65075 commit 5dbfbae

4 files changed

Lines changed: 4 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ In combination these updates fix issues #4732 and #4672. My thanks to @BenjaminD
9292

9393
My thanks to the following for helping with the Phaser 3 Examples, Docs and TypeScript definitions, either by reporting errors, fixing them or helping author the docs:
9494

95-
@krzysztof-grzybek @NokFrt @r-onodera
95+
@krzysztof-grzybek @NokFrt @r-onodera @colorcube
9696

9797

9898

src/sound/BaseSound.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ var BaseSound = new Class({
288288
* @method Phaser.Sound.BaseSound#play
289289
* @since 3.0.0
290290
*
291-
* @param {string} [markerName=''] - If you want to play a marker then provide the marker name here, otherwise omit it to play the full sound.
291+
* @param {(string|Phaser.Types.Sound.SoundConfig)} [markerName=''] - If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.
292292
* @param {Phaser.Types.Sound.SoundConfig} [config] - Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.
293293
*
294294
* @return {boolean} Whether the sound started playing successfully.

src/sound/html5/HTML5AudioSound.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ var HTML5AudioSound = new Class({
104104
* @fires Phaser.Sound.Events#PLAY
105105
* @since 3.0.0
106106
*
107-
* @param {string} [markerName=''] - If you want to play a marker then provide the marker name here, otherwise omit it to play the full sound.
107+
* @param {(string|Phaser.Types.Sound.SoundConfig)} [markerName=''] - If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.
108108
* @param {Phaser.Types.Sound.SoundConfig} [config] - Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.
109109
*
110110
* @return {boolean} Whether the sound started playing successfully.

src/sound/webaudio/WebAudioSound.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ var WebAudioSound = new Class({
186186
* @fires Phaser.Sound.Events#PLAY
187187
* @since 3.0.0
188188
*
189-
* @param {string} [markerName=''] - If you want to play a marker then provide the marker name here, otherwise omit it to play the full sound.
189+
* @param {(string|Phaser.Types.Sound.SoundConfig)} [markerName=''] - If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.
190190
* @param {Phaser.Types.Sound.SoundConfig} [config] - Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.
191191
*
192192
* @return {boolean} Whether the sound started playing successfully.

0 commit comments

Comments
 (0)