simple.hooks.simplebot

Class Pathing

java.lang.Object

simple.hooks.simplebot.Pathing

public class Pathing
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Pathing(ClientContext ctx)

Method Summary

Modifier and Type	Method and Description
boolean	clickSceneTile(net.runelite.api.coords.WorldPoint worldPoint, boolean rightClick, boolean turnTo) Will attempt to walk to a tile in-game by clicking on it and not via the minimap
double	collisionDistance(SimpleLocatable locatable) Will return the collision collisionDistance to said locatable from players location
int	collisionDistance(SimpleLocatable locatable1, SimpleLocatable locatable2)
double	collisionDistance(net.runelite.api.coords.WorldPoint locTo) Will return the collision collisionDistance to said point {locTo} from players location
int	collisionDistance(net.runelite.api.coords.WorldPoint w1, net.runelite.api.coords.WorldPoint w2)
WorldArea	createArea(net.runelite.api.coords.WorldPoint... points) Returns a new worldarea created from an array of points in a polygonal style
WorldArea	createArea(net.runelite.api.coords.WorldPoint point1, net.runelite.api.coords.WorldPoint point2) Returns a new worldarea created from 2 points in a rectangular style
net.runelite.api.coords.WorldPoint[]	createLocalPath(net.runelite.api.coords.WorldPoint point) will create a path from your tile to the specified tile using path finding, if a path can't be created an empty array WorldPoint[] will be returned
net.runelite.api.coords.WorldPoint	destination() will return if your client has a destination that its walking to otherwise it will return {null}
double	distanceTo(net.runelite.api.coords.WorldPoint to)
double	distanceTo(net.runelite.api.coords.WorldPoint from, net.runelite.api.coords.WorldPoint to)
double	distanceTo2D(net.runelite.api.coords.WorldPoint to)
double	distanceTo2D(net.runelite.api.coords.WorldPoint from, net.runelite.api.coords.WorldPoint to)
int	energyLevel() will return how much run energy you have
net.runelite.api.Point	getMinimapPointForCoord(int x, int y) will return the canvas location in the minimap for the x,y param
boolean	inArea(int fromX, int fromY, int toX, int toY)
boolean	inArea(WorldArea area) Will return {true} if the local player is inside of {area}, false otherwise
boolean	inArea(WorldArea area, net.runelite.api.coords.WorldPoint point) Will return {true} if the {point} is inside of {area}, false otherwise
boolean	inMotion()
net.runelite.api.coords.WorldPoint	nextPathTile(net.runelite.api.coords.WorldPoint[] path) will return the next WorldPoint that should be walked to along your specified path.
boolean	onTile(SimpleLocatable locatable)
boolean	onTile(net.runelite.api.coords.WorldPoint point)
int	plane()
boolean	pointOnMap(net.runelite.api.coords.WorldPoint p)
boolean	reachable(SimpleLocatable locatable) will return {true} if the specified tile is not blocked and will return {false} if it is.
boolean	reachable(SimpleLocatable locatable1, SimpleLocatable locatable2) will return whether or not point1 can reach point2
boolean	reachable(net.runelite.api.coords.WorldPoint locTo) will return {true} if the specified tile is not blocked and will return {false} if it is.
boolean	reachable(net.runelite.api.coords.WorldPoint point1, net.runelite.api.coords.WorldPoint point2) will return whether or not point1 can reach point2
boolean	running() will return if you have run toggled on or off
boolean	running(boolean run) will attempt to toggle run on/off based on {toggleRun}.
boolean	step(int x, int y) will attempt to walk to the specified x,y coordinate.
boolean	step(net.runelite.api.coords.WorldPoint point) will attempt to walk to the specified point
boolean	walkPath(net.runelite.api.coords.WorldPoint[] path) will attempt to walk the specified path of tiles.
boolean	walkPath(net.runelite.api.coords.WorldPoint[] path, boolean reverse) will attempt to walk the specified path of tiles in reverse if specified true.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pathing

public Pathing(ClientContext ctx)

Method Detail

plane

public int plane()

createArea

public WorldArea createArea(net.runelite.api.coords.WorldPoint point1,
                            net.runelite.api.coords.WorldPoint point2)

Returns a new worldarea created from 2 points in a rectangular style

Parameters:

point1 -

point2 -

Returns:

createArea

public WorldArea createArea(net.runelite.api.coords.WorldPoint... points)

Returns a new worldarea created from an array of points in a polygonal style

Parameters:

points -

Returns:

inArea

public boolean inArea(WorldArea area)

Will return {true} if the local player is inside of {area}, false otherwise

Parameters:

area -

Returns:

inArea

public boolean inArea(WorldArea area,
                      net.runelite.api.coords.WorldPoint point)

Will return {true} if the {point} is inside of {area}, false otherwise

Parameters:

area -

Returns:

inArea

public boolean inArea(int fromX,
                      int fromY,
                      int toX,
                      int toY)

onTile

public boolean onTile(net.runelite.api.coords.WorldPoint point)

onTile

public boolean onTile(SimpleLocatable locatable)

getMinimapPointForCoord

