Merge pull request #1577 from nrodrigues0213/hunting-salamander-fix

Hunter Plugin: Fix salamander net display (Fixed)

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

@@ -25,6 +25,7 @@
 package net.runelite.api;
 
 import java.awt.Polygon;
+import net.runelite.api.coords.Angle;
 
 /**
  *
@@ -32,8 +33,6 @@ import java.awt.Polygon;
  */
 public interface GameObject extends TileObject
 {
-	int getFlags();
-
 	/**
 	 * Returns the min x,y for this game object
 	 *
@@ -50,4 +49,6 @@ public interface GameObject extends TileObject
 	Point getRegionMaxLocation();
 
 	Polygon getConvexHull();
+
+	Angle getOrientation();
 }

runelite-api/src/main/java/net/runelite/api/coords/Angle.java

@@ -0,0 +1,69 @@
+/*
+ * 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.api.coords;
+
+import lombok.Value;
+import static net.runelite.api.coords.Direction.EAST;
+import static net.runelite.api.coords.Direction.NORTH;
+import static net.runelite.api.coords.Direction.SOUTH;
+import static net.runelite.api.coords.Direction.WEST;
+
+@Value
+public class Angle
+{
+	/**
+	 * angle, 0-2047.
+	 * 0 is south, west is 512, south is 1024, east is 1536s
+	 */
+	private final int angle;
+
+	/**
+	 * Get the nearest N/S/E/W direction for this angle
+	 * @return
+	 */
+	public Direction getNearestDirection()
+	{
+		int round = angle >>> 9;
+		int up = angle & 256;
+		if (up != 0)
+		{
+			// round up
+			++round;
+		}
+		switch (round & 3)
+		{
+			case 0:
+				return SOUTH;
+			case 1:
+				return WEST;
+			case 2:
+				return NORTH;
+			case 3:
+				return EAST;
+			default:
+				throw new IllegalStateException();
+		}
+	}
+}

runelite-api/src/main/java/net/runelite/api/coords/Direction.java

@@ -0,0 +1,33 @@
+/*
+ * 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.api.coords;
+
+public enum Direction
+{
+	NORTH,
+	SOUTH,
+	EAST,
+	WEST;
+}

runelite-api/src/main/java/net/runelite/api/coords/WorldPoint.java

@@ -53,6 +53,36 @@ public class WorldPoint
 	 */
 	private final int plane;
 
