Index

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

A

abort() - Method in interface de.metaphoriker.pathetic.api.pathing.Pathfinder

Aborts the running pathfinding process.

ABORTED - Enum constant in enum de.metaphoriker.pathetic.api.pathing.result.PathState

The pathfinding process was aborted

accept(T) - Method in interface de.metaphoriker.pathetic.api.util.ParameterizedSupplier

Applies this supplier to the given argument.

add(double, double, double) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Adds x,y,z values to the current values

add(PathVector) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Adds the values of a vector to the position

add(PathVector) - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

Adds two vectors together

async(boolean) - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder

B

build() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder

builder() - Static method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration

C

canEqual(Object) - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration

canEqual(Object) - Method in class de.metaphoriker.pathetic.api.wrapper.Depth

canEqual(Object) - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

cleanup() - Method in interface de.metaphoriker.pathetic.api.pathing.filter.PathFilter

Cleans up the resources used during the pathfinding process.

cleanup() - Method in class de.metaphoriker.pathetic.api.pathing.filter.PathFilterStage

Cleans up all filters in the stage.

clone() - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

clone() - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

computeDistance(PathVector, PathVector, PathVector) - Static method in class de.metaphoriker.pathetic.api.wrapper.PathVector

Finds the distance between the line BC and the point A

create(double, double, double, double) - Static method in class de.metaphoriker.pathetic.api.pathing.configuration.HeuristicWeights

createPathfinder(PathfinderConfiguration) - Method in interface de.metaphoriker.pathetic.api.factory.PathfinderFactory

Creates a new Pathfinder instance with the given configuration.

createPathfinder(PathfinderConfiguration, PathfinderInitializer) - Method in interface de.metaphoriker.pathetic.api.factory.PathfinderFactory

Creates a new Pathfinder instance with the given configuration and initializer.

D

de.metaphoriker.pathetic.api.annotation - package de.metaphoriker.pathetic.api.annotation

de.metaphoriker.pathetic.api.factory - package de.metaphoriker.pathetic.api.factory

de.metaphoriker.pathetic.api.pathing - package de.metaphoriker.pathetic.api.pathing

de.metaphoriker.pathetic.api.pathing.configuration - package de.metaphoriker.pathetic.api.pathing.configuration

de.metaphoriker.pathetic.api.pathing.filter - package de.metaphoriker.pathetic.api.pathing.filter

de.metaphoriker.pathetic.api.pathing.filter.filters - package de.metaphoriker.pathetic.api.pathing.filter.filters

de.metaphoriker.pathetic.api.pathing.hook - package de.metaphoriker.pathetic.api.pathing.hook

de.metaphoriker.pathetic.api.pathing.result - package de.metaphoriker.pathetic.api.pathing.result

de.metaphoriker.pathetic.api.provider - package de.metaphoriker.pathetic.api.provider

de.metaphoriker.pathetic.api.util - package de.metaphoriker.pathetic.api.util

de.metaphoriker.pathetic.api.wrapper - package de.metaphoriker.pathetic.api.wrapper

deepCopy(PathfinderConfiguration) - Static method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration

Creates a deep copy of the given PathfinderConfiguration.

Depth - Class in de.metaphoriker.pathetic.api.wrapper

Represents the depth of a pathfinding node or element.

DIRECT_PATH_WEIGHTS - Static variable in class de.metaphoriker.pathetic.api.pathing.configuration.HeuristicWeights

Provides a set of weights strongly prioritizing the shortest direct path, even if diagonally.

distance(PathPosition) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Gets the distance between the current and another position

distance(PathVector) - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

Gets the distance between this vector and another vector

distanceSquared(PathPosition) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Gets the distance squared between the current and another position

divide(double) - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

Divide the vector by a scalar constant

dot(PathVector) - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

Calculates the dot product of two vectors

E

equals(Object) - Method in class de.metaphoriker.pathetic.api.pathing.configuration.HeuristicWeights

equals(Object) - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration

equals(Object) - Method in class de.metaphoriker.pathetic.api.pathing.filter.PathFilterStage

equals(Object) - Method in class de.metaphoriker.pathetic.api.pathing.filter.PathValidationContext

equals(Object) - Method in class de.metaphoriker.pathetic.api.pathing.hook.PathfindingContext

equals(Object) - Method in class de.metaphoriker.pathetic.api.wrapper.Depth

equals(Object) - Method in class de.metaphoriker.pathetic.api.wrapper.PathEnvironment

equals(Object) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

equals(Object) - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

Experimental - Annotation Type in de.metaphoriker.pathetic.api.annotation

Marks an API as experimental.

F

FAILED - Enum constant in enum de.metaphoriker.pathetic.api.pathing.result.PathState

