Add npc stats to NPCManager & remove npc_health.json

Also updates all plugins that relied on the old NPCManager method

http-api/src/main/java/net/runelite/http/api/npc/NPCClient.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) 2019, TheStonedTurtle <https://github.com/TheStonedTurtle>
+ * 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.http.api.npc;
+
+import com.google.gson.JsonParseException;
+import com.google.gson.reflect.TypeToken;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.lang.reflect.Type;
+import java.util.Map;
+import net.runelite.http.api.RuneLiteAPI;
+import okhttp3.HttpUrl;
+import okhttp3.Request;
+import okhttp3.Response;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class NPCClient
+{
+	private static final Logger logger = LoggerFactory.getLogger(NPCClient.class);
+
+	public Map<Integer, NPCStats> getStats() throws IOException
+	{
+		final HttpUrl.Builder urlBuilder = RuneLiteAPI.getStaticBase().newBuilder()
+			.addPathSegment("npc")
+			.addPathSegment("stats.min.json");
+
+		final HttpUrl url = urlBuilder.build();
+
+		logger.debug("Built URI: {}", url);
+
+		final Request request = new Request.Builder()
+			.url(url)
+			.build();
+
+		try (final Response response = RuneLiteAPI.CLIENT.newCall(request).execute())
+		{
+			if (!response.isSuccessful())
+			{
+				logger.warn("Error looking up npc stats: {}", response);
+				return null;
+			}
+
+			InputStream in = response.body().byteStream();
+			final Type typeToken = new TypeToken<Map<Integer, NPCStats>>()
+			{
+			}.getType();
+
+			return RuneLiteAPI.GSON.fromJson(new InputStreamReader(in), typeToken);
+		}
+		catch (JsonParseException ex)
+		{
+			throw new IOException(ex);
+		}
+	}
+}

http-api/src/main/java/net/runelite/http/api/npc/NPCStats.java

@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) 2019, TheStonedTurtle <https://github.com/TheStonedTurtle>
+ * 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.http.api.npc;
+
+import lombok.Value;
+
+@Value
+public class NPCStats
+{
+	private final String name;
+
+	private final int hitpoints;
+	private final int combatLevel;
+	private final int slayerLevel;
+
+	private final int attackLevel;
+	private final int strengthLevel;
+	private final int defenceLevel;
+	private final int rangeLevel;
+	private final int magicLevel;
+
+	private final int stab;
+	private final int slash;
+	private final int crush;
+	private final int range;
+	private final int magic;
+
+	private final int stabDef;
+	private final int slashDef;
+	private final int crushDef;
+	private final int rangeDef;
+	private final int magicDef;
+
+	private final int bonusAttack;
+	private final int bonusStrength;
+	private final int bonusRangeStrength;
+	private final int bonusMagicDamage;
+
+	private final boolean poisonImmune;
+	private final boolean venomImmune;
+
+	/**
+	 * Based off the formula found here: http://services.runescape.com/m=forum/c=PLuJ4cy6gtA/forums.ws?317,318,712,65587452,209,337584542#209
+	 * @return bonus XP modifier
+	 */
+	public double calculateXpModifier()
+	{
+		final double averageLevel = Math.floor((attackLevel + strengthLevel + defenceLevel + hitpoints) / 4);
+		final double averageDefBonus = Math.floor((stabDef + slashDef + crushDef) / 3);
+
+		return (1 + Math.floor(averageLevel * (averageDefBonus + bonusStrength + bonusAttack) / 5120) / 40);
+	}
+}

runelite-client/src/main/java/net/runelite/client/game/NPCManager.java

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2018, Adam <Adam@sigterm.info>
+ * Copyright (c) 2019, TheStonedTurtle <https://github.com/TheStonedTurtle>
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -24,42 +25,89 @@
  */
 package net.runelite.client.game;
 
-import com.google.gson.Gson;
-import com.google.gson.reflect.TypeToken;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.lang.reflect.Type;
+import com.google.common.collect.ImmutableMap;
+import java.io.IOException;
 import java.util.Map;
 import javax.annotation.Nullable;
 import javax.inject.Inject;
 import javax.inject.Singleton;
+import lombok.extern.slf4j.Slf4j;
+import net.runelite.http.api.npc.NPCClient;
+import net.runelite.http.api.npc.NPCStats;
 
 @Singleton
