Release 2.4.6

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.4.6] - 2023-10-16
+
+### Fixed
+
+- added check to prevent sub sound channel volumes being set to 0 causing soundVolume to be set to 1 in the game
+- Added/fixed logic in `SoundPlugin` volume and toggle handlers to make sure everything stays in sync and respects user preferences better
+
 ## [2.4.5] 2023-09-08
 
 ### Fixed

package.json

@@ -1,6 +1,6 @@
 {
   "name": "springroll-container",
-  "version": "2.4.5",
+  "version": "2.4.6",
   "description": "The iframe controller for interacting with SpringRoll applications",
   "main": "./dist/index.js",
   "license": "MIT",

src/base-plugins/BasePlugin.js

@@ -52,10 +52,12 @@ export class BasePlugin {
    *
    * @param {string} prop
    * @param {any} value
+   * @param {Boolean} disableSend
    * @memberof BasePlugin
    */
-  sendProperty(prop, value) {
+  sendProperty(prop, value, disableSend = false) {
     SavedData.write(prop, value);
+    if (disableSend) { return; }
     this.client.send(prop, value);
   }
 

src/base-plugins/ButtonPlugin.js

@@ -58,16 +58,17 @@ export class ButtonPlugin extends BasePlugin {
    * @param {string} prop
    * @param {Element} button
    * @param {Boolean} muted
+   * @param {Boolean} disableSend
    * @memberof ButtonPlugin
    */
-  _setMuteProp(prop, button, muted) {
+  _setMuteProp(prop, button, muted, disableSend = false) {
     if (Array.isArray(button)) {
       button.forEach(b => this.changeMutedState(b, muted));
     } else {
       this.changeMutedState(button, muted);
     }
 
-    this.sendProperty(prop, muted);
+    this.sendProperty(prop, muted, disableSend);
   }
 
   /**

src/plugins/SoundPlugin.js

@@ -39,6 +39,11 @@ export class SoundPlugin extends ButtonPlugin {
     this._voMuted = false;
     this._sfxMuted = false;
 
+    this._musicMutedByUser = false;
+    this._soundMutedByUser = false;
+    this._sfxMutedByUser = false;
+    this._voMutedByUser = false;
+
     this.soundMuteEnabled = false;
     this.musicMuteEnabled = false;
     this.sfxMuteEnabled = false;
@@ -246,10 +251,16 @@ export class SoundPlugin extends ButtonPlugin {
     this.soundVolume = this.soundSliders[0].sliderRange(
       Number(e.target.value)
     );
+    this.soundMuted = !this.soundVolume;
 
-    if (!this.soundVolume !== this.soundMuted) {
-      this.soundMuted = !this.soundVolume;
-      this._checkSoundMute();
+    if (!this._musicMutedByUser) {
+      this.musicMuted = this.soundMuted;
+    }
+    if (!this._sfxMutedByUser) {
+      this.sfxMuted = this.soundMuted;
+    }
+    if (!this._voMutedByUser) {
+      this.voMuted = this.soundMuted;
     }
 
     this.sendProperty(SoundPlugin.soundVolumeKey, this.soundVolume);
@@ -268,14 +279,14 @@ export class SoundPlugin extends ButtonPlugin {
       this.musicVolume = e.target.value;
       return;
     }
+
     this.musicVolume = this.musicSliders[0].sliderRange(
       Number(e.target.value)
     );
 
-    if (!this.musicVolume !== this.musicMuted) {
-      this.musicMuted = !this.musicVolume;
-      this._checkSoundMute();
-    }
+    this.musicMuted = !this.musicVolume;
+    if (!this.musicMuted) { this._musicMutedByUser = false; }
+    this._checkSoundMute();
     this.sendProperty(SoundPlugin.musicVolumeKey, this.musicVolume);
 
     for (let i = 0; i < this.musicSlidersLength; i++) {
@@ -293,11 +304,10 @@ export class SoundPlugin extends ButtonPlugin {
       return;
     }
     this.voVolume = this.voSliders[0].sliderRange(Number(e.target.value));
+    if (!this.voMuted) { this._voMutedByUser = false; }
+    this.voMuted = !this.voVolume;
+    this._checkSoundMute();
 
-    if (!this.voVolume !== this.voMuted) {      
-      this.voMuted = !this.voVolume;
-      this._checkSoundMute();
-    }
     this.sendProperty(SoundPlugin.voVolumeKey, this.voVolume);
     for (let i = 0; i < this.voSlidersLength; i++) {
       this.voSliders[i].value = this.voVolume;
@@ -314,11 +324,10 @@ export class SoundPlugin extends ButtonPlugin {
       return;
     }
     this.sfxVolume = this.sfxSliders[0].sliderRange(Number(e.target.value));
+    if (!this.sfxMuted) { this._sfxMutedByUser = false; }
+    this.sfxMuted = !this.sfxVolume;
+    this._checkSoundMute();
 
-    if (!this.sfxVolume !== this.sfxMuted) {
-      this.sfxMuted = !this.sfxVolume;
-      this._checkSoundMute();
-    }
     this.sendProperty(SoundPlugin.sfxVolumeKey, this.sfxVolume);
 
     for (let i = 0; i < this.sfxSlidersLength; i++) {
@@ -332,16 +341,24 @@ export class SoundPlugin extends ButtonPlugin {
   onSoundToggle() {
     const muted = !this.soundMuted;
     this.soundMuted = muted;
-    this.musicMuted = muted;
-    this.voMuted = muted;
-    this.sfxMuted = muted;
+
+    if (!this._musicMutedByUser || muted) {
+      this.musicMuted = muted;
+    }
+    if (!this._sfxMutedByUser || muted) {
+      this.sfxMuted = muted;
+    }
+    if (!this._voMutedByUser || muted) {
+      this.voMuted = muted;
+    }
   }
 
   /**
    * @memberof SoundPlugin
    */
   onMusicToggle() {
     this.musicMuted = !this.musicMuted;
+    this._musicMutedByUser = this.musicMuted;
     this._checkSoundMute();
   }
 
@@ -350,6 +367,7 @@ export class SoundPlugin extends ButtonPlugin {
    */
   onVOToggle() {
     this.voMuted = !this.voMuted;
+    this._voMutedByUser = this.voMuted;
     this._checkSoundMute();
   }
 
@@ -358,6 +376,7 @@ export class SoundPlugin extends ButtonPlugin {
    */
   onSFXToggle() {
     this.sfxMuted = !this.sfxMuted;
+    this._sfxMutedByUser = this.sfxMuted;
     this._checkSoundMute();
   }
 
@@ -374,9 +393,9 @@ export class SoundPlugin extends ButtonPlugin {
    * @param {Element} element
    * @memberof SoundPlugin
    */
-  setMuteProp(key, value, element) {
+  setMuteProp(key, value, element, disableSend = false) {
     this['_' + key] = value;
-    this._setMuteProp(key, element, value);
+    this._setMuteProp(key, element, value, disableSend);
   }
 
   /**
@@ -467,7 +486,7 @@ export class SoundPlugin extends ButtonPlugin {
     this.sendProperty(SoundPlugin.voVolumeKey, this.voVolume);
     this.sendProperty(SoundPlugin.sfxVolumeKey, this.sfxVolume);
 
-    // to avoid the mute property overwriting the volume, mutes should only send if they're true
+    // to avoid the mute property overwriting the volume on startup, mutes should only send if they're true
     // or the volume channel isn't enabled
     if ( this.soundMuteEnabled && (this.soundMuted || !this.soundVolumeEnabled )) {
       this.sendProperty(SoundPlugin.soundMutedKey, this.soundMuted);
@@ -488,7 +507,19 @@ export class SoundPlugin extends ButtonPlugin {
    * @param {boolean} muted
    */
   set soundMuted(muted) {
-    this.setMuteProp('soundMuted', muted, this.soundButtons);
+    if (muted === this.soundMuted) {
+      // have to do this to make sure it gets set up properly on start up
+      this.setMuteProp('soundMuted', muted, this.soundButtons, true);
+      return;
+    }
+
+    let disableSend = false;
+    // if volume is enabled and the channel is becoming unmuted we update everything but only send the volume
+    if (this.soundVolumeEnabled && !muted) {
+      this.sendProperty(SoundPlugin.soundVolumeKey, this.soundVolume);
+      disableSend = true;
+    }
+    this.setMuteProp('soundMuted', muted, this.soundButtons, disableSend);
   }
 
   /**
@@ -503,7 +534,17 @@ export class SoundPlugin extends ButtonPlugin {
    * @param {boolean} muted
    */
   set voMuted(muted) {
-    this.setMuteProp('voMuted', muted, this.voButtons);
+    let disableSend = false;
+    if (this.voMuted === muted) {
+      // have to do this to make sure it gets set up properly on start up
+      this.setMuteProp('voMuted', muted, this.voButtons, true);
+      return;
+    }
+    if ((this.voVolumeEnabled && !muted)) {
+      this.sendProperty(SoundPlugin.voVolumeKey, this.voVolume);
+      disableSend = true;
+    }
+    this.setMuteProp('voMuted', muted, this.voButtons, disableSend);
   }
 
   /**
@@ -518,7 +559,18 @@ export class SoundPlugin extends ButtonPlugin {
    * @param {boolean} muted
    */
   set musicMuted(muted) {
-    this.setMuteProp('musicMuted', muted, this.musicButtons);
+    if (this.musicMuted === muted) {
+      // have to do this to make sure it gets set up properly on start up
+      this.setMuteProp('musicMuted', muted, this.musicButtons, true);
+      return;  
+    }
+    let disableSend = false;
+    if (this.musicVolumeEnabled && !muted) {
+      this.sendProperty(SoundPlugin.musicVolumeKey, this.musicVolume);
+      disableSend = true;
+    }
+
+    this.setMuteProp('musicMuted', muted, this.musicButtons, disableSend);
   }
 
   /**
@@ -533,7 +585,17 @@ export class SoundPlugin extends ButtonPlugin {
    * @param {boolean} muted
    */
   set sfxMuted(muted) {
-    this.setMuteProp('sfxMuted', muted, this.sfxButtons);
+    if (this.sfxMuted === muted) {
+      // have to do this to make sure it gets set up properly on start up
+      this.setMuteProp('sfxMuted', muted, this.sfxButtons, true);
+      return;
+    }
+    let disableSend = false;
+    if (this.sfxVolumeEnabled && !muted) {
+      this.sendProperty(SoundPlugin.sfxVolumeKey, this.sfxVolume);
+      disableSend = true;
+    }
+    this.setMuteProp('sfxMuted', muted, this.sfxButtons, disableSend);
   }
 
   /**