Merge pull request #633 from f0rmatme/new_updates

Added scout overlay hotkey toggle

runelite-api/src/main/java/net/runelite/api/Varbits.java

@@ -295,6 +295,15 @@ public enum Varbits
 	THEATRE_OF_BLOOD(6440),
 	BLOAT_DOOR(6447),
 
+	/**
+	 * Theatre of Blood orb varbits each number stands for the player's health on a scale of 1-27 (I think), 0 hides the orb
+	 */
+	THEATRE_OF_BLOOD_ORB_1(6442),
+	THEATRE_OF_BLOOD_ORB_2(6443),
+	THEATRE_OF_BLOOD_ORB_3(6444),
+	THEATRE_OF_BLOOD_ORB_4(6445),
+	THEATRE_OF_BLOOD_ORB_5(6446),
+
 	/**
 	 * Nightmare Zone
 	 */

runelite-client/src/main/java/net/runelite/client/plugins/raids/RaidsConfig.java

@@ -30,6 +30,7 @@ import net.runelite.client.config.Config;
 import net.runelite.client.config.ConfigGroup;
 import net.runelite.client.config.ConfigItem;
 import net.runelite.client.config.Stub;
+import net.runelite.client.config.Keybind;
 
 @ConfigGroup("raids")
 public interface RaidsConfig extends Config
@@ -417,4 +418,15 @@ public interface RaidsConfig extends Config
 	{
 		return false;
 	}
+
+	@ConfigItem(
+			keyName = "hotkey",
+			name = "Toggle scout overlay",
+			description = "When pressed the scout overlay will be toggled. Must enable show scout overlay in raid",
+			position = 31
+	)
+	default Keybind hotkey()
+	{
+		return Keybind.NOT_SET;
+	}
 }

runelite-client/src/main/java/net/runelite/client/plugins/raids/RaidsOverlay.java

@@ -80,7 +80,7 @@ public class RaidsOverlay extends Overlay
 	@Setter
 	private boolean sharable = false;
 
-	@Setter
+	@Getter @Setter
 	private boolean scoutOverlayShown = false;
 
 	@Getter

runelite-client/src/main/java/net/runelite/client/plugins/raids/RaidsPlugin.java

@@ -91,6 +91,7 @@ import net.runelite.client.ui.overlay.infobox.InfoBoxManager;
 import net.runelite.client.ui.overlay.tooltip.Tooltip;
 import net.runelite.client.ui.overlay.tooltip.TooltipManager;
 import net.runelite.client.util.ImageUtil;
+import net.runelite.client.util.HotkeyListener;
 import net.runelite.client.util.Text;
 import org.apache.commons.lang3.StringUtils;
 import java.util.HashSet;
@@ -155,15 +156,15 @@ public class RaidsPlugin extends Plugin
 	@Inject
 	private LayoutSolver layoutSolver;
 
+	@Inject
+	private KeyManager keyManager;
+
 	@Inject
 	private SpriteManager spriteManager;
 
 	@Inject
 	private ClientThread clientThread;
 
-	@Inject
-	private KeyManager keyManager;
-
 	@Inject
 	private TooltipManager tooltipManager;
 
@@ -199,6 +200,8 @@ public class RaidsPlugin extends Plugin
 	private String tooltip;
 	public boolean canShow;
 	private NavigationButton navButton;
+	private boolean raidStarted;
+
 	private RaidsTimer timer;
 
 	@Getter
@@ -234,6 +237,7 @@ public class RaidsPlugin extends Plugin
 		{
 			overlayManager.add(partyOverlay);
 		}
+		keyManager.registerKeyListener(hotkeyListener);
 		updateLists();
 		clientThread.invokeLater(() -> checkRaidPresence(true));
 		widgetOverlay = overlayManager.getWidgetOverlay(WidgetInfo.RAIDS_POINTS_INFOBOX);
@@ -260,8 +264,10 @@ public class RaidsPlugin extends Plugin
 			overlayManager.remove(partyOverlay);
 		}
 		infoBoxManager.removeInfoBox(timer);
+		keyManager.unregisterKeyListener(hotkeyListener);
 		inRaidChambers = false;
 		widgetOverlay = null;
+		raidStarted = false;
 		raid = null;
 		timer = null;
 
@@ -343,6 +349,7 @@ public class RaidsPlugin extends Plugin
 				{
 					timer = new RaidsTimer(spriteManager.getSprite(TAB_QUESTS_BROWN_RAIDING_PARTY, 0), this, Instant.now());
 					infoBoxManager.addInfoBox(timer);
+					raidStarted = true;
 				}
 				if (config.partyDisplay())
 				{
@@ -613,6 +620,7 @@ public class RaidsPlugin extends Plugin
 		if (client.getVar(VarPlayer.IN_RAID_PARTY) == -1 && (!inRaidChambers || !config.scoutOverlayInRaid()))
 		{
 			overlay.setScoutOverlayShown(false);
+			raidStarted = false;
 		}
 	}
 
@@ -1064,4 +1072,24 @@ public class RaidsPlugin extends Plugin
 		builder.append("</br>Olm: ").append(secondsToTime(raidTime - lowerTime));
 		tooltip = builder.toString();
 	}
+
+	private final HotkeyListener hotkeyListener = new HotkeyListener(() -> config.hotkey())
+	{
+		@Override
+		public void hotkeyPressed()
+		{
+			if (config.scoutOverlayInRaid() && raidStarted)
+			{
+				if (overlay.isScoutOverlayShown())
+				{
+					overlay.setScoutOverlayShown(false);
+				}
+				else
+				{
+					overlay.setScoutOverlayShown(true);
+				}
+			}
+		}
+	};
+
 }