The Path wasn't found, either it reached its max search depth or it couldn't find more positions

fallback(boolean) - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder

FALLBACK - Enum constant in enum de.metaphoriker.pathetic.api.pathing.result.PathState

Signifies that the pathfinder fell back during the pathfinding attempt

filter(PathValidationContext) - Method in class de.metaphoriker.pathetic.api.pathing.filter.filters.PassablePathFilter

filter(PathValidationContext) - Method in interface de.metaphoriker.pathetic.api.pathing.filter.PathFilter

Evaluates the given PathValidationContext to determine if the path is valid.

filter(PathValidationContext) - Method in class de.metaphoriker.pathetic.api.pathing.filter.PathFilterStage

Filters the given context with all filters in the stage.

findPath(PathPosition, PathPosition, List<PathFilter>) - Method in interface de.metaphoriker.pathetic.api.pathing.Pathfinder

Tries to find a Path between the two PathPosition's provided with the given filters.

findPath(PathPosition, PathPosition, List<PathFilter>, List<PathFilterStage>) - Method in interface de.metaphoriker.pathetic.api.pathing.Pathfinder

Tries to find a Path between the two PathPosition's provided with the given filter-containers.

floor() - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Rounds the x,y,z values to the floor of the values

FOUND - Enum constant in enum de.metaphoriker.pathetic.api.pathing.result.PathState

The Path was successfully found

G

getAbsoluteStart() - Method in class de.metaphoriker.pathetic.api.pathing.filter.PathValidationContext

getAbsoluteTarget() - Method in class de.metaphoriker.pathetic.api.pathing.filter.PathValidationContext

getCrossProduct(PathVector) - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

Calculates the cross product of two vectors

getDepth() - Method in class de.metaphoriker.pathetic.api.pathing.hook.PathfindingContext

getEnd() - Method in interface de.metaphoriker.pathetic.api.pathing.result.Path

Returns the target position of the path

getFilters() - Method in class de.metaphoriker.pathetic.api.pathing.filter.PathFilterStage

getFlooredX() - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Gets the X coordinate of the block the position is in

getFlooredY() - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Gets the Y coordinate of the block the position is in

getFlooredZ() - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Gets the Z coordinate of the block the position is in

getHeightWeight() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.HeuristicWeights

getHeuristicWeights() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration

getManhattanWeight() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.HeuristicWeights

getMaxHeight() - Method in class de.metaphoriker.pathetic.api.wrapper.PathEnvironment

getMaxIterations() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration

getMaxLength() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration

getMinHeight() - Method in class de.metaphoriker.pathetic.api.wrapper.PathEnvironment

getName() - Method in class de.metaphoriker.pathetic.api.wrapper.PathEnvironment

getNavigationPoint(PathPosition) - Method in interface de.metaphoriker.pathetic.api.provider.NavigationPointProvider

Gets the navigation point at the given position.

getNavigationPointProvider() - Method in class de.metaphoriker.pathetic.api.pathing.filter.PathValidationContext

getOctileWeight() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.HeuristicWeights

getParent() - Method in class de.metaphoriker.pathetic.api.pathing.filter.PathValidationContext

getPath() - Method in interface de.metaphoriker.pathetic.api.pathing.result.PathfinderResult

Returns the found Path regardless if successful or not.

getPathEnvironment() - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

getPathState() - Method in interface de.metaphoriker.pathetic.api.pathing.result.PathfinderResult

Returns the state of the pathfinding.

getPerpendicularWeight() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.HeuristicWeights

getPosition() - Method in class de.metaphoriker.pathetic.api.pathing.filter.PathValidationContext

getProvider() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration

getStart() - Method in interface de.metaphoriker.pathetic.api.pathing.result.Path

Returns the start position of the path

getUuid() - Method in class de.metaphoriker.pathetic.api.wrapper.PathEnvironment

getValue() - Method in class de.metaphoriker.pathetic.api.wrapper.Depth

getX() - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

getX() - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

getY() - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

getY() - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

getZ() - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

getZ() - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

H

hasFailed() - Method in interface de.metaphoriker.pathetic.api.pathing.result.PathfinderResult

Whether the pathfinder has failed to reach its target.

hasFallenBack() - Method in interface de.metaphoriker.pathetic.api.pathing.result.PathfinderResult

Whether a pathfinder has resulted in a fallback.

hashCode() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.HeuristicWeights

hashCode() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration

hashCode() - Method in class de.metaphoriker.pathetic.api.pathing.filter.PathFilterStage

hashCode() - Method in class de.metaphoriker.pathetic.api.pathing.filter.PathValidationContext

hashCode() - Method in class de.metaphoriker.pathetic.api.pathing.hook.PathfindingContext

