From a01a2483f7ddeec46af591f878ea5a9f4d8dc2d2 Mon Sep 17 00:00:00 2001
From: Matthew Kramer <machkr@users.noreply.github.com>
Date: Thu, 21 May 2020 15:44:21 -0400
Subject: [PATCH] metronome: add independent volume configuration

---
 .../plugins/metronome/MetronomePlugin.java    | 18 +++++++---
 .../MetronomePluginConfiguration.java         | 36 ++++++++++++++-----
 2 files changed, 40 insertions(+), 14 deletions(-)

diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/metronome/MetronomePlugin.java b/runelite-client/src/main/java/net/runelite/client/plugins/metronome/MetronomePlugin.java
index 7d7416c7f0..0c63dd2033 100644
--- a/runelite-client/src/main/java/net/runelite/client/plugins/metronome/MetronomePlugin.java
+++ b/runelite-client/src/main/java/net/runelite/client/plugins/metronome/MetronomePlugin.java
@@ -27,7 +27,6 @@ package net.runelite.client.plugins.metronome;
 
 import com.google.inject.Provides;
 import javax.inject.Inject;
-import net.runelite.api.SoundEffectVolume;
 import net.runelite.api.Client;
 import net.runelite.api.SoundEffectID;
 import net.runelite.api.events.GameTick;
@@ -69,14 +68,23 @@ public class MetronomePlugin extends Plugin
 
 		if (++tickCounter % config.tickCount() == 0)
 		{
-			if (config.enableTock() && shouldTock)
+			// As playSoundEffect only uses the volume argument when the in-game volume isn't muted, sound effect volume
+			// needs to be set to the value desired for ticks or tocks and afterwards reset to the previous value.
+			int previousVolume = client.getSoundEffectVolume();
+
+			if (shouldTock && config.tockVolume() > 0)
 			{
-				client.playSoundEffect(SoundEffectID.GE_DECREMENT_PLOP, SoundEffectVolume.MEDIUM_HIGH);
+				client.setSoundEffectVolume(config.tockVolume());
+				client.playSoundEffect(SoundEffectID.GE_DECREMENT_PLOP, config.tockVolume());
 			}
-			else
+			else if (config.tickVolume() > 0)
 			{
-				client.playSoundEffect(SoundEffectID.GE_INCREMENT_PLOP, SoundEffectVolume.MEDIUM_HIGH);
+				client.setSoundEffectVolume(config.tickVolume());
+				client.playSoundEffect(SoundEffectID.GE_INCREMENT_PLOP, config.tickVolume());
 			}
+
+			client.setSoundEffectVolume(previousVolume);
+
 			shouldTock = !shouldTock;
 		}
 	}
diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/metronome/MetronomePluginConfiguration.java b/runelite-client/src/main/java/net/runelite/client/plugins/metronome/MetronomePluginConfiguration.java
index cb2ff60889..161af611ae 100644
--- a/runelite-client/src/main/java/net/runelite/client/plugins/metronome/MetronomePluginConfiguration.java
+++ b/runelite-client/src/main/java/net/runelite/client/plugins/metronome/MetronomePluginConfiguration.java
@@ -28,29 +28,47 @@ package net.runelite.client.plugins.metronome;
 import net.runelite.client.config.Config;
 import net.runelite.client.config.ConfigGroup;
 import net.runelite.client.config.ConfigItem;
+import net.runelite.client.config.Range;
+import net.runelite.api.SoundEffectVolume;
 
 @ConfigGroup("metronome")
 public interface MetronomePluginConfiguration extends Config
 {
+	int VOLUME_MAX = SoundEffectVolume.HIGH;
+
 	@ConfigItem(
 		keyName = "tickCount",
 		name = "Tick count",
-		description = "Configures the tick on which a sound will be played",
-		position = 2
+		description = "Configures the tick on which a sound will be played."
 	)
 	default int tickCount()
 	{
 		return 1;
 	}
 
-	@ConfigItem(
-		keyName = "enableTock",
-		name = "Enable tock (alternating) sound",
-		description = "Toggles whether to play two alternating sounds",
-		position = 3
+	@Range(
+		max = VOLUME_MAX
 	)
-	default boolean enableTock()
+	@ConfigItem(
+		keyName = "tickVolume",
+		name = "Tick volume",
+		description = "Configures the volume of the tick sound. A value of 0 will disable tick sounds."
+	)
+	default int tickVolume()
 	{
-		return false;
+		return SoundEffectVolume.MEDIUM_HIGH;
+	}
+
+	@Range(
+		max = VOLUME_MAX
+	)
+	@ConfigItem(
+		keyName = "tockVolume",
+		name = "Tock volume",
+		description = "Configures the volume of the tock sound. A value of 0 will disable tock sounds."
+	)
+	default int tockVolume()
+	{
+		return SoundEffectVolume.MUTED;
 	}
 }