SimplePathing

java.lang.Object
- simple.api.ClientAccessor<ClientContext>
- - simple.api.SimplePathing

public class SimplePathing
extends ClientAccessor<ClientContext>

Created by Seth on Apr 11, 2021 at 6:00:37 PM

Author:: Seth Davis

Field Summary
- Fields inherited from class simple.api.ClientAccessor
  ctx

Constructor Summary

Constructors
Constructor and Description

SimplePathing(ClientContext ctx)

Constructors
Constructor and Description
`SimplePathing(ClientContext ctx)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`collisionDistance(SimpleLocatable locatable)` Will return the collision collisionDistance to said locatable from players location
`int`	`collisionDistance(SimpleLocatable locatable1, SimpleLocatable locatable2)`
`double`	`collisionDistance(WorldPoint locTo)` Will return the collision collisionDistance to said point {locTo} from players location
`int`	`collisionDistance(WorldPoint w1, WorldPoint w2, boolean isObject)`
`WorldArea`	`createArea(WorldPoint... points)` Returns a new worldarea created from an array of points in a polygonal style
`WorldArea`	`createArea(WorldPoint point1, WorldPoint point2)` Returns a new worldarea created from 2 points in a rectangular style
`WorldPoint`	`destination()` will return if your client has a destination that its walking to otherwise it will return {null}
`double`	`distanceTo(SimpleLocatable to)`
`double`	`distanceTo(WorldPoint to)`
`double`	`distanceTo(WorldPoint from, WorldPoint to)`
`double`	`distanceTo2D(WorldPoint to)`
`double`	`distanceTo2D(WorldPoint from, WorldPoint to)`
`int`	`energyLevel()` will return how much run energy you have
`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, WorldPoint point)` Will return {true} if the {point} is inside of {area}, false otherwise
`boolean`	`inMotion()`
`WorldPoint`	`nextPathTile(WorldPoint[] path)` will return the next WorldPoint that should be walked to along your specified path.
`boolean`	`onTile(SimpleLocatable locatable)`
`boolean`	`onTile(WorldPoint point)`
`int`	`plane()`
`boolean`	`pointOnMap(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(WorldPoint locTo)` will return {true} if the specified tile is not blocked and will return {false} if it is.
`boolean`	`reachable(WorldPoint point1, 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`	`staminaActive()`
`boolean`	`step(int x, int y)` will attempt to walk to the specified x,y coordinate.
`boolean`	`step(SimpleLocatable to)` will attempt to walk to the specified point
`boolean`	`step(WorldPoint to)` will attempt to walk to the specified point
`boolean`	`walkPath(WorldPoint[] path)` will attempt to walk the specified path of tiles.
`boolean`	`walkPath(WorldPoint[] path, boolean reverse)` will attempt to walk the specified path of tiles in reverse if specified true.
`boolean`	`walkToTile(WorldPoint to)` will attempt to walk to the specified point

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SimplePathing
```
public SimplePathing(ClientContext ctx)
```
    Parameters:
    
    ctx -
- Method Detail
  - plane
```
public int plane()
```
  - createArea
```
public WorldArea createArea(WorldPoint point1,
                            WorldPoint point2)
```
    Returns a new worldarea created from 2 points in a rectangular style
    
    Parameters:
    
    point1 -
    
    point2 -
    
    Returns:
  - createArea
```
public WorldArea createArea(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,
                      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(WorldPoint point)
```
  - onTile
```
public boolean onTile(SimpleLocatable locatable)
```
  - destination
```
public 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:
  - staminaActive
```
public boolean staminaActive()
```
  - 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(SimpleLocatable to)
```
    will attempt to walk to the specified point
    
    Parameters:
    
    to -
    
    Returns:
    
    - if the point has been clicked on
  - step
```
public boolean step(WorldPoint to)
```
    will attempt to walk to the specified point
    
    Parameters:
    
    to -
    
    Returns:
    
    - if the point has been clicked on
  - walkToTile
```
public boolean walkToTile(WorldPoint to)
```
    will attempt to walk to the specified point
    
    Parameters:
    
    to -
    
    Returns:
    
    - if the point has been clicked on
  - distanceTo
```
public double distanceTo(WorldPoint to)
```
  - distanceTo
```
public double distanceTo(SimpleLocatable to)
```
  - distanceTo
```
public double distanceTo(WorldPoint from,
                         WorldPoint to)
```
  - distanceTo2D
```
public double distanceTo2D(WorldPoint to)
```
  - distanceTo2D
```
public double distanceTo2D(WorldPoint from,
                           WorldPoint to)
```
  - collisionDistance
```
public double collisionDistance(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(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(WorldPoint point1,
                         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(WorldPoint w1,
                             WorldPoint w2,
                             boolean isObject)
```
    Parameters:
    
    w1 -
    
    w2 -
    
    Returns:
  - walkPath
```
public boolean walkPath(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(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 WorldPoint nextPathTile(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(WorldPoint p)
```
  - inMotion
```
public boolean inMotion()
```

Class SimplePathing

Field Summary

Fields inherited from class simple.api.ClientAccessor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SimplePathing

Method Detail

plane

createArea

createArea

inArea

inArea

inArea

onTile

onTile

destination

running

staminaActive

running

energyLevel

step

step

step

walkToTile

distanceTo

distanceTo

distanceTo

distanceTo2D

distanceTo2D

collisionDistance

collisionDistance

reachable

reachable

reachable

reachable

collisionDistance

collisionDistance

walkPath

walkPath

nextPathTile

pointOnMap

inMotion