Index

A B C D E F G H I J L M N O P S T V W 
All Classes and Interfaces|All Packages

A

accept(T) - Method in interface org.patheloper.api.util.ParameterizedSupplier
 
add(double, double, double) - Method in class org.patheloper.api.wrapper.PathPosition
Adds x,y,z values to the current values
add(PathVector) - Method in class org.patheloper.api.wrapper.PathPosition
Adds the values of a vector to the position
add(PathVector) - Method in class org.patheloper.api.wrapper.PathVector
Adds two vectors together
areBlocksAbovePassable(PathPosition, SnapshotManager) - Method in class org.patheloper.api.pathing.strategy.strategies.WalkablePathfinderStrategy
 

B

BlockInformation - Class in org.patheloper.api.wrapper
 
BlockInformation() - Constructor for class org.patheloper.api.wrapper.BlockInformation
 
BoatStrategy - Class in org.patheloper.api.pathing.strategy.strategies
 
BoatStrategy() - Constructor for class org.patheloper.api.pathing.strategy.strategies.BoatStrategy
 

C

canStandOn(PathBlock, SnapshotManager) - Method in class org.patheloper.api.pathing.strategy.strategies.WalkablePathfinderStrategy
 
cleanup() - Method in interface org.patheloper.api.pathing.strategy.PathfinderStrategy
Cleans up the resources used during the pathfinding process.
clone() - Method in class org.patheloper.api.wrapper.PathPosition
 
clone() - Method in class org.patheloper.api.wrapper.PathVector
 
computeDistance(PathVector, PathVector, PathVector) - Static method in class org.patheloper.api.wrapper.PathVector
Finds the distance between the line BC and the point A
createAsyncRuleSet() - Static method in class org.patheloper.api.pathing.configuration.PathingRuleSet
 
createRuleSet() - Static method in class org.patheloper.api.pathing.configuration.PathingRuleSet
 

D

deepCopy(PathingRuleSet) - Static method in class org.patheloper.api.pathing.configuration.PathingRuleSet
Creates a deep copy of the given PathingRuleSet.
DIRECT_PATH_WEIGHTS - Static variable in class org.patheloper.api.pathing.configuration.HeuristicWeights
Provides a set of weights strongly prioritizing the shortest direct path, even if diagonally.
DirectPathfinderStrategy - Class in org.patheloper.api.pathing.strategy.strategies
A PathfinderStrategy to find the direct path to a given endpoint
DirectPathfinderStrategy() - Constructor for class org.patheloper.api.pathing.strategy.strategies.DirectPathfinderStrategy
 
distance(PathPosition) - Method in class org.patheloper.api.wrapper.PathPosition
Gets the distance between the current and another position
distance(PathVector) - Method in class org.patheloper.api.wrapper.PathVector
Gets the distance between this vector and another vector
distanceSquared(PathPosition) - Method in class org.patheloper.api.wrapper.PathPosition
Gets the distance squared between the current and another position
divide(double) - Method in class org.patheloper.api.wrapper.PathVector
Divide the vector by a scalar constant
dot(PathVector) - Method in class org.patheloper.api.wrapper.PathVector
Calculates the dot product of two vectors

E

equals(Object) - Method in class org.patheloper.api.wrapper.PathEnvironment
 
equals(Object) - Method in class org.patheloper.api.wrapper.PathPosition
 
Experimental - Annotation Type in org.patheloper.api.annotation
Marks an API as experimental.

F

FAILED - Enum constant in enum org.patheloper.api.pathing.result.PathState
The Path wasn't found, either it reached its max search depth or it couldn't find more positions
FALLBACK - Enum constant in enum org.patheloper.api.pathing.result.PathState
Signifies that the pathfinder fell back during the pathfinding attempt
findPath(PathPosition, PathPosition, PathfinderStrategy) - Method in interface org.patheloper.api.pathing.Pathfinder
Tries to find a Path between the two PathPosition's provided with the given strategy.
floor() - Method in class org.patheloper.api.wrapper.PathPosition
Rounds the x,y,z values to the floor of the values
FOUND - Enum constant in enum org.patheloper.api.pathing.result.PathState
The Path was successfully found for a given strategy

G