public net.runelite.api.Point getMinimapPointForCoord(int x,
                                                      int y)

will return the canvas location in the minimap for the x,y param

Parameters:

x -

y -

Returns:

destination

public net.runelite.api.coords.WorldPoint destination()

will return if your client has a destination that its walking to otherwise it will return {null}

Returns:

running

public boolean running()

will return if you have run toggled on or off

Returns:

running

public boolean running(boolean run)

will attempt to toggle run on/off based on {toggleRun}. Will return type: {boolean} if the switch has been made to {toggleRun}

Parameters:

run -

Returns:

energyLevel

public int energyLevel()

will return how much run energy you have

Returns:

step

public boolean step(int x,
                    int y)

will attempt to walk to the specified x,y coordinate. Will use players current plane for Z axis

Parameters:

x -

y -

Returns:

step

public boolean step(net.runelite.api.coords.WorldPoint point)

will attempt to walk to the specified point

Parameters:

point -

Returns:

- if the point has been clicked on

distanceTo

public double distanceTo(net.runelite.api.coords.WorldPoint to)

distanceTo

public double distanceTo(net.runelite.api.coords.WorldPoint from,
                         net.runelite.api.coords.WorldPoint to)

distanceTo2D

public double distanceTo2D(net.runelite.api.coords.WorldPoint to)

distanceTo2D

public double distanceTo2D(net.runelite.api.coords.WorldPoint from,
                           net.runelite.api.coords.WorldPoint to)

collisionDistance

public double collisionDistance(net.runelite.api.coords.WorldPoint locTo)

Will return the collision collisionDistance to said point {locTo} from players location

Parameters:

locTo -

Returns:

collisionDistance

public double collisionDistance(SimpleLocatable locatable)

Will return the collision collisionDistance to said locatable from players location

Parameters:

locatable -

Returns:

reachable

public boolean reachable(SimpleLocatable locatable)

will return {true} if the specified tile is not blocked and will return {false} if it is. Meaning if your player can actually reach the tile or not. (Handles all collisions)

Parameters:

locatable -

Returns:

reachable

public boolean reachable(net.runelite.api.coords.WorldPoint locTo)

will return {true} if the specified tile is not blocked and will return {false} if it is. Meaning if your player can actually reach the tile or not. (Handles all collisions)

Parameters:

locTo -

Returns:

reachable

public boolean reachable(net.runelite.api.coords.WorldPoint point1,
                         net.runelite.api.coords.WorldPoint point2)

will return whether or not point1 can reach point2

Parameters:

point1 -

point2 -

Returns:

reachable

public boolean reachable(SimpleLocatable locatable1,
                         SimpleLocatable locatable2)

will return whether or not point1 can reach point2

Parameters:

locatable1 -

locatable2 -

Returns:

collisionDistance

public int collisionDistance(SimpleLocatable locatable1,
                             SimpleLocatable locatable2)

Parameters:

locatable1 -

locatable2 -

Returns:

collisionDistance

public int collisionDistance(net.runelite.api.coords.WorldPoint w1,
                             net.runelite.api.coords.WorldPoint w2)

Parameters:

w1 -

w2 -

Returns:

createLocalPath

public net.runelite.api.coords.WorldPoint[] createLocalPath(net.runelite.api.coords.WorldPoint point)

will create a path from your tile to the specified tile using path finding, if a path can't be created an empty array WorldPoint[] will be returned

Parameters:

point - the point to create a path to

Returns:

an array of WorldPoints a.k.a your path

walkPath

public boolean walkPath(net.runelite.api.coords.WorldPoint[] path)

will attempt to walk the specified path of tiles. It will handle all of clicking for you

Parameters:

path - - the tile path to walk

Returns:

- {true} if the next tile in the path has been clicked on, {false} otherwise

walkPath

public boolean walkPath(net.runelite.api.coords.WorldPoint[] path,
                        boolean reverse)

will attempt to walk the specified path of tiles in reverse if specified true.

Parameters:

path - - the tile path to walk

reverse - - if the path should be reversed

Returns:

- {true} if the next tile in the path has been clicked on, {false} otherwise

nextPathTile

public net.runelite.api.coords.WorldPoint nextPathTile(net.runelite.api.coords.WorldPoint[] path)

will return the next WorldPoint that should be walked to along your specified path. if there is no valid tile the first tile in the path will be returned

Parameters:

path - the path to search

Returns:

the next tile that should be walked to

pointOnMap

public boolean pointOnMap(net.runelite.api.coords.WorldPoint p)

clickSceneTile

public boolean clickSceneTile(net.runelite.api.coords.WorldPoint worldPoint,
                              boolean rightClick,
                              boolean turnTo)

Will attempt to walk to a tile in-game by clicking on it and not via the minimap

Parameters:

worldPoint - - World tile to right click walk-here to

rightClick - whether or not the bot should right click walk to the tile or left click walk if rightClick=false

turnTo - if the bot should use the camera to turn to the tile if it is not currently in the viewport/visible

Returns:

returns if the tile has been clicked on or not

inMotion

public boolean inMotion()