opponent info: add player comparison overlay

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

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2018, Jordan Atwood <jordan.atwood423@gmail.com>
+ * 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.opponentinfo;
+
+import net.runelite.client.config.Config;
+import net.runelite.client.config.ConfigGroup;
+import net.runelite.client.config.ConfigItem;
+
+@ConfigGroup(
+	keyName = "opponentinfo",
+	name = "Opponent Info",
+	description = "Configuration for the Opponent info plugin"
+)
+public interface OpponentInfoConfig extends Config
+{
+	@ConfigItem(
+		keyName = "lookupOnInteraction",
+		name = "Lookup players on interaction",
+		description = "Display a combat stat comparison panel on player interaction. (follow, trade, challenge, attack, etc.)"
+	)
+	default boolean lookupOnInteraction()
+	{
+		return false;
+	}
+}

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

@@ -28,6 +28,7 @@ package net.runelite.client.plugins.opponentinfo;
 import com.google.common.eventbus.Subscribe;
 import com.google.common.reflect.TypeToken;
 import com.google.gson.Gson;
+import com.google.inject.Provides;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.lang.reflect.Type;
@@ -45,6 +46,7 @@ import net.runelite.api.WorldType;
 import net.runelite.api.events.GameStateChanged;
 import net.runelite.api.events.GameTick;
 import net.runelite.api.events.InteractingChanged;
+import net.runelite.client.config.ConfigManager;
 import net.runelite.client.plugins.Plugin;
 import net.runelite.client.plugins.PluginDescriptor;
 import net.runelite.client.ui.overlay.OverlayManager;
@@ -60,11 +62,17 @@ public class OpponentInfoPlugin extends Plugin
 	@Inject
 	private Client client;
 
+	@Inject
+	private OpponentInfoConfig config;
+
 	@Inject
 	private OverlayManager overlayManager;
 
 	@Inject
-	private OpponentInfoOverlay overlay;
+	private OpponentInfoOverlay opponentInfoOverlay;
+
+	@Inject
+	private PlayerComparisonOverlay playerComparisonOverlay;
 
 	@Getter(AccessLevel.PACKAGE)
 	private HiscoreEndpoint hiscoreEndpoint = HiscoreEndpoint.NORMAL;
@@ -77,16 +85,24 @@ public class OpponentInfoPlugin extends Plugin
 	@Getter(AccessLevel.PACKAGE)
 	private final Map<String, Integer> oppInfoHealth = loadNpcHealth();
 
+	@Provides
+	OpponentInfoConfig provideConfig(ConfigManager configManager)
+	{
+		return configManager.getConfig(OpponentInfoConfig.class);
+	}
+
 	@Override
 	protected void startUp() throws Exception
 	{
-		overlayManager.add(overlay);
+		overlayManager.add(opponentInfoOverlay);
+		overlayManager.add(playerComparisonOverlay);
 	}
 
 	@Override
 	protected void shutDown() throws Exception
 	{
-		overlayManager.remove(overlay);
+		overlayManager.remove(opponentInfoOverlay);
+		overlayManager.remove(playerComparisonOverlay);
 	}
 
 	@Subscribe

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

