Merge pull request #8424 from devLotto/hd-healthbars

client: add High Detail health bars to Interface Styles

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

@@ -1480,6 +1480,14 @@ public interface Client extends GameEngine
 	 */
 	NodeCache getWidgetSpriteCache();
 
+	/**
+	 * Overrides health bar sprites with the sprites from the specified override.
+	 * Pass in {@code null} to revert the health bars back to their default.
+	 *
+	 * @param override the health bar override
+	 */
+	void setHealthBarOverride(HealthBarOverride override);
+
 	/**
 	 * Gets the current server tick count.
 	 *

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

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2019, Lotto <https://github.com/devLotto>
+ * 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 HOLDER 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.api;
+
+import lombok.Data;
+
+@Data
+public class HealthBarOverride
+{
+	public final SpritePixels frontSprite;
+	public final SpritePixels backSprite;
+	public final SpritePixels frontSpriteLarge;
+	public final SpritePixels backSpriteLarge;
+}

runelite-client/src/main/java/net/runelite/client/plugins/interfacestyles/InterfaceStylesConfig.java

@@ -42,4 +42,14 @@ public interface InterfaceStylesConfig extends Config
 	{
 		return Skin.AROUND_2010;
 	}
+
+	@ConfigItem(
+		keyName = "hdHealthBars",
+		name = "High Detail health bars",
+		description = "Replaces health bars with the RuneScape High Detail mode design"
+	)
+	default boolean hdHealthBars()
+	{
+		return false;
+	}
 }

runelite-client/src/main/java/net/runelite/client/plugins/interfacestyles/InterfaceStylesPlugin.java

@@ -28,12 +28,10 @@ package net.runelite.client.plugins.interfacestyles;
 
 import com.google.inject.Provides;
 import java.awt.image.BufferedImage;
-import java.io.IOException;
-import java.io.InputStream;
-import javax.imageio.ImageIO;
 import javax.inject.Inject;
 import lombok.extern.slf4j.Slf4j;
 import net.runelite.api.Client;
+import net.runelite.api.HealthBarOverride;
 import net.runelite.api.SpriteID;
 import net.runelite.api.SpritePixels;
 import net.runelite.api.events.ConfigChanged;
@@ -88,6 +86,7 @@ public class InterfaceStylesPlugin extends Plugin
 		{
 			restoreWidgetDimensions();
 			removeGameframe();
+			client.setHealthBarOverride(null);
 		});
 	}
 
@@ -113,6 +112,7 @@ public class InterfaceStylesPlugin extends Plugin
 		overrideWidgetSprites();
 		restoreWidgetDimensions();
 		adjustWidgetDimensions();
+		overrideHealthBars();
 	}
 
 	private void overrideSprites()
@@ -123,7 +123,8 @@ public class InterfaceStylesPlugin extends Plugin
 			{
 				if (skin == config.skin())
 				{
-					SpritePixels spritePixels = getFileSpritePixels(String.valueOf(spriteOverride.getSpriteID()), null);
+					String file = config.skin().toString() + "/" + spriteOverride.getSpriteID() + ".png";
+					SpritePixels spritePixels = getFileSpritePixels(file);
 
 					if (spriteOverride.getSpriteID() == SpriteID.COMPASS_TEXTURE)
 					{
@@ -154,7 +155,8 @@ public class InterfaceStylesPlugin extends Plugin
 		{
 			if (widgetOverride.getSkin() == config.skin())
 			{
-				SpritePixels spritePixels = getFileSpritePixels(widgetOverride.getName(), "widget");
+				String file = config.skin().toString() + "/widget/" + widgetOverride.getName() + ".png";
+				SpritePixels spritePixels = getFileSpritePixels(file);
 
 				if (spritePixels != null)
 				{
@@ -178,33 +180,18 @@ public class InterfaceStylesPlugin extends Plugin
 		}
 	}
 
-	private SpritePixels getFileSpritePixels(String file, String subfolder)
+	private SpritePixels getFileSpritePixels(String file)
 	{
-		StringBuilder stringBuilder = new StringBuilder();
-		stringBuilder.append(config.skin().toString() + "/");
-
-		if (subfolder != null)
+		try
 		{
-			stringBuilder.append(subfolder + "/");
+			log.debug("Loading: {}", file);
+			BufferedImage image = ImageUtil.getResourceStreamFromClass(this.getClass(), file);
+			return ImageUtil.getImageSpritePixels(image, client);
 		}
-
-		stringBuilder.append(file + ".png");
-		String filePath = stringBuilder.toString();
-
-		try (InputStream inputStream = InterfaceStylesPlugin.class.getResourceAsStream(filePath))
-		{
-			log.debug("Loading: " + filePath);
-			BufferedImage spriteImage = ImageIO.read(inputStream);
-			return ImageUtil.getImageSpritePixels(spriteImage, client);
-		}
-		catch (IOException ex)
+		catch (RuntimeException ex)
 		{
 			log.debug("Unable to load image: ", ex);
 		}
-		catch (IllegalArgumentException ex)
-		{
-			log.debug("Input stream of file path " + filePath + " could not be read: ", ex);
-		}
 
 		return null;
 	}
@@ -245,6 +232,27 @@ public class InterfaceStylesPlugin extends Plugin
 		}
 	}
 
+	private void overrideHealthBars()
+	{
+		if (config.hdHealthBars())
+		{
+			String fileBase = Skin.AROUND_2010.toString() + "/healthbar/";
+
+			SpritePixels frontSprite = getFileSpritePixels(fileBase + "front.png");
+			SpritePixels backSprite = getFileSpritePixels(fileBase + "back.png");
+
+			SpritePixels frontSpriteLarge = getFileSpritePixels(fileBase + "front_large.png");
+			SpritePixels backSpriteLarge = getFileSpritePixels(fileBase + "back_large.png");
+
+			HealthBarOverride override = new HealthBarOverride(frontSprite, backSprite, frontSpriteLarge, backSpriteLarge);
+			client.setHealthBarOverride(override);
+		}
+		else
+		{
+			client.setHealthBarOverride(null);
+		}
+	}
+
 	private void restoreWidgetDimensions()
 	{
 		for (WidgetOffset widgetOffset : WidgetOffset.values())

runelite-client/src/main/java/net/runelite/client/plugins/interfacestyles/Skin.java

@@ -33,6 +33,7 @@ import lombok.Getter;
 @AllArgsConstructor
 public enum Skin
 {
+	DEFAULT("Default"),
 	AROUND_2005("2005"),
 	AROUND_2010("2010");
 

runelite-mixins/src/main/java/net/runelite/mixins/RSClientMixin.java

@@ -41,6 +41,7 @@ import net.runelite.api.GameState;
 import net.runelite.api.GrandExchangeOffer;
 import net.runelite.api.GraphicsObject;
 import net.runelite.api.HashTable;
+import net.runelite.api.HealthBarOverride;
 import net.runelite.api.HintArrowType;
 import net.runelite.api.Ignore;
 import net.runelite.api.IndexDataBase;
@@ -186,6 +187,9 @@ public abstract class RSClientMixin implements RSClient
 		.maximumSize(64)
 		.build();
 
+	@Inject
+	private static HealthBarOverride healthBarOverride;
+
 	@Inject
 	public RSClientMixin()
 	{
@@ -1246,6 +1250,13 @@ public abstract class RSClientMixin implements RSClient
 		client.getCallbacks().post(new UsernameChanged());
 	}
 
+	@Inject
+	@Override
+	public void setHealthBarOverride(HealthBarOverride override)
+	{
+		healthBarOverride = override;
+	}
+
 	@Override
 	@Inject
 	public int getTickCount()

runelite-mixins/src/main/java/net/runelite/mixins/RSHealthBarMixin.java

@@ -0,0 +1,96 @@
+/*
+ * Copyright (c) 2019, Lotto <https://github.com/devLotto>
+ * 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.mixins;
+
+import net.runelite.api.HealthBarOverride;
+import net.runelite.api.mixins.Copy;
+import net.runelite.api.mixins.Mixin;
+import net.runelite.api.mixins.Replace;
+import net.runelite.api.mixins.Shadow;
+import net.runelite.rs.api.RSHealthBar;
+import net.runelite.rs.api.RSSpritePixels;
+
+@Mixin(RSHealthBar.class)
+public abstract class RSHealthBarMixin implements RSHealthBar
+{
+	// Larger values are used for bosses like Corporeal Beast
+	private static final int DEFAULT_HEALTH_SCALE = 30;
+
+	@Shadow("healthBarOverride")
+	private static HealthBarOverride healthBarOverride;
+
+	@Copy("getHealthBarBackSprite")
+	abstract RSSpritePixels rs$getHealthBarBackSprite();
+
+	@Replace("getHealthBarBackSprite")
+	public RSSpritePixels rl$getHealthBarBackSprite()
+	{
+		/*
+		 * If this combat info already uses sprites for health bars,
+		 * use those instead, and don't override.
+		 */
+		RSSpritePixels pixels = rs$getHealthBarBackSprite();
+		if (pixels != null)
+		{
+			return pixels;
+		}
+
+		if (healthBarOverride == null)
+		{
+			return null;
+		}
+
+		return getHealthScale() == DEFAULT_HEALTH_SCALE
+			? (RSSpritePixels) healthBarOverride.backSprite
+			: (RSSpritePixels) healthBarOverride.backSpriteLarge;
+	}
+
+	@Copy("getHealthBarFrontSprite")
+	abstract RSSpritePixels rs$getHealthBarFrontSprite();
+
+	@Replace("getHealthBarFrontSprite")
+	public RSSpritePixels rl$getHealthBarFrontSprite()
+	{
+		/*
+		 * If this combat info already uses sprites for health bars,
+		 * use those instead, and don't override.
+		 */
+		RSSpritePixels pixels = rs$getHealthBarFrontSprite();
+		if (pixels != null)
+		{
+			return pixels;
+		}
+
+		if (healthBarOverride == null)
+		{
+			return null;
+		}
+
+		// 30 is the default size, large is for bosses like Corporeal Beast
+		return getHealthScale() == DEFAULT_HEALTH_SCALE
+			? (RSSpritePixels) healthBarOverride.frontSprite
+			: (RSSpritePixels) healthBarOverride.frontSpriteLarge;
+	}
+}