+	/**
+	 * Returns a WorldPoint offset on x from this point
+	 * @param dx offset
+	 * @return
+	 */
+	public WorldPoint dx(int dx)
+	{
+		return new WorldPoint(x + dx, y, plane);
+	}
+
+	/**
+	 * Returns a WorldPoint offset on y from this point
+	 * @param dy offset
+	 * @return
+	 */
+	public WorldPoint dy(int dy)
+	{
+		return new WorldPoint(x, y + dy, plane);
+	}
+
+	/**
+	 * Returns a WorldPoint offset on z from this point
+	 * @param dz offset
+	 * @return
+	 */
+	public WorldPoint dz(int dz)
+	{
+		return new WorldPoint(x, y, plane + dz);
+	}
+
 	public static boolean isInScene(Client client, int x, int y)
 	{
 		int baseX = client.getBaseX();

runelite-api/src/test/java/net/runelite/api/coords/AngleTest.java

@@ -0,0 +1,44 @@
+/*
+ * 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.api.coords;
+
+import static net.runelite.api.coords.Direction.NORTH;
+import static net.runelite.api.coords.Direction.WEST;
+import static org.junit.Assert.assertEquals;
+import org.junit.Test;
+
+public class AngleTest
+{
+
+	@Test
+	public void getNearestDirection()
+	{
+		Angle angle = new Angle(512 + 10);
+		assertEquals(WEST, angle.getNearestDirection());
+
+		angle = new Angle(512 + 256 + 1);
+		assertEquals(NORTH, angle.getNearestDirection());
+	}
+}

runelite-client/src/main/java/net/runelite/client/plugins/hunter/HunterPlugin.java

@@ -38,6 +38,7 @@ import net.runelite.api.GameObject;
 import net.runelite.api.ObjectID;
 import net.runelite.api.Player;
 import net.runelite.api.Tile;
+import net.runelite.api.coords.Direction;
 import net.runelite.api.coords.LocalPoint;
 import net.runelite.api.coords.WorldPoint;
 import net.runelite.api.events.ConfigChanged;
@@ -102,7 +103,8 @@ public class HunterPlugin extends Plugin
 	public void onGameObjectSpawned(GameObjectSpawned event)
 	{
 		final GameObject gameObject = event.getGameObject();
-		final HunterTrap myTrap = traps.get(gameObject.getWorldLocation());
+		final WorldPoint trapLocation = gameObject.getWorldLocation();
+		final HunterTrap myTrap = traps.get(trapLocation);
 		final Player localPlayer = client.getLocalPlayer();
 
 		switch (gameObject.getId())
@@ -115,34 +117,58 @@ public class HunterPlugin extends Plugin
 			case ObjectID.DEADFALL: // Deadfall trap placed
 			case ObjectID.MONKEY_TRAP: // Maniacal monkey trap placed
 				// If player is right next to "object" trap assume that player placed the trap
-				if (localPlayer.getWorldLocation().distanceTo(gameObject.getWorldLocation()) <= 1)
+				if (localPlayer.getWorldLocation().distanceTo(trapLocation) <= 1)
 				{
-					log.debug("Trap placed by \"{}\" on {}", localPlayer.getName(), gameObject.getWorldLocation());
+					log.debug("Trap placed by \"{}\" on {}", localPlayer.getName(), trapLocation);
-					traps.put(gameObject.getWorldLocation(), new HunterTrap(gameObject));
+					traps.put(trapLocation, new HunterTrap(gameObject));
 					lastActionTime = Instant.now();
 				}
-
 				break;
+
 			case ObjectID.MAGIC_BOX: // Imp box placed
 			case ObjectID.BOX_TRAP_9380: // Box trap placed
 			case ObjectID.BIRD_SNARE_9345: // Bird snare placed
-			case ObjectID.NET_TRAP_9343: // Net trap placed at green sallys
-			case ObjectID.NET_TRAP: // Net trap placed at orange sallys
-			case ObjectID.NET_TRAP_8992: // Net trap placed at red sallys
-			case ObjectID.NET_TRAP_9002: // Net trap placed at black sallys
 				// If the player is on that tile, assume he is the one that placed the trap
 				// Note that a player can move and set up a trap in the same tick, and this
 				// event runs after the player movement has been updated, so we need to
 				// compare to the trap location to the last location of the player.
 				if (lastTickLocalPlayerLocation != null
-					&& gameObject.getWorldLocation().distanceTo(lastTickLocalPlayerLocation) == 0)
+					&& trapLocation.distanceTo(lastTickLocalPlayerLocation) == 0)
 				{
 					log.debug("Trap placed by \"{}\" on {}", localPlayer.getName(), localPlayer.getWorldLocation());
-					traps.put(gameObject.getWorldLocation(), new HunterTrap(gameObject));
+					traps.put(trapLocation, new HunterTrap(gameObject));
 					lastActionTime = Instant.now();
 				}
-
 				break;
+
+			case ObjectID.NET_TRAP_9343: // Net trap placed at green sallys
+			case ObjectID.NET_TRAP: // Net trap placed at orange sallys
+			case ObjectID.NET_TRAP_8992: // Net trap placed at red sallys
+			case ObjectID.NET_TRAP_9002: // Net trap placed at black sallys
+				if (lastTickLocalPlayerLocation != null
+						&& trapLocation.distanceTo(lastTickLocalPlayerLocation) == 0)
+				{
+					// Net traps facing to the north and east must have their tile translated.
+					// As otherwise, the wrong tile is stored.
+					Direction trapOrientation = gameObject.getOrientation().getNearestDirection();
+					WorldPoint translatedTrapLocation = trapLocation;
+
+					switch (trapOrientation)
+					{
+						case NORTH:
+							translatedTrapLocation = trapLocation.dy(1);
+							break;
+						case EAST:
+							translatedTrapLocation = trapLocation.dx(1);
+							break;
+					}
+
+					log.debug("Trap placed by \"{}\" on {}", localPlayer.getName(), translatedTrapLocation);
+					traps.put(translatedTrapLocation, new HunterTrap(gameObject));
+					lastActionTime = Instant.now();
+				}
+				break;
+
 			/*
 			 * ------------------------------------------------------------------------------
 			 * Catching stuff
@@ -298,6 +324,7 @@ public class HunterPlugin extends Plugin
 
 			boolean containsBoulder = false;
 			boolean containsAnything = false;
+			boolean containsYoungTree = false;
 			for (GameObject object : objects)
 			{
 				if (object != null)
@@ -308,10 +335,18 @@ public class HunterPlugin extends Plugin
 						containsBoulder = true;
 						break;
 					}
+
+					// Check for young trees (used while catching salamanders) in the tile.
+					// Otherwise, hunter timers will never disappear after a trap is dismantled
+					if (object.getId() == ObjectID.YOUNG_TREE_8732 || object.getId() == ObjectID.YOUNG_TREE_8990 ||
+						object.getId() == ObjectID.YOUNG_TREE_9000 || object.getId() == ObjectID.YOUNG_TREE_9341)
+					{
+						containsYoungTree = true;
+					}
 				}
 			}
 
-			if (!containsAnything)
+			if (!containsAnything || containsYoungTree)
 			{
 				it.remove();
 				log.debug("Trap removed from personal trap collection, {} left", traps.size());

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

@@ -28,6 +28,7 @@ import java.awt.Polygon;
 import java.awt.geom.Area;
 import net.runelite.api.Perspective;
 import net.runelite.api.Point;
+import net.runelite.api.coords.Angle;
 import net.runelite.api.mixins.Inject;
 import net.runelite.api.mixins.Mixin;
 import net.runelite.api.mixins.Shadow;
@@ -79,7 +80,7 @@ public abstract class RSGameObjectMixin implements RSGameObject
 	@Override
 	public Area getClickbox()
 	{
-		return Perspective.getClickbox(client, getModel(), getOrientation(), getX(), getY());
+		return Perspective.getClickbox(client, getModel(), getRsOrientation(), getX(), getY());
 	}
 
 	@Inject
@@ -93,6 +94,15 @@ public abstract class RSGameObjectMixin implements RSGameObject
 			return null;
 		}
 
-		return model.getConvexHull(getX(), getY(), getOrientation());
+		return model.getConvexHull(getX(), getY(), getRsOrientation());
+	}
+
+	@Override
+	@Inject
+	public Angle getOrientation()
+	{
+		int orientation = getRsOrientation();
+		int rotation = (getFlags() >> 6) & 3;
+		return new Angle(rotation * 512 + orientation);
 	}
 }

runescape-api/src/main/java/net/runelite/rs/api/RSGameObject.java

@@ -59,13 +59,12 @@ public interface RSGameObject extends GameObject
 	int getHeight();
 
 	@Import("orientation")
-	int getOrientation();
+	int getRsOrientation();
 
 	@Import("hash")
 	@Override
 	int getHash();
 
-	@Override
 	@Import("flags")
 	int getFlags();
 }