Merge pull request #272 from devinfrench/jad

Update fight cave plugin

runelite-client/src/main/java/net/runelite/client/plugins/fightcave/FightCaveConfig.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2017, Devin French <https://github.com/devinfrench>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package net.runelite.client.plugins.fightcave;
+
+import net.runelite.client.config.Config;
+import net.runelite.client.config.ConfigGroup;
+import net.runelite.client.config.ConfigItem;
+
+@ConfigGroup(
+	keyName = "fightcave",
+	name = "Fight Cave",
+	description = "Configuration for the fight cave plugin"
+)
+public interface FightCaveConfig extends Config
+{
+	@ConfigItem(
+		keyName = "enabled",
+		name = "Enabled",
+		description = "Configures whether or not fight cave overlay is displayed"
+	)
+	default boolean enabled()
+	{
+		return true;
+	}
+}

runelite-client/src/main/java/net/runelite/client/plugins/fightcave/FightCaveOverlay.java

@@ -24,43 +24,37 @@
  */
 package net.runelite.client.plugins.fightcave;
 
-import java.awt.Color;
+import lombok.extern.slf4j.Slf4j;
-import java.awt.Dimension;
+import net.runelite.api.Client;
-import java.awt.FontMetrics;
+import net.runelite.client.ui.overlay.Overlay;
-import java.awt.Graphics2D;
+import net.runelite.client.ui.overlay.OverlayPosition;
-import java.awt.Image;
+import net.runelite.client.ui.overlay.OverlayPriority;
-import java.awt.Point;
+import net.runelite.client.ui.overlay.components.ImagePanelComponent;
-import java.awt.Rectangle;
+
-import java.io.IOException;
-import java.io.InputStream;
 import javax.annotation.Nullable;
 import javax.imageio.ImageIO;
 import javax.inject.Inject;