@@ -0,0 +1,182 @@
+/*
+ * Copyright (c) 2018, Jordan Atwood <jordan.atwood423@gmail.com>
+ * Copyright (c) 2018, Adam <Adam@sigterm.info>
+ * 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.opponentinfo;
+
+import java.awt.Color;
+import java.awt.Dimension;
+import java.awt.Graphics2D;
+import javax.inject.Inject;
+import net.runelite.api.Actor;
+import net.runelite.api.Client;
+import net.runelite.api.Player;
+import net.runelite.api.Skill;
+import net.runelite.client.game.HiscoreManager;
+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.components.LineComponent;
+import net.runelite.client.ui.overlay.components.PanelComponent;
+import net.runelite.client.ui.overlay.components.TitleComponent;
+import net.runelite.client.util.Text;
+import net.runelite.http.api.hiscore.HiscoreResult;
+import net.runelite.http.api.hiscore.HiscoreSkill;
+
+class PlayerComparisonOverlay extends Overlay
+{
+	private static final Color HIGHER_STAT_TEXT_COLOR = Color.GREEN;
+	private static final Color LOWER_STAT_TEXT_COLOR = Color.RED;
+	private static final Color NEUTRAL_TEXT_COLOR = Color.WHITE;
+	private static final Color HIGHLIGHT_COLOR = new Color(255, 200, 0, 255);
+
+	private static final Skill[] COMBAT_SKILLS = new Skill[]{
+		Skill.ATTACK,
+		Skill.STRENGTH,
+		Skill.DEFENCE,
+		Skill.HITPOINTS,
+		Skill.RANGED,
+		Skill.MAGIC,
+		Skill.PRAYER
+	};
+
+	private static final HiscoreSkill[] HISCORE_COMBAT_SKILLS = new HiscoreSkill[]{
+		HiscoreSkill.ATTACK,
+		HiscoreSkill.STRENGTH,
+		HiscoreSkill.DEFENCE,
+		HiscoreSkill.HITPOINTS,
+		HiscoreSkill.RANGED,
+		HiscoreSkill.MAGIC,
+		HiscoreSkill.PRAYER
+	};
+
+	private static final String LEFT_COLUMN_HEADER = "Skill";
+	private static final String RIGHT_COLUMN_HEADER = "You/Them";
+
+	private final Client client;
+	private final OpponentInfoPlugin opponentInfoPlugin;
+	private final OpponentInfoConfig config;
+	private final HiscoreManager hiscoreManager;
+	private final PanelComponent panelComponent = new PanelComponent();
+
+	@Inject
+	private PlayerComparisonOverlay(Client client, OpponentInfoPlugin opponentInfoPlugin, OpponentInfoConfig config, HiscoreManager hiscoreManager)
+	{
+		this.client = client;
+		this.opponentInfoPlugin = opponentInfoPlugin;
+		this.config = config;
+		this.hiscoreManager = hiscoreManager;
+
+		setPosition(OverlayPosition.BOTTOM_LEFT);
+		setLayer(OverlayLayer.ABOVE_WIDGETS);
+	}
+
+	@Override
+	public Dimension render(Graphics2D graphics)
+	{
+		if (!config.lookupOnInteraction())
+		{
+			return null;
+		}
+
+		final Actor opponent = opponentInfoPlugin.getLastOpponent();
+
+		if (opponent == null)
+		{
+			return null;
+		}
+
+		// Don't try to look up NPC names
+		if (!(opponent instanceof Player))
+		{
+			return null;
+		}
+
+		final String opponentName = Text.removeTags(opponent.getName());
+		final HiscoreResult hiscoreResult = hiscoreManager.lookupAsync(opponentName, opponentInfoPlugin.getHiscoreEndpoint());
+		if (hiscoreResult == null)
+		{
+			return null;
+		}
+
+		panelComponent.getChildren().clear();
+		generateComparisonTable(panelComponent, hiscoreResult);
+		return panelComponent.render(graphics);
+	}
+
+	private void generateComparisonTable(PanelComponent panelComponent, HiscoreResult opponentSkills)
+	{
+		final String opponentName = opponentSkills.getPlayer();
+
+		panelComponent.getChildren().add(
+			TitleComponent.builder()
+				.text(opponentName)
+				.color(HIGHLIGHT_COLOR)
+				.build());
+
+		panelComponent.getChildren().add(
+			LineComponent.builder()
+				.left(LEFT_COLUMN_HEADER)
+				.leftColor(HIGHLIGHT_COLOR)
+				.right(RIGHT_COLUMN_HEADER)
+				.rightColor(HIGHLIGHT_COLOR)
+				.build());
+
+		for (int i = 0; i < COMBAT_SKILLS.length; ++i)
+		{
+			final HiscoreSkill hiscoreSkill = HISCORE_COMBAT_SKILLS[i];
+			final Skill skill = COMBAT_SKILLS[i];
+
+			final net.runelite.http.api.hiscore.Skill opponentSkill = opponentSkills.getSkill(hiscoreSkill);
+
+			if (opponentSkill == null || opponentSkill.getLevel() == -1)
+			{
+				continue;
+			}
+
+			final int playerSkillLevel = client.getRealSkillLevel(skill);
+			final int opponentSkillLevel = opponentSkill.getLevel();
+
+			panelComponent.getChildren().add(
+				LineComponent.builder()
+					.left(hiscoreSkill.getName())
+					.right(Integer.toString(playerSkillLevel) + "/" + Integer.toString(opponentSkillLevel))
+					.rightColor(comparisonStatColor(playerSkillLevel, opponentSkillLevel))
+					.build());
+		}
+	}
+
+	private static Color comparisonStatColor(int a, int b)
+	{
+		if (a > b)
+		{
+			return HIGHER_STAT_TEXT_COLOR;
+		}
+		if (a < b)
+		{
+			return LOWER_STAT_TEXT_COLOR;
+		}
+		return NEUTRAL_TEXT_COLOR;
+	}
+}