getBlock(PathPosition) - Method in interface org.patheloper.api.snapshot.SnapshotManager
Gets the block at the given position
getBlockState(ChunkSnapshot, int, int, int) - Method in interface org.patheloper.api.snapshot.NMSInterface
Get the block state from a chunk snapshot at the given coordinates
getBlockX() - Method in class org.patheloper.api.wrapper.PathBlock
Gets the X coordinate of the block
getBlockX() - Method in class org.patheloper.api.wrapper.PathPosition
Gets the X coordinate of the block the position is in
getBlockY() - Method in class org.patheloper.api.wrapper.PathBlock
Gets the Y coordinate of the block
getBlockY() - Method in class org.patheloper.api.wrapper.PathPosition
Gets the Y coordinate of the block the position is in
getBlockZ() - Method in class org.patheloper.api.wrapper.PathBlock
Gets the Z coordinate of the block
getBlockZ() - Method in class org.patheloper.api.wrapper.PathPosition
Gets the Z coordinate of the block the position is in
getCrossProduct(PathVector) - Method in class org.patheloper.api.wrapper.PathVector
Calculates the cross product of two vectors
getEnd() - Method in interface org.patheloper.api.pathing.result.Path
Returns the target position of the path
getHandlerList() - Static method in class org.patheloper.api.event.PathingEvent
 
getHandlers() - Method in class org.patheloper.api.event.PathingEvent
 
getPath() - Method in interface org.patheloper.api.pathing.result.PathfinderResult
Returns the found Path regardless if successful or not.
getPathfinderResult() - Method in class org.patheloper.api.event.PathingFinishedEvent
 
getPathState() - Method in interface org.patheloper.api.pathing.result.PathfinderResult
Returns the state of the pathfinding.
getSnapshot(World, int, int) - Method in interface org.patheloper.api.snapshot.NMSInterface
Returns a ChunkSnapshot of the chunk at the given coordinates.
getStart() - Method in interface org.patheloper.api.pathing.result.Path
Returns the start position of the path
getX() - Method in class org.patheloper.api.wrapper.PathVector
Gets the x component of the vector
getY() - Method in class org.patheloper.api.wrapper.PathVector
Gets the y component of the vector
getZ() - Method in class org.patheloper.api.wrapper.PathVector
Gets the z component of the vector

H

hasFailed() - Method in interface org.patheloper.api.pathing.result.PathfinderResult
Whether the pathfinder has failed to reach its target.
hasFallenBack() - Method in interface org.patheloper.api.pathing.result.PathfinderResult
Whether a pathfinder has resulted in a fallback.
hashCode() - Method in class org.patheloper.api.wrapper.PathEnvironment
 
hashCode() - Method in class org.patheloper.api.wrapper.PathPosition
 
HeuristicWeights - Class in org.patheloper.api.pathing.configuration
Represents a set of weights used to calculate a heuristic for the A* pathfinding algorithm.
HeuristicWeights() - Constructor for class org.patheloper.api.pathing.configuration.HeuristicWeights
 

I

interpolate(double) - Method in interface org.patheloper.api.pathing.result.Path
Interpolates the positions of this Path to a new Path with the given resolution.
interpolate(double, double, double) - Static method in class org.patheloper.api.util.NumberUtils
 
interpolate(PathPosition, double) - Method in class org.patheloper.api.wrapper.PathPosition
 
isAir() - Method in class org.patheloper.api.wrapper.PathBlock
 
isCancelled() - Method in class org.patheloper.api.event.PathingStartFindEvent
 
isInSameBlock(PathPosition) - Method in class org.patheloper.api.wrapper.PathPosition
Checks to see if the two positions are in the same block
isPassable() - Method in class org.patheloper.api.wrapper.PathBlock
 
isSolid() - Method in class org.patheloper.api.wrapper.PathBlock
 
isValid(PathValidationContext) - Method in interface org.patheloper.api.pathing.strategy.PathfinderStrategy
Returns whether the given PathPosition is valid.
isValid(PathValidationContext) - Method in class org.patheloper.api.pathing.strategy.strategies.DirectPathfinderStrategy
 
isValid(PathValidationContext) - Method in class org.patheloper.api.pathing.strategy.strategies.JumpablePathfinderStrategy
 
isValid(PathValidationContext) - Method in class org.patheloper.api.pathing.strategy.strategies.WalkablePathfinderStrategy
 
isValid(PathValidationContext) - Method in class org.patheloper.api.pathing.strategy.strategies.BoatStrategy
 
