Development to main

src/main/java/net/runelite/client/plugins/microbot/attackrangesplus/AttackRangesPlusCalc.java

@@ -0,0 +1,101 @@
+package net.runelite.client.plugins.microbot.attackrangesplus;
+
+import lombok.extern.slf4j.Slf4j;
+import net.runelite.client.plugins.microbot.util.combat.Rs2Combat;
+import net.runelite.client.plugins.microbot.util.combat.weapons.Melee;
+import net.runelite.client.plugins.microbot.util.combat.weapons.Weapon;
+import net.runelite.client.plugins.microbot.util.combat.weapons.WeaponsGenerator;
+
+import javax.inject.Inject;
+import java.util.Map;
+
+/**
+ * Resolves the attack radius (in tiles) for the overlay.
+ *
+ * <p><b>Player:</b> AUTO delegates to {@link Rs2Combat#getAttackRange()}, the maintained Microbot
+ * helper that reads the equipped weapon and the selected attack style and returns the real range:
+ * accurate per weapon, long-range aware, the spell range while autocasting, halberds = 2, and 1 for
+ * melee/unknown. The manual modes are fixed representative ranges for previewing a style you are not
+ * currently using.</p>
+ *
+ * <p><b>Opponent:</b> another player's attack-style varbits are not readable, so their range is
+ * looked up from their equipped weapon id against the same weapon data Microbot uses
+ * ({@link WeaponsGenerator#generate()}). That gives the weapon's base reach (no style modifier);
+ * melee weapons resolve to 1 since their stored range is the special-attack range.</p>
+ */
+@Slf4j
+public class AttackRangesPlusCalc
+{
+    @Inject
+    private AttackRangesPlusConfig config;
+
+    private static final int MELEE_RADIUS = 1;
+    private static final int RANGED_PREVIEW_RADIUS = 7;
+    private static final int MAGIC_RADIUS = 10;
+
+    /**
+     * Initialization-on-demand holder: the map is built once, thread-safely, on first use.
+     * Same data Rs2Combat uses; reused for opponent weapon lookups.
+     */
+    private static final class WeaponsHolder
+    {
+        private static final Map<Integer, Weapon> MAP = WeaponsGenerator.generate();
+    }
+
+    /** Set once when the AUTO range lookup fails, so the fallback is logged once rather than per tick. */
+    private boolean autoRangeFailureLogged;
+
+    /**
+     * @return the local player's attack radius in tiles (>= 0). Never throws.
+     */
+    public int getPlayerRangeRadius()
+    {
+        switch (config.style())
+        {
+            case MELEE:
+                return MELEE_RADIUS;
+            case RANGED:
+                return RANGED_PREVIEW_RADIUS;
+            case MAGIC:
+                return MAGIC_RADIUS;
+            case AUTO:
+            default:
+                try
+                {
+                    return Math.max(Rs2Combat.getAttackRange(), 0);
+                }
+                catch (Exception e)
+                {
+                    if (!autoRangeFailureLogged)
+                    {
+                        autoRangeFailureLogged = true;
+                        log.debug("Rs2Combat.getAttackRange failed; falling back to melee radius", e);
+                    }
+                    return MELEE_RADIUS;
+                }
+        }
+    }
+
+    /**
+     * Threat radius for another player's equipped weapon. Their attack style is not knowable, so
+     * this is the weapon's base reach.
+     *
+     * @param weaponId the opponent's equipped weapon item id
+     * @return the radius in tiles (>= 1)
+     */
+    public int getWeaponRadius(int weaponId)
+    {
+        final Weapon w = WeaponsHolder.MAP.get(weaponId);
+        if (w == null)
+        {
+            return MELEE_RADIUS; // unknown weapon -> assume melee reach
+        }
+        if (w instanceof Melee)
+        {
+            return MELEE_RADIUS; // Melee.range stores the special-attack range, not normal reach
+        }
+        // "Accurate" yields the weapon's base (non-long-range) reach across all Weapon subtypes:
+        // Halberd=2, ranged base, magic/powered-staff spell range.
+        return Math.max(w.getRange("Accurate"), MELEE_RADIUS);
+    }
+}

src/main/java/net/runelite/client/plugins/microbot/attackrangesplus/AttackRangesPlusConfig.java