hashCode() - Method in class de.metaphoriker.pathetic.api.wrapper.Depth

hashCode() - Method in class de.metaphoriker.pathetic.api.wrapper.PathEnvironment

hashCode() - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

hashCode() - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

heuristicWeights(HeuristicWeights) - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder

HeuristicWeights - Class in de.metaphoriker.pathetic.api.pathing.configuration

Represents a set of weights used to calculate a heuristic for the A* pathfinding algorithm.

I

increment() - Method in class de.metaphoriker.pathetic.api.wrapper.Depth

Increments the depth value by one.

initialize(Pathfinder, PathfinderConfiguration) - Method in interface de.metaphoriker.pathetic.api.factory.PathfinderInitializer

Initializes the given Pathfinder with the given PathfinderConfiguration.

INITIALLY_FAILED - Enum constant in enum de.metaphoriker.pathetic.api.pathing.result.PathState

Pathing failed to start, typically due to an invalid start or end position.

interpolate(double) - Method in interface de.metaphoriker.pathetic.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 de.metaphoriker.pathetic.api.util.NumberUtils

Interpolates between two values based on the given progress.

interpolate(PathPosition, double) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Interpolates between two positions based on the given progress.

isAsync() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration

isFallback() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration

isInSameBlock(PathPosition) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Checks to see if the two positions are in the same block

isTraversable() - Method in interface de.metaphoriker.pathetic.api.provider.NavigationPoint

Checks if the block is traversable.

J

join(Path) - Method in interface de.metaphoriker.pathetic.api.pathing.result.Path

Joins this Path with the given Path.

L

length() - Method in interface de.metaphoriker.pathetic.api.pathing.result.Path

The length of the Path compiled from the number of positions

length() - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

Gets the length of the PathVector

LENGTH_LIMITED - Enum constant in enum de.metaphoriker.pathetic.api.pathing.result.PathState

Signifies that the pathfinder reached its length limit

M

manhattanDistance(PathPosition) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Gets the manhattan distance between the current and another position

MAX_ITERATIONS_REACHED - Enum constant in enum de.metaphoriker.pathetic.api.pathing.result.PathState

Signifies that the pathfinder reached its iteration limit

maxIterations(int) - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder

maxLength(int) - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder

mid() - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Sets the coordinates to the middle of the block

midPoint(PathPosition) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Calculates the midpoint between the current position and the given end position.

multiply(double) - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

Multiplies itself by a scalar constant

mutatePositions(ParameterizedSupplier<PathPosition>) - Method in interface de.metaphoriker.pathetic.api.pathing.result.Path

Mutates each of the positions in the path with the given consumer

N

NATURAL_PATH_WEIGHTS - Static variable in class de.metaphoriker.pathetic.api.pathing.configuration.HeuristicWeights

Provides a set of default heuristic weights that may be suitable for natural pathfinding.

NavigationPoint - Interface in de.metaphoriker.pathetic.api.provider

Represents information about a position in the pathfinding environment.

NavigationPointProvider - Interface in de.metaphoriker.pathetic.api.provider

The NavigationPointProvider interface defines methods for retrieving navigation point data at specific positions within a 3D environment.

normalize() - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

Normalises the PathVector (Divides the components by its magnitude)

NumberUtils - Class in de.metaphoriker.pathetic.api.util

Utility class for common number operations.

O

octileDistance(PathPosition) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Gets the octile distance between the current and another position

of(int) - Static method in class de.metaphoriker.pathetic.api.wrapper.Depth

onPathfindingStep(PathfindingContext) - Method in interface de.metaphoriker.pathetic.api.pathing.hook.PathfinderHook

Called on each step of the pathfinding process.

P

ParameterizedSupplier<T> - Interface in de.metaphoriker.pathetic.api.util

A functional interface representing a supplier that accepts a parameter and returns a result.

PassablePathFilter - Class in de.metaphoriker.pathetic.api.pathing.filter.filters

A PathFilter implementation that determines if a path is passable.

PassablePathFilter() - Constructor for class de.metaphoriker.pathetic.api.pathing.filter.filters.PassablePathFilter

Path - Interface in de.metaphoriker.pathetic.api.pathing.result

PathEnvironment - Class in de.metaphoriker.pathetic.api.wrapper

Represents the pathing environment

PathEnvironment(UUID, String, Integer, Integer) - Constructor for class de.metaphoriker.pathetic.api.wrapper.PathEnvironment

PathFilter - Interface in de.metaphoriker.pathetic.api.pathing.filter

A PathFilter is a functional interface that allows customization of the pathfinding process within the Pathfinder.

PathFilterStage - Class in de.metaphoriker.pathetic.api.pathing.filter

A stage for multiple PathFilters.