isValid(PathValidationContext) - Method in class org.patheloper.api.pathing.strategy.strategies.PlayerWalkableStrategy
 

J

join(Path) - Method in interface org.patheloper.api.pathing.result.Path
Joins this Path with the given Path.
JumpablePathfinderStrategy - Class in org.patheloper.api.pathing.strategy.strategies
A WalkablePathfinderStrategy that allows jumping.
JumpablePathfinderStrategy() - Constructor for class org.patheloper.api.pathing.strategy.strategies.JumpablePathfinderStrategy
 
JumpablePathfinderStrategy(int, int, int) - Constructor for class org.patheloper.api.pathing.strategy.strategies.JumpablePathfinderStrategy
 

L

length() - Method in interface org.patheloper.api.pathing.result.Path
The length of the Path compiled from the number of positions
length() - Method in class org.patheloper.api.wrapper.PathVector
Gets the length of the PathVector
LENGTH_LIMITED - Enum constant in enum org.patheloper.api.pathing.result.PathState
Signifies that the pathfinder reached its length limit

M

manhattanDistance(PathPosition) - Method in class org.patheloper.api.wrapper.PathPosition
Gets the manhattan distance between the current and another position
MAX_ITERATIONS_REACHED - Enum constant in enum org.patheloper.api.pathing.result.PathState
Signifies that the pathfinder reached its iteration limit
mid() - Method in class org.patheloper.api.wrapper.PathPosition
Sets the coordinates to the middle of the block
midPoint(PathPosition) - Method in class org.patheloper.api.wrapper.PathPosition
 
multiply(double) - Method in class org.patheloper.api.wrapper.PathVector
Multiplies itself by a scalar constant
mutatePositions(ParameterizedSupplier<PathPosition>) - Method in interface org.patheloper.api.pathing.result.Path
Mutates each of the positions in the path with the given consumer

N

NATURAL_PATH_WEIGHTS - Static variable in class org.patheloper.api.pathing.configuration.HeuristicWeights
Provides a set of default heuristic weights that may be suitable for natural pathfinding.
NMSInterface - Interface in org.patheloper.api.snapshot
This is for internal purpose only and is used to receive a ChunkSnapshot version-independent.
normalize() - Method in class org.patheloper.api.wrapper.PathVector
Normalises the PathVector (Divides the components by its magnitude)
NumberUtils - Class in org.patheloper.api.util
 
NumberUtils() - Constructor for class org.patheloper.api.util.NumberUtils
 

O

octileDistance(PathPosition) - Method in class org.patheloper.api.wrapper.PathPosition
Gets the octile distance between the current and another position
org.patheloper.api.annotation - package org.patheloper.api.annotation
 
org.patheloper.api.event - package org.patheloper.api.event
 
org.patheloper.api.pathing - package org.patheloper.api.pathing
 
org.patheloper.api.pathing.configuration - package org.patheloper.api.pathing.configuration
 
org.patheloper.api.pathing.result - package org.patheloper.api.pathing.result
 
org.patheloper.api.pathing.strategy - package org.patheloper.api.pathing.strategy
 
org.patheloper.api.pathing.strategy.strategies - package org.patheloper.api.pathing.strategy.strategies
 
org.patheloper.api.snapshot - package org.patheloper.api.snapshot
 
org.patheloper.api.util - package org.patheloper.api.util
 
org.patheloper.api.wrapper - package org.patheloper.api.wrapper
 

P

ParameterizedSupplier<T> - Interface in org.patheloper.api.util
 
Path - Interface in org.patheloper.api.pathing.result
 
PathBlock - Class in org.patheloper.api.wrapper
A Class to represent a block in the world, except exempt of Bukkit
PathBlock() - Constructor for class org.patheloper.api.wrapper.PathBlock
 
PathEnvironment - Class in org.patheloper.api.wrapper
 
PathEnvironment() - Constructor for class org.patheloper.api.wrapper.PathEnvironment
 
Pathfinder - Interface in org.patheloper.api.pathing
A Pathfinder is a class that can find a path between two positions while following a given set of rules.
PathfinderResult - Interface in org.patheloper.api.pathing.result
 
