Merge pull request #165 from runejs/walkpath-debug

feat: create `walkpath` debug command

Author: Promises

src/main/java/org/runejs/client/Main.java

@@ -4,6 +4,7 @@
 import org.runejs.client.cache.CacheArchive;
 import org.runejs.client.cache.CacheFileChannel;
 import org.runejs.client.frame.ChatBox;
+import org.runejs.client.frame.DebugTools;
 import org.runejs.client.frame.ScreenController;
 import org.runejs.client.frame.ScreenMode;
 import org.runejs.client.frame.console.Console;
@@ -872,6 +873,8 @@ public static void method353() {
         ((Class35) Rasterizer3D.interface3).animateTextures(MovedStatics.anInt199);
         KeyFocusListener.draw3dScreen();
 
+        DebugTools.drawWalkPath();
+
         if(ScreenController.frameMode == ScreenMode.FIXED) {
             Console.console.drawConsole(512, 334);
             Console.console.drawConsoleArea(512, 334);

src/main/java/org/runejs/client/SpotAnim.java

@@ -2,6 +2,7 @@
 
 import org.runejs.client.cache.media.AnimationSequence;
 import org.runejs.client.cache.def.SpotAnimDefinition;
+import org.runejs.client.frame.DebugTools;
 import org.runejs.client.media.VertexNormal;
 import org.runejs.client.media.renderable.Model;
 import org.runejs.client.media.renderable.Renderable;
@@ -59,8 +60,12 @@ else if(lightness > 126)
     }
 
     public static void renderPlayers(int arg0, boolean arg1) {
-        if(Player.localPlayer.worldX >> 7 == MovedStatics.destinationX && Player.localPlayer.worldY >> 7 == Class55.destinationY)
+        if(Player.localPlayer.worldX >> 7 == MovedStatics.destinationX && Player.localPlayer.worldY >> 7 == Class55.destinationY) {
             MovedStatics.destinationX = 0;
+
+            DebugTools.walkpathX = null;
+            DebugTools.walkpathY = null;
+        }
         int i = Player.localPlayerCount;
         if(arg1)
             i = 1;

src/main/java/org/runejs/client/frame/DebugTools.java

@@ -0,0 +1,47 @@
+package org.runejs.client.frame;
+
+import org.runejs.client.MovedStatics;
+import org.runejs.client.media.Rasterizer;
+import org.runejs.client.scene.Point2d;
+
+public class DebugTools {
+    public static boolean walkpathEnabled = false;
+    public static int[] walkpathX = null;
+    public static int[] walkpathY = null;
+
+    public static void drawWalkPath() {
+        if (!walkpathEnabled || walkpathX == null) {
+            return;
+        }
+
+        int lastTileX = walkpathX[0];
+        int lastTileY = walkpathY[0];
+
+        Point2d pathStartPos = MovedStatics.getProjectedScreenPosition(10, lastTileY * 128 + 64, lastTileX * 128 + 64);
+        Point2d pathFinishPos = MovedStatics.getProjectedScreenPosition(10, walkpathY[walkpathY.length - 1] * 128 + 64, walkpathX[walkpathX.length - 1] * 128 + 64);
+
+        Point2d lastTilePos = pathStartPos;
+        for (int i = 1; i < walkpathX.length; i++) {
+            int tileX = walkpathX[i];
+            int tileY = walkpathY[i];
+
+            Point2d nextPos = MovedStatics.getProjectedScreenPosition(10, tileY * 128 + 64, tileX * 128 + 64);
+
+            if (lastTilePos != null && nextPos != null) {
+                Rasterizer.drawDiagonalLine(lastTilePos.x, lastTilePos.y, nextPos.x, nextPos.y, 0x00FFAC);
+            }
+
+            lastTileX = tileX;
+            lastTileY = tileY;
+            lastTilePos = nextPos;
+        }
+
+        if (pathStartPos != null) {
+            Rasterizer.drawCircle(pathStartPos.x, pathStartPos.y, 2, 0xE055DE);
+        }
+
+        if (pathFinishPos != null) {
+            Rasterizer.drawCircle(pathFinishPos.x, pathFinishPos.y, 4, 0xE055DE);
+        }
+    }
+}

src/main/java/org/runejs/client/frame/console/Commands/DebugWalkCommand.java

@@ -0,0 +1,21 @@
+package org.runejs.client.frame.console.Commands;
+
+import org.runejs.client.frame.DebugTools;
+import org.runejs.client.frame.console.Command;
+import org.runejs.client.frame.console.Console;
+
+public class DebugWalkCommand extends Command {
+    public DebugWalkCommand() {
+        super(new String[]{"debugwalk"}, "Toggles debug walkpath");
+    }
+
+    @Override
+    public void execute(Console console, String[] cmdInput) {
+        DebugTools.walkpathEnabled = !DebugTools.walkpathEnabled;
+        if(DebugTools.walkpathEnabled) {
+            console.log("<col=00FF00>Walkpath is now drawn</col>");
+        } else {
+            console.log("<col=FF0000>Walkpath is now hidden</col>");
+        }
+    }
+}

src/main/java/org/runejs/client/frame/console/Console.java

@@ -62,6 +62,7 @@ private void initialiseCommands() {
         commands.add(new ClearCommand());
         commands.add(new DebugCommand());
         commands.add(new DebugViewCommand());
+        commands.add(new DebugWalkCommand());
         commands.add(new DebugWidgetsCommand());
         commands.add(new EchoCommand());
         commands.add(new PlayerRightsCommand());

src/main/java/org/runejs/client/media/renderable/actor/Pathfinding.java

@@ -1,5 +1,6 @@
 package org.runejs.client.media.renderable.actor;
 
+import org.runejs.client.frame.DebugTools;
 import org.runejs.client.media.renderable.Item;
 import org.runejs.client.message.outbound.WalkOutboundMessage;
 import org.runejs.client.net.OutgoingPackets;
@@ -249,6 +250,16 @@ else if((waypoint & 0b1000) != 0)
             int x = walkingQueueX[currentIndex];
             int y = walkingQueueY[currentIndex];
 
+            if (DebugTools.walkpathEnabled) {
+                DebugTools.walkpathX = new int[maxPathSize + 1];
+                DebugTools.walkpathY = new int[maxPathSize + 1];
+
+                DebugTools.walkpathX[0] = startX;
+                DebugTools.walkpathY[0] = startY;
+                DebugTools.walkpathX[1] = x;
+                DebugTools.walkpathY[1] = y;
+            }
+
             WalkOutboundMessage.WalkType walkType = WalkOutboundMessage.WalkType.TILE;
 
             if(clickType == 0) {
@@ -267,6 +278,11 @@ else if(clickType == 2) {
                 int stepX = walkingQueueX[currentIndex] - x;
                 int stepY = walkingQueueY[currentIndex] - y;
 
+                if (DebugTools.walkpathEnabled) {
+                    DebugTools.walkpathX[counter + 1] = walkingQueueX[currentIndex];
+                    DebugTools.walkpathY[counter + 1] = walkingQueueY[currentIndex];
+                }
+
                 steps.add(new WalkOutboundMessage.WalkStep(stepX, stepY));
             }