refactor music and sfx volume variable names

Author: Avalancs

main/src/org/destinationsol/GameOptions.java

@@ -69,8 +69,8 @@ public class GameOptions {
   public int y;
   public boolean fullscreen;
   public int controlType;
-  public float volMul;
-  public float musicMul;
+  public float sfxVolumeMultiplier;
+  public float musicVolumeMultiplier;
   public boolean canSellEquippedItems;
   private String keyUpMouseName;
   private String keyDownMouseName;
@@ -115,8 +115,8 @@ public GameOptions(boolean mobile, SolFileReader reader) {
     y = r.getInt("y", 600);
     fullscreen = r.getBoolean("fullscreen", false);
     controlType = mobile ? CONTROL_KB : r.getInt("controlType", CONTROL_MIXED);
-    volMul = r.getFloat("vol", 1);
-    musicMul = r.getFloat("musicVol", 1);
+    sfxVolumeMultiplier = r.getFloat("sfxVol", 1);
+    musicVolumeMultiplier = r.getFloat("musicVol", 1);
     keyUpMouseName = r.getString("keyUpMouse", DEFAULT_MOUSE_UP);
     keyDownMouseName = r.getString("keyDownMouse", DEFAULT_MOUSE_DOWN);
     keyUpName = r.getString("keyUp", DEFAULT_UP);
@@ -200,26 +200,26 @@ public void advanceFullscreen() {
   }
 
   public void advanceSoundVolMul() {
-    if (volMul == 0) {
-      volMul = .33f;
-    } else if (volMul < .4f) {
-      volMul = .66f;
-    } else if (volMul < .7f) {
-      volMul = 1;
+    if (sfxVolumeMultiplier == 0) {
+      sfxVolumeMultiplier = .33f;
+    } else if (sfxVolumeMultiplier < .4f) {
+      sfxVolumeMultiplier = .66f;
+    } else if (sfxVolumeMultiplier < .7f) {
+      sfxVolumeMultiplier = 1;
     } else {
-      volMul = 0;
+      sfxVolumeMultiplier = 0;
     }
     save();
   }
   public void advanceMusicVolMul() {
-	  if (musicMul == 0) {
-	    musicMul = .33f;
-	  } else if (musicMul < .4f) {
-	    musicMul = .66f;
-	  } else if (musicMul < .7f) {
-	    musicMul = 1;
+	  if (musicVolumeMultiplier == 0) {
+	    musicVolumeMultiplier = .33f;
+	  } else if (musicVolumeMultiplier < .4f) {
+	    musicVolumeMultiplier = .66f;
+	  } else if (musicVolumeMultiplier < .7f) {
+	    musicVolumeMultiplier = 1;
 	  } else {
-	    musicMul = 0;
+	    musicVolumeMultiplier = 0;
 	  }
 	  save();
 	  MusicManager.getInstance().resetVolume(this);
@@ -229,7 +229,7 @@ public void advanceMusicVolMul() {
    * Save the configuration settings to file.
    */
   public void save() {
-    IniReader.write(FILE_NAME, "x", x, "y", y, "fullscreen", fullscreen, "controlType", controlType, "vol", volMul, "musicVol", musicMul,
+    IniReader.write(FILE_NAME, "x", x, "y", y, "fullscreen", fullscreen, "controlType", controlType, "sfxVol", sfxVolumeMultiplier, "musicVol", musicVolumeMultiplier,
             "canSellEquippedItems", canSellEquippedItems,
             "keyUpMouse", getKeyUpMouseName(), "keyDownMouse", getKeyDownMouseName(), "keyUp", getKeyUpName(), "keyDown", keyDownName,
             "keyLeft", keyLeftName, "keyRight", keyRightName, "keyShoot", keyShootName, "keyShoot2", getKeyShoot2Name(),

main/src/org/destinationsol/game/screens/MenuScreen.java

@@ -72,11 +72,11 @@ public void updateCustom(SolApplication cmp, SolInputManager.Ptr[] ptrs, boolean
     g.setPaused(true);
     SolInputManager im = cmp.getInputMan();
     GameOptions options = cmp.getOptions();
-    mySoundVolCtrl.setDisplayName("Sound Volume: " + getVolName(options));
+    mySoundVolCtrl.setDisplayName("Sound Volume: " + getSFXVolumeAsText(options));
     if (mySoundVolCtrl.isJustOff()) {
       options.advanceSoundVolMul();
     }
-    myMusVolCtrl.setDisplayName("Music Volume: " + getMusName(options));
+    myMusVolCtrl.setDisplayName("Music Volume: " + getMusicVolumeAsText(options));
     if(myMusVolCtrl.isJustOff()){
     	options.advanceMusicVolMul();
     }
@@ -99,16 +99,16 @@ public void updateCustom(SolApplication cmp, SolInputManager.Ptr[] ptrs, boolean
     }
   }
 
-  private String getVolName(GameOptions options) {
-    float volMul = options.volMul;
+  private String getSFXVolumeAsText(GameOptions options) {
+    float volMul = options.sfxVolumeMultiplier;
     if (volMul == 0) return "Off";
     else if (volMul < .4f) return "Low";
     else if (volMul < .7f) return "High";
     else {return "Max";}
   }
-  private String getMusName(GameOptions options)
+  private String getMusicVolumeAsText(GameOptions options)
   {
-	  float musMul = options.musicMul;
+	  float musMul = options.musicVolumeMultiplier;
 	  if (musMul == 0) return "Off";
 	  if (musMul < .4f) return "Low";
 	  if (musMul < .7f) return "High";

main/src/org/destinationsol/game/sound/MusicManager.java

@@ -32,7 +32,7 @@ public final class MusicManager {
     private static MusicManager instance = null;
     private static final String DIR = "res/sounds/";
     private final FileHandle menuMusic;
-    private ArrayList<FileHandle> gameMusic = new ArrayList<FileHandle>();;
+    private ArrayList<FileHandle> gameMusic = new ArrayList<FileHandle>();
     private Music currentlyPlaying = null;
     private FileHandle currentMusicFile = null;
     /**
@@ -93,7 +93,7 @@ public void playMusic(FileHandle music, GameOptions options)
     {
         currentMusicFile = music;
     	currentlyPlaying = Gdx.audio.newMusic(music);
-        currentlyPlaying.setVolume(options.musicMul);
+        currentlyPlaying.setVolume(options.musicVolumeMultiplier);
         currentlyPlaying.play();
     }
     /**
@@ -110,6 +110,6 @@ public void StopMusic() {
 
     public void resetVolume(GameOptions options)
     {
-        currentlyPlaying.setVolume(options.musicMul);
+        currentlyPlaying.setVolume(options.musicVolumeMultiplier);
     }
 }

main/src/org/destinationsol/game/sound/SoundManager.java

@@ -125,7 +125,7 @@ public void play(SolGame game, SolSound sound, @Nullable Vector2 pos, @Nullable
     if (source == null && pos == null) throw new AssertionError("pass either pos or source");
     if (source == null && sound.loopTime > 0) throw new AssertionError("looped sound without source object: " + sound.dir);
     if (sound == null) return;
-    float globalVolMul = game.getCmp().getOptions().volMul;
+    float globalVolMul = game.getCmp().getOptions().sfxVolumeMultiplier;
     if (globalVolMul == 0) return;
 
     if (pos == null) pos = source.getPosition();

main/src/org/destinationsol/ui/SolInputManager.java

@@ -345,11 +345,11 @@ public boolean isMouseOnUi() {
   }
 
   public void playHover(SolApplication cmp) {
-    myHoverSound.play(.7f * cmp.getOptions().volMul, .7f, 0);
+    myHoverSound.play(.7f * cmp.getOptions().sfxVolumeMultiplier, .7f, 0);
   }
 
   public void playClick(SolApplication cmp) {
-    myHoverSound.play(.7f * cmp.getOptions().volMul, .9f, 0);
+    myHoverSound.play(.7f * cmp.getOptions().sfxVolumeMultiplier, .9f, 0);
   }
 
   public SolUiScreen getTopScreen() {