@@ -0,0 +1,110 @@
+package net.runelite.client.plugins.microbot.attackrangesplus;
+
+import net.runelite.client.config.Alpha;
+import net.runelite.client.config.Config;
+import net.runelite.client.config.ConfigGroup;
+import net.runelite.client.config.ConfigInformation;
+import net.runelite.client.config.ConfigItem;
+
+import java.awt.Color;
+
+@ConfigGroup("attackrangesplus")
+@ConfigInformation("<h2>Attack Ranges Plus</h2>" +
+        "<h3>Version: " + AttackRangesPlusPlugin.version + "</h3>" +
+        "<p>This overlay draws your attack range on the ground, clipped to line of sight. It runs no script and never moves or banks for you.</p>" +
+        "<p></p>" +
+        "<p>1. <strong>Attack style:</strong> how the range is sized. Auto reads your weapon and falls back to melee. Pick Melee, Ranged, or Magic to force a size. Use Magic when casting at 10 tiles.</p>" +
+        "<p></p>" +
+        "<p>2. <strong>Line color:</strong> the color of the range outline.</p>" +
+        "<p></p>" +
+        "<p>3. <strong>Fill area:</strong> shades the tiles inside your range. The shading is redrawn every frame and can cost FPS at large ranges like magic. Leave it off for the cheapest outline only overlay.</p>" +
+        "<p></p>" +
+        "<p>4. <strong>Fill color:</strong> the color and opacity of the shaded area. Used only when Fill area is on.</p>" +
+        "<p></p>" +
+        "<p>5. <strong>Show overlay:</strong> when to draw it. Always shows it everywhere. In PvP areas limits it to the Wilderness, PvP and Deadman worlds, and PvP flagged zones.</p>" +
+        "<p></p>" +
+        "<p>6. <strong>Show target's range:</strong> also outline the range of the player you are fighting. Their exact style is not knowable, so this is their weapon's base reach.</p>" +
+        "<p></p>" +
+        "<p>7. <strong>Target line color:</strong> the outline color used for your target's range.</p>")
+public interface AttackRangesPlusConfig extends Config
+{
+    @ConfigItem(
+            keyName = "style",
+            name = "Attack style",
+            description = "How to size the overlay. Auto detects ranged weapons and falls back to melee. Pick Magic when casting (10 tiles).",
+            position = 0
+    )
+    default RangeMode style()
+    {
+        return RangeMode.AUTO;
+    }
+
+    @Alpha
+    @ConfigItem(
+            keyName = "borderColor",
+            name = "Line color",
+            description = "Color of the attack-range outline.",
+            position = 1
+    )
+    default Color borderColor()
+    {
+        return Color.WHITE;
+    }
+
+    @ConfigItem(
+            keyName = "showFill",
+            name = "Fill area",
+            description = "Shade the tiles inside your attack range. Note: the fill is repainted every frame and costs FPS at large ranges (e.g. magic). Leave off for the cheapest outline-only overlay.",
+            position = 2
+    )
+    default boolean showFill()
+    {
+        return false;
+    }
+
+    @Alpha
+    @ConfigItem(
+            keyName = "fillColor",
+            name = "Fill color",
+            description = "Color and opacity of the shaded area (used only when Fill area is on).",
+            position = 3
+    )
+    default Color fillColor()
+    {
+        return new Color(0, 0, 0, 35);
+    }
+
+    @ConfigItem(
+            keyName = "displayMode",
+            name = "Show overlay",
+            description = "When to show the overlay. 'In PvP areas' covers the Wilderness, PvP/Deadman worlds, and PvP-flagged zones.",
+            position = 4
+    )
+    default DisplayMode displayMode()
+    {
+        return DisplayMode.ALWAYS;
+    }
+
+    @ConfigItem(
+            keyName = "showOpponent",
+            name = "Show target's range",
+            description = "Also outline the attack range of the player you are fighting. Their exact style is not knowable, so this is their weapon's base reach.",
+            position = 5
+    )
+    default boolean showOpponent()
+    {
+        return false;
+    }
+
+    @Alpha
+    @ConfigItem(
+            keyName = "opponentColor",
+            name = "Target line color",
+            description = "Outline color for your target's range.",
+            position = 6
+    )
+    default Color opponentColor()
+    {
+        return new Color(255, 64, 64);
+    }
+}