littlejsengine 1.18.29 → 1.20.0

package/plugins/zzfxm.js

@@ -13,7 +13,7 @@
  * @memberof ZzFXM
  * @example
  * // create some music
- * const music_example = new Music(
+ * const music_example = new ZzFXMusic(
  * [
  *     [                         // instruments
  *       [,0,400]                // simple note
@@ -34,31 +34,24 @@
  *     90            // BPM
  * ]);
  * 
- * // play the music
- * music_example.play();
+ * // play the music on a loop
+ * music_example.playMusic();
  */
 class ZzFXMusic extends Sound
 {
     /** Create a music object and cache the zzfx music samples for later use
-     *  @param {[Array, Array, Array, number]} zzfxMusic - Array of zzfx music parameters
+     *  @param {[Array, Array, Array, number?, ...any[]]} zzfxMusic - Array of zzfx music parameters: instruments, patterns, sequence, and an optional BPM; anything after it, like the tracker's metadata, is ignored
      */
     constructor(zzfxMusic)
     {
         super(undefined);
 
         if (!soundEnable || headlessMode) return;
-        this.randomness = 0;
-        this.sampleChannels = zzfxM(...zzfxMusic);
-        this.sampleRate = audioDefaultSampleRate;
+        const [instruments, patterns, sequence, BPM] = zzfxMusic;
+        super.sampleChannels = zzfxM(instruments, patterns, sequence, BPM); // the setter, without declaring a field that hides it in the typings
+        this.buildSampleBuffer(); // hand the samples to an audio buffer now, like a zzfx sound, so the arrays are released
+        this.loadedPercent = 1; // generated in place, so it is loaded like a zzfx sound
     }
-
-    /** Play the music that loops by default
-     *  @param {number}  [volume] - Volume to play the music at
-     *  @param {boolean} [loop] - Should the music loop?
-     *  @return {SoundInstance} - The sound instance
-     */
-    playMusic(volume=1, loop=true)
-    { return super.play(undefined, volume, 1, 0, loop); }
 }
 
 ///////////////////////////////////////////////////////////////////////////////