PathfinderStrategy - Interface in org.patheloper.api.pathing.strategy
A functional interface to modify the internal behaviour and choosing of the Pathfinder.
PathingEvent - Class in org.patheloper.api.event
Represents all pathing events
PathingEvent() - Constructor for class org.patheloper.api.event.PathingEvent
 
PathingFinishedEvent - Class in org.patheloper.api.event
An event called when a pathfinder finishes pathing.
PathingFinishedEvent() - Constructor for class org.patheloper.api.event.PathingFinishedEvent
 
PathingRuleSet - Class in org.patheloper.api.pathing.configuration
Defines a set of configurable rules that govern the behavior of the A* pathfinding algorithm.
PathingRuleSet() - Constructor for class org.patheloper.api.pathing.configuration.PathingRuleSet
 
PathingStartFindEvent - Class in org.patheloper.api.event
An event called when a Pathfinder starts pathing.
PathingStartFindEvent() - Constructor for class org.patheloper.api.event.PathingStartFindEvent
 
PathPosition - Class in org.patheloper.api.wrapper
 
PathPosition() - Constructor for class org.patheloper.api.wrapper.PathPosition
 
PathState - Enum in org.patheloper.api.pathing.result
 
PathValidationContext - Class in org.patheloper.api.pathing.strategy
PathValidationContext() - Constructor for class org.patheloper.api.pathing.strategy.PathValidationContext
 
PathVector - Class in org.patheloper.api.wrapper
 
PathVector() - Constructor for class org.patheloper.api.wrapper.PathVector
 
PlayerWalkableStrategy - Class in org.patheloper.api.pathing.strategy.strategies
 
PlayerWalkableStrategy() - Constructor for class org.patheloper.api.pathing.strategy.strategies.PlayerWalkableStrategy
 

S

setCancelled(boolean) - Method in class org.patheloper.api.event.PathingStartFindEvent
 
setX(double) - Method in class org.patheloper.api.wrapper.PathPosition
Sets the X coordinate of the PathPosition
setX(double) - Method in class org.patheloper.api.wrapper.PathVector
Sets the x component of the vector
setY(double) - Method in class org.patheloper.api.wrapper.PathPosition
Sets the Y coordinate of the PathPosition
setY(double) - Method in class org.patheloper.api.wrapper.PathVector
Sets the y component of the vector
setZ(double) - Method in class org.patheloper.api.wrapper.PathPosition
Sets the Z coordinate of the PathPosition
setZ(double) - Method in class org.patheloper.api.wrapper.PathVector
Sets the z component of the vector
simplify(double) - Method in interface org.patheloper.api.pathing.result.Path
Simplifies the path by removing intermediate positions based on the given epsilon value.
SnapshotManager - Interface in org.patheloper.api.snapshot
The SnapshotManager interface defines methods for retrieving block data snapshots at specific positions within a Minecraft world.
sqrt(double) - Static method in class org.patheloper.api.util.NumberUtils
 
square(double) - Static method in class org.patheloper.api.util.NumberUtils
 
subtract(double, double, double) - Method in class org.patheloper.api.wrapper.PathPosition
Subtracts x,y,z values from the current values
subtract(PathVector) - Method in class org.patheloper.api.wrapper.PathPosition
Subtracts the values of a vector from the position
subtract(PathVector) - Method in class org.patheloper.api.wrapper.PathVector
Subtracts one vector from another
successful() - Method in interface org.patheloper.api.pathing.result.PathfinderResult
Returns whether the pathfinding was successful.

T

toVector() - Method in class org.patheloper.api.wrapper.PathPosition
Converts the positions x,y,z to a PathVector
trim(int) - Method in interface org.patheloper.api.pathing.result.Path
Trims this Path to the given length.

V

valueOf(String) - Static method in enum org.patheloper.api.pathing.result.PathState
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.patheloper.api.pathing.result.PathState
Returns an array containing the constants of this enum type, in the order they are declared.

W

WalkablePathfinderStrategy - Class in org.patheloper.api.pathing.strategy.strategies
A PathfinderStrategy to find the best walkable path.
WalkablePathfinderStrategy() - Constructor for class org.patheloper.api.pathing.strategy.strategies.WalkablePathfinderStrategy
 
WalkablePathfinderStrategy(int) - Constructor for class org.patheloper.api.pathing.strategy.strategies.WalkablePathfinderStrategy
 
A B C D E F G H I J L M N O P S T V W 
All Classes and Interfaces|All Packages