Tutorial Understanding Runemate's Pathing Systems, and Utilizing Them

Why Pathing is Important:
Runemate's pathing systems are what allow bots to move between locations in-game. Any bot in the store that moves more than a screen distance away utilizes some sort of pathing.

Types of Paths available:
Bresenham Path: Builds a direct line between two points.

Region Path: Generates a path constricted to the currently loaded in-game region (104x104). The generated path is based on the regions collision flags (these detect you can't walk through, and some other things) to allow you to walk around obstacles such as buildings or trees.

Predefined Path: A path defined by you (the author), consisting of a set of coordinates that are traversed in order.

Viewport Path: A path that clicks on in-game tiles to walk. To create a viewport path, generate a Coordinate Path (AKA a Bresenham, Region, or Predefined path), and convert to viewport.

(Default) Webpath: Uses Runemate's default web to generate a path. This path can handle most obstacles such as doors and staircases, will utilize Normal/Lunar/Ancient teleports, jewelry teleports, spirit trees, and gnome gliders. Usage is recommended only when traversing past obstacles or over significant distances.

Advantages/Disadvantages of Paths:
Each of these examples is in the form of a TreeTask, which is the "Leaf" of a treebot.

Bresenham Path: Doesn't navigate around objects. Bresenham paths are best used in large open areas for basic walking. Reliable generation as long as no obstacles, such as doors, block the path generation.

Region Path: Paths go around objects, but cannot pass obstacles such as doors or agility shortcuts. Path will generate null if you try to walk to a different in-game region.

Predefined Path: Very reliable since the path is supplied by the author instead of generated, but restrictive and repetitive by nature. Usage is discouraged. Cannot traverse obstacles such as doors.

Viewport Path: Clicks on in-game tiles to walk, which allows for greater precision when you need to walk to a specific tile. Can be more human-like in certain situations.

(Default) Webpath: Can traverse obstacles such as doors, staircases, and ladders (Aka can move between in-game planes). Utilizes many teleports without significant implementation efforts by the authors. Has one disadvantage - If the webpath doesn't work properly, or doesn't generate, the author must rely on Runemate staff for the problem to be fixed.

Coding with Paths:
Bresenham Path:

Code (Text):

1. public class Walk extends LeafTask {
2.  
3.     private Coordinate destination = new Coordinate(3013, 5608, 0);
4.  
5.     @Override
6.     public void execute() {
7.         BresenhamPath bresPath = BresenhamPath.buildTo(destination);
8.         if(bresPath != null){
9.             bresPath.step();
10.         } else {
11.             getLogger().warn("bresPath was null in Walk");
12.         }
13.     }
14.  
15. }

Region Path:

Code (Text):

1. public class Walk extends LeafTask {
2.  
3.     private Coordinate destination = new Coordinate(3013, 5608, 0);
4.  
5.     @Override
6.     public void execute() {
7.         RegionPath regionPath = RegionPath.buildTo(destination);
8.         if(regionPath != null){
9.             regionPath.step();
10.         } else {
11.             getLogger().warn("regionPath was null in Walk");
12.         }
13.     }
14.  
15. }

Predefined Path:

Code (Text):

1. public class Walk extends LeafTask {
2.  
3.     private PredefinedPath predefined = PredefinedPath.create(new Coordinate(3016, 5627, 0), new Coordinate(3015, 5624, 0), new Coordinate(3015, 5622, 0),
4.             new Coordinate(3014, 5619, 0), new Coordinate(3013, 5616, 0), new Coordinate(3013, 5613, 0), new Coordinate(3013, 5611, 0),
5.             new Coordinate(3013, 5608, 0));
6.  
7.     @Override
8.     public void execute() {
9.         if(predefined != null){
10.             predefined.step();
11.         } else {
12.             getLogger().warn("predefined was null in Walk");
13.         }
14.     }
15.  
16. }

Viewport Path:

Code (Text):

1. public class Walk extends LeafTask {
2.  
3.     private PredefinedPath predefined = PredefinedPath.create(new Coordinate(3016, 5627, 0), new Coordinate(3015, 5624, 0), new Coordinate(3015, 5622, 0),
4.             new Coordinate(3014, 5619, 0), new Coordinate(3013, 5616, 0), new Coordinate(3013, 5613, 0), new Coordinate(3013, 5611, 0),
5.             new Coordinate(3013, 5608, 0));
6.  
7.     @Override
8.     public void execute() {
9.         if(predefined != null){
10.             ViewportPath viewport = ViewportPath.convert(predefined);
11.             //viewport won't ever be null, so no need to null check it
12.             Coordinate nextStep = viewport.getNext();
13.             if(nextStep != null){
14.                 if(nextStep.isVisible()){
15.                     viewport.step();
16.                 } else {
17.                     Camera.concurrentlyTurnTo(nextStep);
18.                 }
19.             } else {
20.                 getLogger().warn("Could not get next step of viewport");
21.             }
22.         } else {
23.             getLogger().warn("predefined was null in Walk");
24.         }
25.     }
26.  
27. }

(Default) Webpath:

Code (Text):

1. public class Walk extends LeafTask {
2.  
3.     private Coordinate destination = new Coordinate(3013, 5608, 0);
4.  
5.     @Override
6.     public void execute() {
7.         WebPath webPath = Traversal.getDefaultWeb().getPathBuilder().buildTo(destination);
8.         if(webPath != null){
9.             webPath.step();
10.         } else {
11.             getLogger().warn("Could not generate webPath in Walk");
12.         }
13.     }
14.  
15. }

An Extra: TraversalOptions
All types of paths can also take an argument of Traversal Options when calling .step()

Traversal options as of 12/25/2017 are:
MANAGE_DISTANCE_BETWEEN_STEPS
MANAGE_RUN (turning it on if it runs out and re-generates)
MANAGE_STAMINA_ENHANCERS (stamina potions, terrorbird scrolls, etc)

All types of paths default to managing these things if not specified by the author. They can all be disabled using .step(false), or individually enabled using .step(TraversalOptions you want to enable).

Code (Text):

1. public class Walk extends LeafTask {
2.  
3.     @Override
4.     public void execute() {
5.         WebPath webPath = Traversal.getDefaultWeb().getPathBuilder().buildTo(new Coordinate(3013, 5608, 0));
6.         if(webPath != null){
7.             webPath.step(Path.TraversalOption.MANAGE_DISTANCE_BETWEEN_STEPS, Path.TraversalOption.MANAGE_RUN);
8.         } else {
9.             getLogger().warn("Could not generate webPath in Walk");
10.         }
11.     }
12.  
13. }

 

• Viewport is a converted Predefined, bres, or region path, and these paths do not handle obstacles. By extension, viewport does not.
• BasicObjectVertex is part of making a web, not part of traditional pathing. Walk near the door, interact with it normally, and then path again.
• Camera is irrelevant for Coordinate paths (Bres, region, predefined) since they use the minimap. Viewport has an example in the guide.

 

Web paths can traverse obstacles all on their own.

 

You can do that if you or users are having trouble with the speed of the web pathing, but you may encounter scenarios where it will get stuck endlessly traversing an obstacle back and forth if you don't regenerate after the obstacle.