+@Slf4j
 public class NPCManager
 {
-	private final Map<String, Integer> healthMap;
+	private final NPCClient NPCClient = new NPCClient();
+	private final ImmutableMap<Integer, NPCStats> statsMap;
 
 	@Inject
 	private NPCManager()
 	{
-		final Gson gson = new Gson();
-		final Type typeToken = new TypeToken<Map<String, Integer>>()
-		{
-		}.getType();
+		this.statsMap = getStatsMap();
+	}
 
-		final InputStream healthFile = getClass().getResourceAsStream("/npc_health.json");
-		healthMap = gson.fromJson(new InputStreamReader(healthFile), typeToken);
+	private ImmutableMap<Integer, NPCStats> getStatsMap()
+	{
+		try
+		{
+			final Map<Integer, NPCStats> stats = NPCClient.getStats();
+			if (stats != null)
+			{
+				log.debug("Loaded {} npc stats", stats.size());
+				return ImmutableMap.copyOf(stats);
+			}
+		}
+		catch (IOException e)
+		{
+			log.warn("error loading stats!", e);
+		}
+
+		return ImmutableMap.of();
 	}
 
 	/**
-	 * Returns health for target NPC based on it's combat level and name
-	 * @param name npc name
-	 * @param combatLevel npc combat level
-	 * @return health or null if HP is unknown
+	 * Returns the {@link NPCStats} for target NPC id
+	 * @param npcId NPC id
+	 * @return the {@link NPCStats} or null if unknown
 	 */
 	@Nullable
-	public Integer getHealth(final String name, final int combatLevel)
+	public NPCStats getStats(final int npcId)
 	{
-		return healthMap.get(name + "_" + combatLevel);
+		return statsMap.get(npcId);
+	}
+
+	/**
+	 * Returns health for target NPC ID
+	 * @param npcId NPC id
+	 * @return health or null if unknown
+	 */
+	@Nullable
+	public Integer getHealth(final int npcId)
+	{
+		final NPCStats s = statsMap.get(npcId);
+		if (s == null || s.getHitpoints() == -1)
+		{
+			return null;
+		}
+
+		return s.getHitpoints();
+	}
+
+	/**
+	 * Returns the exp modifier for target NPC ID based on its stats.
+	 * @param npcId NPC id
+	 * @return npcs exp modifier. Assumes default xp rate if npc stats are unknown (returns 1)
+	 */
+	public double getXpModifier(final int npcId)
+	{
+		final NPCStats s = statsMap.get(npcId);
+		if (s == null)
+		{
+			return 1;
+		}
+
+		return s.calculateXpModifier();
 	}
 }

runelite-client/src/main/java/net/runelite/client/plugins/opponentinfo/OpponentInfoOverlay.java

@@ -114,7 +114,7 @@ class OpponentInfoOverlay extends Overlay
 			lastMaxHealth = null;
 			if (opponent instanceof NPC)
 			{
-				lastMaxHealth = npcManager.getHealth(opponentName, opponent.getCombatLevel());
+				lastMaxHealth = npcManager.getHealth(((NPC) opponent).getId());
 			}
 			else if (opponent instanceof Player)
 			{

runelite-client/src/main/java/net/runelite/client/plugins/slayer/TargetWeaknessOverlay.java

@@ -40,7 +40,6 @@ import net.runelite.client.ui.overlay.Overlay;
 import net.runelite.client.ui.overlay.OverlayLayer;
 import net.runelite.client.ui.overlay.OverlayPosition;
 import net.runelite.client.ui.overlay.OverlayUtil;
-import net.runelite.client.util.Text;
 
 class TargetWeaknessOverlay extends Overlay
 {
@@ -109,8 +108,7 @@ class TargetWeaknessOverlay extends Overlay
 
 		final int healthScale = target.getHealth();
 		final int healthRatio = target.getHealthRatio();
-		final String targetName = Text.removeTags(target.getName());
-		final Integer maxHealth = npcManager.getHealth(targetName, target.getCombatLevel());
+		final Integer maxHealth = npcManager.getHealth(target.getId());
 
 		if (healthRatio < 0 || healthScale <= 0 || maxHealth == null)
 		{

runelite-client/src/main/java/net/runelite/client/plugins/xptracker/XpTrackerPlugin.java

@@ -296,7 +296,7 @@ public class XpTrackerPlugin extends Plugin
 		if (interacting instanceof NPC && COMBAT.contains(skill))
 		{
 			final NPC npc = (NPC) interacting;
-			xpState.updateNpcExperience(skill, npc, npcManager.getHealth(npc.getName(), npc.getCombatLevel()));
+			xpState.updateNpcExperience(skill, npc, npcManager.getHealth(npc.getId()));
 		}
 
 		final XpUpdateResult updateResult = xpState.updateSkill(skill, currentXp, startGoalXp, endGoalXp);
@@ -328,7 +328,7 @@ public class XpTrackerPlugin extends Plugin
 
 		for (Skill skill : COMBAT)
 		{
-			final XpUpdateResult updateResult = xpState.updateNpcKills(skill, npc, npcManager.getHealth(npc.getName(), npc.getCombatLevel()));
+			final XpUpdateResult updateResult = xpState.updateNpcKills(skill, npc, npcManager.getHealth(npc.getId()));
 			final boolean updated = XpUpdateResult.UPDATED.equals(updateResult);
 			xpPanel.updateSkillExperience(updated, xpPauseState.isPaused(skill), skill, xpState.getSkillSnapshot(skill));
 		}