Update VinylFadeOut.gml

JujuAdams · Sep 4, 2024 · 27b032c · 27b032c
1 parent 22f2128
commit 27b032c
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/scripts/VinylFadeOut/VinylFadeOut.gml b/scripts/VinylFadeOut/VinylFadeOut.gml
@@ -1,7 +1,11 @@
 // Feather disable all
 
 /// Fades out out a voice. Once a voice is set to fade out, it cannot be stopped. The rate of
-/// change for this function is measured in "gain units per second".
+/// change for this function is measured in "gain units per second". If the optional `pause`
+/// parameter is set to `false` (the default) then the voice will stop once faded out. If the
+/// `pause` parameter is set to `true` then the voice will be paused instead and can be unpaused
+/// using the `VinylSetPause()` function. When resuming playback of the voice, it will *not* fade
+/// in.
 /// 
 /// @param voice
 /// @param [rateOfChange]