PathFilterStage(PathFilter...) - Constructor for class de.metaphoriker.pathetic.api.pathing.filter.PathFilterStage

Pathfinder - Interface in de.metaphoriker.pathetic.api.pathing

A Pathfinder is a class that can find a path between two positions while following a given set of rules.

PathfinderConfiguration - Class in de.metaphoriker.pathetic.api.pathing.configuration

Defines a set of configurable parameters that govern the behavior of the A* pathfinding algorithm.

PathfinderConfiguration.PathfinderConfigurationBuilder - Class in de.metaphoriker.pathetic.api.pathing.configuration

PathfinderFactory - Interface in de.metaphoriker.pathetic.api.factory

A factory interface for creating Pathfinder instances.

PathfinderHook - Interface in de.metaphoriker.pathetic.api.pathing.hook

Interface for hooks that are called during the pathfinding process.

PathfinderInitializer - Interface in de.metaphoriker.pathetic.api.factory

An interface for initializing Pathfinder instances.

PathfinderResult - Interface in de.metaphoriker.pathetic.api.pathing.result

PathfindingContext - Class in de.metaphoriker.pathetic.api.pathing.hook

Context for the current step of the pathfinding process.

PathfindingContext(Depth) - Constructor for class de.metaphoriker.pathetic.api.pathing.hook.PathfindingContext

PathPosition - Class in de.metaphoriker.pathetic.api.wrapper

PathPosition(PathEnvironment, double, double, double) - Constructor for class de.metaphoriker.pathetic.api.wrapper.PathPosition

PathState - Enum in de.metaphoriker.pathetic.api.pathing.result

PathValidationContext - Class in de.metaphoriker.pathetic.api.pathing.filter

PathValidationContext is a data container used during the pathfinding process to provide relevant contextual information needed for evaluating path validity.

PathValidationContext(PathPosition, PathPosition, PathPosition, PathPosition, NavigationPointProvider) - Constructor for class de.metaphoriker.pathetic.api.pathing.filter.PathValidationContext

PathVector - Class in de.metaphoriker.pathetic.api.wrapper

PathVector(double, double, double) - Constructor for class de.metaphoriker.pathetic.api.wrapper.PathVector

provider(NavigationPointProvider) - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder

R

registerPathfindingHook(PathfinderHook) - Method in interface de.metaphoriker.pathetic.api.pathing.Pathfinder

Registers a PathfinderHook that will be called on every step of the pathfinding process.

S

setX(double) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Sets the X coordinate of the PathPosition

setX(double) - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

Sets the x component of the vector

setY(double) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Sets the Y coordinate of the PathPosition

setY(double) - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

Sets the y component of the vector

setZ(double) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Sets the Z coordinate of the PathPosition

setZ(double) - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

Sets the z component of the vector

simplify(double) - Method in interface de.metaphoriker.pathetic.api.pathing.result.Path

Simplifies the path by removing intermediate positions based on the given epsilon value.

sqrt(double) - Static method in class de.metaphoriker.pathetic.api.util.NumberUtils

Computes the square root of the given value using an approximation method.

square(double) - Static method in class de.metaphoriker.pathetic.api.util.NumberUtils

Squares the given value.

subtract(double, double, double) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Subtracts x,y,z values from the current values

subtract(PathVector) - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Subtracts the values of a vector from the position

subtract(PathVector) - Method in class de.metaphoriker.pathetic.api.wrapper.PathVector

Subtracts one vector from another

successful() - Method in interface de.metaphoriker.pathetic.api.pathing.result.PathfinderResult

Returns whether the pathfinding was successful.

T

toString() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.HeuristicWeights

toString() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder

toString() - Method in class de.metaphoriker.pathetic.api.pathing.configuration.PathfinderConfiguration

toString() - Method in class de.metaphoriker.pathetic.api.pathing.filter.PathFilterStage

toString() - Method in class de.metaphoriker.pathetic.api.pathing.filter.PathValidationContext

toString() - Method in class de.metaphoriker.pathetic.api.pathing.hook.PathfindingContext

toString() - Method in class de.metaphoriker.pathetic.api.wrapper.PathEnvironment

toString() - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

toVector() - Method in class de.metaphoriker.pathetic.api.wrapper.PathPosition

Converts the positions x,y,z to a PathVector

trim(int) - Method in interface de.metaphoriker.pathetic.api.pathing.result.Path

Trims this Path to the given length.

V

valueOf(String) - Static method in enum de.metaphoriker.pathetic.api.pathing.result.PathState

Returns the enum constant of this type with the specified name.

values() - Static method in enum de.metaphoriker.pathetic.api.pathing.result.PathState

Returns an array containing the constants of this enum type, in the order they are declared.

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