-import lombok.extern.slf4j.Slf4j;
+import java.awt.Dimension;
-import net.runelite.api.Client;
+import java.awt.Graphics2D;
-import net.runelite.api.widgets.Widget;
+import java.awt.Point;
-import net.runelite.client.ui.overlay.Overlay;
+import java.awt.image.BufferedImage;
-import net.runelite.client.ui.overlay.OverlayPosition;
+import java.io.IOException;
+import java.io.InputStream;
 
 @Slf4j
 public class FightCaveOverlay extends Overlay
 {
-	private static final int WIDTH = 70;
-	private static final int SPACER = 6;
-	private static final int BOTTOM_BORDER = 4;
-	private static final Color GREEN_BACKGROUND = new Color(0, 255, 0, 100);
-	private static final Color RED_BACKGROUND = new Color(255, 0, 0, 100);
-
 	private final Client client;
 	private final FightCavePlugin plugin;
 
-	private Image protectFromMagicImg;
+	private BufferedImage protectFromMagicImg;
-	private Image protectFromMissilesImg;
+	private BufferedImage protectFromMissilesImg;
 
 	@Inject
 	FightCaveOverlay(@Nullable Client client, FightCavePlugin plugin)
 	{
-		setPosition(OverlayPosition.DYNAMIC);
+		setPosition(OverlayPosition.BOTTOM_RIGHT);
+		setPriority(OverlayPriority.HIGH);
 		this.client = client;
 		this.plugin = plugin;
 	}
@@ -69,65 +63,23 @@ public class FightCaveOverlay extends Overlay
 	public Dimension render(Graphics2D graphics, Point parent)
 	{
 		JadAttack attack = plugin.getAttack();
-		Rectangle viewport = getViewportBounds();
+		if (attack == null || client == null || client.isPrayerActive(attack.getPrayer()))
-		if (attack == null || viewport == null)
 		{
 			return null;
 		}
-
+		BufferedImage prayerImage = getPrayerImage(attack);
-		Image img = getPrayerImage(attack);
+		ImagePanelComponent imagePanelComponent = new ImagePanelComponent();
-		if (img == null)
+		imagePanelComponent.setTitle("Switch!");
-		{
+		imagePanelComponent.setImage(prayerImage);
-			return null;
+		return imagePanelComponent.render(graphics, parent);
-		}
-
-		Color bgColor;
-		Color outlineColor;
-		Widget prayer = client.getWidget(attack.getPrayerWidgetInfo());
-		FontMetrics fm = graphics.getFontMetrics();
-		int height = fm.getHeight() + img.getHeight(null) + SPACER + BOTTOM_BORDER;
-
-		if (client.isPrayerActive(attack.getPrayer()))
-		{
-			bgColor = GREEN_BACKGROUND;
-			outlineColor = Color.GREEN.darker();
-		}
-		else
-		{
-			bgColor = RED_BACKGROUND;
-			outlineColor = Color.RED.darker();
-		}
-
-		int bgX = (int) (viewport.getX() + viewport.getWidth() - WIDTH);
-		int bgY = (int) (viewport.getY() + viewport.getHeight() - height);
-		graphics.setColor(bgColor);
-		graphics.fillRect(bgX, bgY, WIDTH, height);
-
-		if (prayer != null)
-		{
-			graphics.setColor(outlineColor);
-			graphics.draw(prayer.getBounds());
-		}
-
-		graphics.setColor(Color.WHITE);
-		graphics.drawString("TzTok-Jad", bgX + (WIDTH - fm.stringWidth("TzTok-Jad")) / 2, bgY + fm.getHeight());
-		graphics.drawImage(img, bgX + (WIDTH - img.getWidth(null)) / 2, bgY + fm.getHeight() + SPACER, null);
-
-		return null;
 	}
 
-	private Rectangle getViewportBounds()
+	private BufferedImage getPrayerImage(JadAttack attack)
-	{
-		Widget viewport = client.getViewportWidget();
-		return viewport != null ? viewport.getBounds() : null;
-	}
-
-	private Image getPrayerImage(JadAttack attack)
 	{
 		return attack == JadAttack.MAGIC ? getProtectFromMagicImage() : getProtectFromMissilesImage();
 	}
 
-	private Image getProtectFromMagicImage()
+	private BufferedImage getProtectFromMagicImage()
 	{
 		if (protectFromMagicImg == null)
 		{
@@ -137,7 +89,7 @@ public class FightCaveOverlay extends Overlay
 		return protectFromMagicImg;
 	}
 
-	private Image getProtectFromMissilesImage()
+	private BufferedImage getProtectFromMissilesImage()
 	{
 		if (protectFromMissilesImg == null)
 		{
@@ -147,9 +99,9 @@ public class FightCaveOverlay extends Overlay
 		return protectFromMissilesImg;
 	}
 
-	private Image getImage(String path)
+	private BufferedImage getImage(String path)
 	{
-		Image image = null;
+		BufferedImage image = null;
 		try
 		{
 			InputStream in = FightCaveOverlay.class.getResourceAsStream(path);

runelite-client/src/main/java/net/runelite/client/plugins/fightcave/FightCavePlugin.java

@@ -28,12 +28,15 @@ import com.google.inject.Binder;
 import java.time.temporal.ChronoUnit;
 import javax.annotation.Nullable;
 import javax.inject.Inject;
+
+import com.google.inject.Provides;
 import net.runelite.api.Client;
 import net.runelite.api.GameState;
 import net.runelite.api.NPC;
 import net.runelite.api.Query;
 import net.runelite.api.queries.NPCQuery;
 import net.runelite.client.RuneLite;
+import net.runelite.client.config.ConfigManager;
 import net.runelite.client.plugins.Plugin;
 import net.runelite.client.plugins.PluginDescriptor;
 import net.runelite.client.task.Schedule;
@@ -51,6 +54,9 @@ public class FightCavePlugin extends Plugin
 	@Inject
 	RuneLite runelite;
 
+	@Inject
+	FightCaveConfig config;
+
 	@Inject
 	FightCaveOverlay overlay;
 
@@ -62,6 +68,12 @@ public class FightCavePlugin extends Plugin
 		binder.bind(FightCaveOverlay.class);
 	}
 
+	@Provides
+	FightCaveConfig provideConfig(ConfigManager configManager)
+	{
+		return configManager.getConfig(FightCaveConfig.class);
+	}
+
 	@Override
 	public Overlay getOverlay()
 	{
@@ -74,7 +86,7 @@ public class FightCavePlugin extends Plugin
 	)
 	public void update()
 	{
-		if (client == null || client.getGameState() != GameState.LOGGED_IN)
+		if (!config.enabled() || client == null || client.getGameState() != GameState.LOGGED_IN)
 		{
 			return;
 		}

runelite-client/src/main/java/net/runelite/client/plugins/fightcave/JadAttack.java

@@ -26,22 +26,19 @@ package net.runelite.client.plugins.fightcave;
 
 import net.runelite.api.AnimationID;
 import net.runelite.api.Prayer;
-import net.runelite.api.widgets.WidgetInfo;
 
 public enum JadAttack
 {
-	MAGIC(AnimationID.TZTOK_JAD_MAGIC_ATTACK, Prayer.PROTECT_FROM_MAGIC, WidgetInfo.PRAYER_PROTECT_FROM_MAGIC),
+	MAGIC(AnimationID.TZTOK_JAD_MAGIC_ATTACK, Prayer.PROTECT_FROM_MAGIC),
-	RANGE(AnimationID.TZTOK_JAD_RANGE_ATTACK, Prayer.PROTECT_FROM_MISSILES, WidgetInfo.PRAYER_PROTECT_FROM_MISSILES);
+	RANGE(AnimationID.TZTOK_JAD_RANGE_ATTACK, Prayer.PROTECT_FROM_MISSILES);
 
 	private final int animation;
 	private final Prayer prayer;
-	private final WidgetInfo prayerWidgetInfo;
 
-	JadAttack(int animation, Prayer prayer, WidgetInfo prayerWidgetInfo)
+	JadAttack(int animation, Prayer prayer)
 	{
 		this.animation = animation;
 		this.prayer = prayer;
-		this.prayerWidgetInfo = prayerWidgetInfo;
 	}
 
 	public int getAnimation()
@@ -53,9 +50,4 @@ public enum JadAttack
 	{
 		return prayer;
 	}
-
-	public WidgetInfo getPrayerWidgetInfo()
-	{
-		return prayerWidgetInfo;
-	}
 }