Clarify jsdocs. Fix #6043

phaserjs · Nov 22, 2022 · ee2b5f5 · ee2b5f5
1 parent 5d2a829
commit ee2b5f5
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/src/sound/BaseSound.js b/src/sound/BaseSound.js
@@ -341,7 +341,9 @@ var BaseSound = new Class({
     },
 
     /**
-     * Pauses the sound.
+     * Pauses the sound. This only works if the sound is currently playing.
+     *
+     * You can inspect the `isPlaying` and `isPaused` properties to check the state.
      *
      * @method Phaser.Sound.BaseSound#pause
      * @since 3.0.0
@@ -362,7 +364,9 @@ var BaseSound = new Class({
     },
 
     /**
-     * Resumes the sound.
+     * Resumes the sound. This only works if the sound is paused and not already playing.
+     *
+     * You can inspect the `isPlaying` and `isPaused` properties to check the state.
      *
      * @method Phaser.Sound.BaseSound#resume
      * @since 3.0.0