### AbstractPathfinder.createStartNode Source: https://docs.pathetic.site/index-all.html Creates the initial Node for the start position. ```APIDOC ## AbstractPathfinder.createStartNode ### Description Creates the initial `Node` for the start position. ### Method Method in class ### Parameters - **PathPosition** - Description - **PathPosition** - Description ### Endpoint N/A (Class method) ``` -------------------------------- ### startPosition Source: https://docs.pathetic.site/index-all.html Returns the overall start position of the pathfinding. ```APIDOC ## startPosition() ### Description Returns the overall start position of the pathfinding. ### Method `startPosition()` ### Returns (PathPosition) - The start position of the pathfinding. ``` -------------------------------- ### PathfinderConfiguration.builder Source: https://docs.pathetic.site/index-all.html Static method to get a new PathfinderConfigurationBuilder instance. ```APIDOC ## builder() ### Description Static method to get a new PathfinderConfigurationBuilder instance. ### Method Static Method ### Parameters #### Path Parameters - None #### Query Parameters - None ### Request Example ```json { "example": "Not applicable for this method" } ``` ### Response #### Success Response (200) - **PathfinderConfigurationBuilder** - A new instance of PathfinderConfigurationBuilder. #### Response Example ```json { "example": "Not applicable for this method" } ``` ``` -------------------------------- ### MinHeap.cost Source: https://docs.pathetic.site/index-all.html Gets the current cost of a node in the heap. ```APIDOC ## cost(long) ### Description Gets the current cost of a node in the heap. ### Method Method ### Parameters #### Path Parameters - **long nodeId** (long) - The ID of the node whose cost is to be retrieved. #### Query Parameters - None ### Request Example ```json { "example": "Not applicable for this method" } ``` ### Response #### Success Response (200) - **double** - The current cost of the node. #### Response Example ```json { "example": "Not applicable for this method" } ``` ``` -------------------------------- ### getFCost Source: https://docs.pathetic.site/index-all.html Calculates the estimated total cost (F-cost) from the start node to the target node, passing through the current node. This is a key metric in algorithms like A*. ```APIDOC ## getFCost ### Description Calculates the estimated total cost (F-cost) of the path from the start node to the target node, passing through this node. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### AStarPathfinder Source: https://docs.pathetic.site/index-all.html An A* pathfinding algorithm that uses a heuristic to guide the search toward the target. ```APIDOC ## AStarPathfinder ### Description An A* pathfinding algorithm that uses a heuristic to guide the search toward the target. ### Constructor AStarPathfinder(PathfinderConfiguration) ### Parameters - **PathfinderConfiguration** (PathfinderConfiguration) - Description ``` -------------------------------- ### getNavigationPoint Source: https://docs.pathetic.site/index-all.html Gets the navigation point at the given position. ```APIDOC ## getNavigationPoint ### Description Gets the navigation point at the given position. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters - **position** (PathPosition) - The position for which to retrieve the navigation point. ### Response - Returns the navigation point at the specified position. ``` -------------------------------- ### reconstructPath Source: https://docs.pathetic.site/index-all.html Reconstructs the path by tracing back from the given end node to the start node. ```APIDOC ## reconstructPath(PathPosition start, PathPosition end, Node node) ### Description Reconstructs the path by tracing back from the given end node to the start node. ### Method Method ### Endpoint N/A (Class Method) ``` -------------------------------- ### getOffsets Source: https://docs.pathetic.site/index-all.html Gets the collection of vectors to check for neighbor nodes. ```APIDOC ## getOffsets ### Description Gets the collection of vectors to check for neighbor nodes. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters None ### Response - Returns the collection of offset vectors. ``` -------------------------------- ### getOffsets (with position) Source: https://docs.pathetic.site/index-all.html Gets the collection of vectors based on the current position. ```APIDOC ## getOffsets (with position) ### Description Gets the collection of vectors based on the current position. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters - **position** (PathPosition) - The current position. ### Response - Returns the collection of offset vectors based on the position. ``` -------------------------------- ### getPathCostToPreviousPosition Source: https://docs.pathetic.site/index-all.html Returns the accumulated G-cost (actual known cost from start) up to the `previous PathPosition`. ```APIDOC ## getPathCostToPreviousPosition ### Description Returns the accumulated G-cost (actual known cost from start) up to the `previous PathPosition`. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters None ### Response - Returns the G-cost to the previous position. ``` -------------------------------- ### getGCost Source: https://docs.pathetic.site/index-all.html Retrieves the G-cost for a node, which represents the accumulated known cost from the start node to this node. This is a fundamental component of many pathfinding algorithms. ```APIDOC ## getGCost ### Description Gets the calculated G-cost (accumulated known cost from the start node) for this node. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### initialize Source: https://docs.pathetic.site/index-all.html Initializes the given Pathfinder with the given PathfinderConfiguration. ```APIDOC ## initialize(Pathfinder, PathfinderConfiguration) ### Description Initializes the given `Pathfinder` with the given `PathfinderConfiguration`. ### Method N/A (Method signature provided) ### Parameters - **pathfinder** (Pathfinder) - Required - The Pathfinder instance to initialize. - **configuration** (PathfinderConfiguration) - Required - The configuration to use for initialization. ``` -------------------------------- ### getCurrentNodeHeuristicValue Source: https://docs.pathetic.site/index-all.html Gets the heuristic value (H-cost) for the current path position. This value estimates the cost from the current position to the target, guiding the pathfinding algorithm. ```APIDOC ## getCurrentNodeHeuristicValue ### Description Returns the heuristic value (H-cost) calculated by the pathfinding engine for the `current PathPosition` towards the target. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### PathfinderHook.onPathfindingStart Source: https://docs.pathetic.site/index-all.html Called once before the pathfinding loop begins. ```APIDOC ## PathfinderHook.onPathfindingStart ### Description Called once before the pathfinding loop begins, after the start node has been initialized but before any node is expanded. ### Method Callback method ### Parameters - **context** (PathfindingContext) - The context of the pathfinding operation. ### Response Example ```json { "example": "void" } ``` ``` -------------------------------- ### PathfinderConfigurationBuilder Methods Source: https://docs.pathetic.site/index-all.html Methods for configuring the pathfinder. ```APIDOC ## gridCellSize(int) ### Description Deprecated. Marked for removal. The bundled A* engine no longer buckets its closed set into bloom-filtered grid regions; the value is accepted but unused and will be removed in a future release. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### initializeSearch Source: https://docs.pathetic.site/index-all.html Called once at the beginning of a path search operation. ```APIDOC ## initializeSearch(SearchContext) ### Description Called once at the beginning of a path search operation. ### Method N/A (Method signature provided) ### Parameters - **context** (SearchContext) - Required - The context of the search operation. ``` -------------------------------- ### PathfinderConfigurationBuilder.build Source: https://docs.pathetic.site/index-all.html Builds the PathfinderConfiguration object. ```APIDOC ## build() ### Description Builds the PathfinderConfiguration object. ### Method Method ### Parameters #### Path Parameters - None #### Query Parameters - None ### Request Example ```json { "example": "Not applicable for this method" } ``` ### Response #### Success Response (200) - **PathfinderConfiguration** - The constructed PathfinderConfiguration object. #### Response Example ```json { "example": "Not applicable for this method" } ``` ``` -------------------------------- ### PathfinderConfiguration.PathfinderConfigurationBuilder.pathfindingHooks Source: https://docs.pathetic.site/index-all.html Sets the list of PathfinderHook instances for the configuration. ```APIDOC ## PathfinderConfiguration.PathfinderConfigurationBuilder.pathfindingHooks ### Description Sets the list of `PathfinderHook` instances that will be called during the pathfinding process. ### Method Builder method ### Parameters - **hooks** (List) - A list of `PathfinderHook` implementations. ### Response Example ```json { "example": "PathfinderConfiguration.PathfinderConfigurationBuilder object" } ``` ``` -------------------------------- ### LinearHeuristicStrategy constructor Source: https://docs.pathetic.site/index-all.html Constructs a new LinearHeuristicStrategy. ```APIDOC ## LinearHeuristicStrategy() ### Description Constructs a new `LinearHeuristicStrategy`. ### Constructor ### Class de.bsommerfeld.pathetic.api.pathing.heuristic.LinearHeuristicStrategy ``` -------------------------------- ### accept(T) Source: https://docs.pathetic.site/index-all.html Applies this supplier to the given argument. ```APIDOC ## accept(T) ### Description Applies this supplier to the given argument. ### Method Method ### Endpoint N/A ### Parameters - **T** (type) - Description ### Request Example None ### Response None ``` -------------------------------- ### PathfindingContext.target() Source: https://docs.pathetic.site/index-all.html The target position of the search. ```APIDOC ## target() ### Description The target position of the search. ### Method N/A (Java method signature) ### Response - **PathPosition** - The target position. ``` -------------------------------- ### PathfinderHook.onPathfindingStep Source: https://docs.pathetic.site/index-all.html Called on each step of the pathfinding process. ```APIDOC ## PathfinderHook.onPathfindingStep ### Description Called on each step of the pathfinding process. ### Method Callback method ### Parameters - **context** (PathfindingContext) - The context of the current pathfinding step. ### Response Example ```json { "example": "void" } ``` ``` -------------------------------- ### Cost.of Source: https://docs.pathetic.site/index-all.html Factory method to create a Cost instance. ```APIDOC ## Cost.of ### Description Factory method to create a `Cost` instance. ### Method Static factory method ### Parameters - **value** (double) - The cost value. ### Response Example ```json { "example": "Cost object" } ``` ``` -------------------------------- ### PathfinderConfigurationBuilder Source: https://docs.pathetic.site/index-all.html Builder for configuring Pathfinder settings. ```APIDOC ## Class: PathfinderConfiguration.PathfinderConfigurationBuilder ### Description Builder for configuring Pathfinder settings. ### Methods - **fallback(boolean enable)** Enables or disables fallback behavior for the pathfinder. ``` -------------------------------- ### QuaternaryPrimitiveMinHeap Constructor Source: https://docs.pathetic.site/index-all.html Constructs a new quaternary min-heap. Can be initialized with default capacity or a specified capacity. ```APIDOC ## QuaternaryPrimitiveMinHeap() ### Description Constructs a new quaternary min-heap with the default initial capacity. ### Method Constructor ### Endpoint N/A (Class Constructor) ## QuaternaryPrimitiveMinHeap(int capacity) ### Description Constructs a new quaternary min-heap with the specified initial capacity. ### Method Constructor ### Endpoint N/A (Class Constructor) ``` -------------------------------- ### HeuristicWeights.create Source: https://docs.pathetic.site/index-all.html Creates a new HeuristicWeights instance with the specified weights for pathfinding heuristics. ```APIDOC ## HeuristicWeights.create ### Description Creates a new `HeuristicWeights` instance with the specified weights. ### Method Static method ### Parameters - **double** - Description - **double** - Description - **double** - Description - **double** - Description ### Endpoint N/A (Static method) ``` -------------------------------- ### PathfinderConfiguration.PathfinderConfigurationBuilder.maxIterations Source: https://docs.pathetic.site/index-all.html Sets the maximum number of iterations for the pathfinder. ```APIDOC ## maxIterations(int) ### Description Sets the maximum number of iterations for the pathfinder. ### Method Method in class ### Parameters #### Path Parameters - **maxIterations** (int) - The maximum number of iterations. ### Class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder ``` -------------------------------- ### isEmpty (MinHeap) Source: https://docs.pathetic.site/index-all.html Checks if the heap is empty. ```APIDOC ## isEmpty() ### Description Checks if the heap is empty. ### Method N/A (Method signature provided) ### Returns - **boolean** - True if the heap is empty, false otherwise. ``` -------------------------------- ### PathImpl Source: https://docs.pathetic.site/index-all.html Represents an implemented path. ```APIDOC ## Class: PathImpl ### Description Represents an implemented path. ### Methods - **forEach(Consumer action)** Performs the given action for each `PathPosition` in the path. ``` -------------------------------- ### ifPresent Source: https://docs.pathetic.site/index-all.html Executes the given callback if the pathfinding operation results in a successful path or a fallback. ```APIDOC ## ifPresent(Consumer) ### Description Executes the given callback if the pathfinding operation results in a successful path or a fallback. ### Method N/A (Method signature provided) ### Parameters - **callback** (Consumer) - Required - The callback to execute. ``` -------------------------------- ### getPathState Source: https://docs.pathetic.site/index-all.html Returns the state of the pathfinding operation. ```APIDOC ## getPathState ### Description Returns the state of the pathfinding operation. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters None ### Response - Returns the `PathState` enum value. ``` -------------------------------- ### getProvider Source: https://docs.pathetic.site/index-all.html Retrieves the provider associated with the pathfinding configuration. ```APIDOC ## getProvider ### Description Retrieves the provider associated with the pathfinding configuration. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters None ### Response - Returns the provider object. ``` -------------------------------- ### AStarPathfinder.createSearchState Source: https://docs.pathetic.site/index-all.html Creates the per-search state for the A* algorithm. ```APIDOC ## AStarPathfinder.createSearchState ### Description Creates the per-search state holding this algorithm's open and closed sets. ### Method Method in class ### Parameters - **PathPosition** - Description - **int** - Description ### Endpoint N/A (Class method) ``` -------------------------------- ### Processor Interface Source: https://docs.pathetic.site/index-all.html Interface for processing steps in a path search. ```APIDOC ## Interface: Processor ### Description Interface for processing steps in a path search. ### Methods - **finalizeSearch(SearchContext context)** Called once at the end of a path search operation, regardless of whether a path was found or the search was aborted. ``` -------------------------------- ### RegionKey.pack Source: https://docs.pathetic.site/index-all.html Packs raw integer coordinates into a primitive long key. ```APIDOC ## RegionKey.pack ### Description Packs raw integer coordinates into a primitive long key. ### Method Static utility method ### Parameters - **x** (int) - The x-coordinate. - **y** (int) - The y-coordinate. - **z** (int) - The z-coordinate. ### Response Example ```json { "example": "long key" } ``` ``` -------------------------------- ### PathfinderFactory.createPathfinder Source: https://docs.pathetic.site/index-all.html Creates a new Pathfinder instance with the given configuration and initializer. ```APIDOC ## PathfinderFactory.createPathfinder ### Description Creates a new `Pathfinder` instance with the given configuration and initializer. ### Method Method in interface ### Parameters - **PathfinderConfiguration** - Description - **PathfinderInitializer** - Description ### Endpoint N/A (Interface method) ``` -------------------------------- ### PathfinderConfiguration.deepCopy Source: https://docs.pathetic.site/index-all.html Creates a deep copy of the given PathfinderConfiguration. This is useful for modifying configurations without affecting the original. ```APIDOC ## PathfinderConfiguration.deepCopy ### Description Creates a deep copy of the given `PathfinderConfiguration`. This method ensures that modifications to the copied configuration do not affect the original. ### Method Static method ### Parameters * **configuration** (`PathfinderConfiguration`) - Required - The configuration to be deep copied. ### Response * **copiedConfiguration** (`PathfinderConfiguration`) - A new `PathfinderConfiguration` object that is a deep copy of the input. ``` -------------------------------- ### simplify Source: https://docs.pathetic.site/index-all.html Simplifies a path by retaining only every nth point based on an epsilon value. Deprecated. ```APIDOC ## simplify(Path, double) ### Description Simplifies a path by retaining only every nth point based on an epsilon value. Deprecated. ### Method `simplify(Path path, double epsilon)` ### Parameters * **path** (Path) - The path to simplify. * **epsilon** (double) - The epsilon value to use for simplification. ``` -------------------------------- ### Path Methods Source: https://docs.pathetic.site/index-all.html Methods to retrieve information about a path. ```APIDOC ## getStart() ### Description Returns the start position of the path. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### AStarPathfinderFactory Source: https://docs.pathetic.site/index-all.html Factory for creating A* pathfinders. ```APIDOC ## AStarPathfinderFactory ### Description Factory for creating A* pathfinders. ### Constructor AStarPathfinderFactory() ### Parameters None ``` -------------------------------- ### async(boolean) Source: https://docs.pathetic.site/index-all.html Sets whether the pathfinding operation should be asynchronous. ```APIDOC ## async(boolean) ### Description Sets whether the pathfinding operation should be asynchronous. ### Method Method ### Endpoint N/A ### Parameters - **boolean** (boolean) - Description ### Request Example None ### Response - **PathfinderConfigurationBuilder** (PathfinderConfigurationBuilder) - Description ``` -------------------------------- ### SearchContext Source: https://docs.pathetic.site/index-all.html Provides context for an entire pathfinding search operation. ```APIDOC ## SearchContext ### Description Provides context for an entire pathfinding search operation. ### Interface `de.bsommerfeld.pathetic.api.pathing.processing.context.SearchContext` ``` -------------------------------- ### getNavigationPoint (with context) Source: https://docs.pathetic.site/index-all.html Retrieves the navigation point at the specified position within the provided environment context. ```APIDOC ## getNavigationPoint (with context) ### Description Retrieves the navigation point at the specified position within the provided environment context. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters - **position** (PathPosition) - The position for which to retrieve the navigation point. - **context** (EnvironmentContext) - The environment context to use. ### Response - Returns the navigation point at the specified position within the given context. ``` -------------------------------- ### AbstractPathfinder.createSearchState Source: https://docs.pathetic.site/index-all.html Creates the per-search state holding the algorithm's open and closed sets. ```APIDOC ## AbstractPathfinder.createSearchState ### Description Creates the per-search state holding this algorithm's open and closed sets. ### Method Method in class ### Parameters - **PathPosition** - Description - **int** - Description ### Endpoint N/A (Class method) ``` -------------------------------- ### PathfindingProgress.targetPosition() Source: https://docs.pathetic.site/index-all.html Returns the destination (target) position of the overall pathfinding process. ```APIDOC ## targetPosition() ### Description Returns the destination (target) position of the overall pathfinding process. ### Method N/A (Java method signature) ### Response - **PathPosition** - The target position. ``` -------------------------------- ### MinHeap.clear Source: https://docs.pathetic.site/index-all.html Removes all elements from the heap. ```APIDOC ## clear() ### Description Removes all elements from the heap. ### Method Method ### Parameters #### Path Parameters - None #### Query Parameters - None ### Request Example ```json { "example": "Not applicable for this method" } ``` ### Response #### Success Response (200) - **void** - Description of the return value. #### Response Example ```json { "example": "Not applicable for this method" } ``` ``` -------------------------------- ### EvaluationContext Methods Source: https://docs.pathetic.site/index-all.html Methods to access search context and shared data within the pathfinding process. ```APIDOC ## getSearchContext() ### Description Provides access to the overarching `SearchContext` for this pathfinding operation. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` ```APIDOC ## getSharedData() ### Description Convenience method to access the shared data map for the overall search. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` ```APIDOC ## getStartPathPosition() ### Description Convenience method to access the start PathPosition of the overall search. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` ```APIDOC ## getTargetPathPosition() ### Description Convenience method to access the target PathPosition of the overall search. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### PathPosition Wrapper Source: https://docs.pathetic.site/index-all.html Wrapper class for path positions. ```APIDOC ## Class: PathPosition ### Description Wrapper class for path positions. ### Methods - **floor()** Creates a new `PathPosition` with the coordinates floored to the nearest integer values. ``` -------------------------------- ### AStarPathfinderFactory.createPathfinder Source: https://docs.pathetic.site/index-all.html Creates a new AStarPathfinder instance with the given configuration. ```APIDOC ## AStarPathfinderFactory.createPathfinder ### Description Creates a new `AStarPathfinder` instance with the given configuration. ### Method Method in class ### Parameters - **PathfinderConfiguration** - Description ### Endpoint N/A (Class method) ``` -------------------------------- ### PathfindingProgress.currentPosition Source: https://docs.pathetic.site/index-all.html Returns the current step (position) of the pathfinding process. ```APIDOC ## PathfindingProgress.currentPosition ### Description Returns the current step (position) of the pathfinding process. ### Method Method in class ### Endpoint N/A (Class method) ``` -------------------------------- ### size Source: https://docs.pathetic.site/index-all.html Returns the number of elements in the heap or iterable. ```APIDOC ## size() ### Description Returns the number of elements currently in the heap or the specified iterable. ### Method `size()` or `size(Iterable iterable)` ### Parameters * **iterable** (Iterable) - The iterable to get the size of (optional, for static method). ``` -------------------------------- ### getPathfindingProgress Source: https://docs.pathetic.site/index-all.html Retrieves the current progress of the pathfinding operation. ```APIDOC ## getPathfindingProgress ### Description Retrieves the current progress of the pathfinding operation. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters None ### Response - Returns the pathfinding progress information. ``` -------------------------------- ### PathfindingSearch.orElse Source: https://docs.pathetic.site/index-all.html Executes a callback if the pathfinding operation fails or is limited. ```APIDOC ## PathfindingSearch.orElse ### Description Executes the given callback if the pathfinding operation results in a failure, abortion, length limitation, or reaching maximum iterations. ### Method Callback registration method ### Parameters - **callback** (Consumer) - The consumer to execute on failure. ### Response Example ```json { "example": "PathfindingSearch object" } ``` ``` -------------------------------- ### Pathfinder Interface Source: https://docs.pathetic.site/index-all.html Interface for pathfinding operations. ```APIDOC ## Interface: Pathfinder ### Description Interface for pathfinding operations. ### Methods - **findPath(PathPosition start, PathPosition target)** Tries to find a Path between the two `PathPosition`s. - **findPath(PathPosition start, PathPosition target, EnvironmentContext context)** Tries to find a path between the specified start and target positions within the provided environment context. ``` -------------------------------- ### PathfinderFactory.createPathfinder Source: https://docs.pathetic.site/index-all.html Creates a new Pathfinder instance with the given configuration. ```APIDOC ## PathfinderFactory.createPathfinder ### Description Creates a new `Pathfinder` instance with the given configuration. ### Method Method in interface ### Parameters - **PathfinderConfiguration** - Description ### Endpoint N/A (Interface method) ``` -------------------------------- ### HeuristicContext.targetPosition() Source: https://docs.pathetic.site/index-all.html The overall target position of the pathfinding. ```APIDOC ## targetPosition() ### Description The overall target position of the pathfinding. ### Method N/A (Java method signature) ### Response - **PathPosition** - The target position. ``` -------------------------------- ### PathfinderConfigurationBuilder.costProcessor Source: https://docs.pathetic.site/index-all.html Adds a CostProcessor to the builder. ```APIDOC ## costProcessor(List) ### Description Adds a CostProcessor to the builder. ### Method Method ### Parameters #### Path Parameters - **List** (List) - A list of CostProcessors to add. #### Query Parameters - None ### Request Example ```json { "example": "Not applicable for this method" } ``` ### Response #### Success Response (200) - **PathfinderConfigurationBuilder** - The builder instance for chaining. #### Response Example ```json { "example": "Not applicable for this method" } ``` ``` -------------------------------- ### PathfinderConfiguration.PathfinderConfigurationBuilder.maxLength Source: https://docs.pathetic.site/index-all.html Sets the maximum length for the path. ```APIDOC ## maxLength(int) ### Description Sets the maximum length for the path. ### Method Method in class ### Parameters #### Path Parameters - **maxLength** (int) - The maximum length. ### Class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder ``` -------------------------------- ### PathPosition.of Source: https://docs.pathetic.site/index-all.html Creates a new PathPosition instance with the specified coordinates. ```APIDOC ## PathPosition.of ### Description Creates a new `PathPosition` instance with the specified coordinates. ### Method Static factory method ### Parameters - **x** (double) - The x-coordinate. - **y** (double) - The y-coordinate. - **z** (double) - The z-coordinate. ### Response Example ```json { "example": "PathPosition object" } ``` ``` -------------------------------- ### anyOf(List) Source: https://docs.pathetic.site/index-all.html Creates a `ValidationProcessor` that evaluates to `true` if any of the provided validators evaluate to `true`. ```APIDOC ## anyOf(List) ### Description Creates a `ValidationProcessor` that evaluates to `true` if any of the provided validators evaluate to `true`. ### Method Static Method ### Endpoint N/A ### Parameters - **List** (List) - Description ### Request Example None ### Response - **ValidationProcessor** (ValidationProcessor) - Description ``` -------------------------------- ### allOf(List) Source: https://docs.pathetic.site/index-all.html Creates a `ValidationProcessor` that evaluates to `true` if all of the provided validators evaluate to `true`. ```APIDOC ## allOf(List) ### Description Creates a `ValidationProcessor` that evaluates to `true` if all of the provided validators evaluate to `true`. ### Method Static Method ### Endpoint N/A ### Parameters - **List** (List) - Description ### Request Example None ### Response - **ValidationProcessor** (ValidationProcessor) - Description ``` -------------------------------- ### allOf(ValidationProcessor...) Source: https://docs.pathetic.site/index-all.html Creates a `ValidationProcessor` that evaluates to `true` if all of the provided validators evaluate to `true`. ```APIDOC ## allOf(ValidationProcessor...) ### Description Creates a `ValidationProcessor` that evaluates to `true` if all of the provided validators evaluate to `true`. ### Method Static Method ### Endpoint N/A ### Parameters - **ValidationProcessor...** (ValidationProcessor) - Description ### Request Example None ### Response - **ValidationProcessor** (ValidationProcessor) - Description ``` -------------------------------- ### getPathfinderConfiguration Source: https://docs.pathetic.site/index-all.html Convenience method to access the pathfinder configuration. ```APIDOC ## getPathfinderConfiguration ### Description Convenience method to access the pathfinder configuration. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters None ### Response - Returns the `PathfinderConfiguration` object. ``` -------------------------------- ### Resizable.capacity Source: https://docs.pathetic.site/index-all.html Returns the current capacity of the internal storage. ```APIDOC ## capacity() ### Description Returns the current capacity of the internal storage. ### Method Method ### Parameters #### Path Parameters - None #### Query Parameters - None ### Request Example ```json { "example": "Not applicable for this method" } ``` ### Response #### Success Response (200) - **int** - The current capacity. #### Response Example ```json { "example": "Not applicable for this method" } ``` ``` -------------------------------- ### anyOf(ValidationProcessor...) Source: https://docs.pathetic.site/index-all.html Creates a `ValidationProcessor` that evaluates to `true` if any of the provided validators evaluate to `true`. ```APIDOC ## anyOf(ValidationProcessor...) ### Description Creates a `ValidationProcessor` that evaluates to `true` if any of the provided validators evaluate to `true`. ### Method Static Method ### Endpoint N/A ### Parameters - **ValidationProcessor...** (ValidationProcessor) - Description ### Request Example None ### Response - **ValidationProcessor** (ValidationProcessor) - Description ``` -------------------------------- ### getEnvironmentContext Source: https://docs.pathetic.site/index-all.html Provides access to the environment-specific context for the pathfinding operation. This can contain details about the world or environment in which the pathfinding is occurring. ```APIDOC ## getEnvironmentContext ### Description Convenience method to access the EnvironmentContext of the overall search. Returns the environment-specific context associated with the pathfinding operation. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### PathPosition.mid Source: https://docs.pathetic.site/index-all.html Creates a new PathPosition with the coordinates set to the center of the block they are in. ```APIDOC ## mid() ### Description Creates a new `PathPosition` with the coordinates set to the center of the block they are in. ### Method Method in class ### Class de.bsommerfeld.pathetic.api.wrapper.PathPosition ``` -------------------------------- ### insertOrUpdate (MinHeap) Source: https://docs.pathetic.site/index-all.html Inserts a new node or updates an existing node's cost in the heap. ```APIDOC ## insertOrUpdate(long, double) ### Description Inserts a new node or updates an existing node's cost in the heap. ### Method N/A (Method signature provided) ### Parameters - **nodeId** (long) - Required - The ID of the node. - **cost** (double) - Required - The cost of the node. ``` -------------------------------- ### Depth Methods Source: https://docs.pathetic.site/index-all.html Methods related to depth. ```APIDOC ## getValue() ### Description Deprecated. `Depth.value()` ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### abort() Source: https://docs.pathetic.site/index-all.html Aborts the pathfinding operation if it is still in progress. ```APIDOC ## abort() ### Description Aborts the pathfinding operation if it is still in progress. ### Method Method ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ``` -------------------------------- ### requireOrderableCost Source: https://docs.pathetic.site/index-all.html Shared boundary check for `MinHeap.insertOrUpdate` implementations, rejecting `NaN` costs. ```APIDOC ## requireOrderableCost(long id, double cost) ### Description Shared boundary check for `MinHeap.insertOrUpdate(long, double)` implementations: rejects `NaN` costs as documented there. ### Method Static Method ### Endpoint N/A (Interface Method) ``` -------------------------------- ### add(double, double, double) Source: https://docs.pathetic.site/index-all.html Creates a new `PathPosition` by adding the given values to the coordinates of this position. ```APIDOC ## add(double, double, double) ### Description Creates a new `PathPosition` by adding the given values to the coordinates of this position. ### Method Method ### Endpoint N/A ### Parameters - **double** (double) - Description - **double** (double) - Description - **double** (double) - Description ### Request Example None ### Response - **PathPosition** (PathPosition) - Description ``` -------------------------------- ### PathPosition Methods Source: https://docs.pathetic.site/index-all.html Methods to retrieve coordinates of a path position. ```APIDOC ## getX() ### Description Returns the x-coordinate of this position. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` ```APIDOC ## getY() ### Description Returns the y-coordinate of this position. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` ```APIDOC ## getZ() ### Description Returns the z-coordinate of this position. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### getNeighborStrategy Source: https://docs.pathetic.site/index-all.html Retrieves the neighbor strategy used for pathfinding. ```APIDOC ## getNeighborStrategy ### Description Retrieves the neighbor strategy used for pathfinding. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters None ### Response - Returns the neighbor strategy configuration. ``` -------------------------------- ### PathfindingContext.currentPosition Source: https://docs.pathetic.site/index-all.html Returns the current position during the pathfinding step. ```APIDOC ## PathfindingContext.currentPosition ### Description The current position of the pathfinding step. ### Method Method in class ### Endpoint N/A (Class method) ``` -------------------------------- ### SearchContext Methods Source: https://docs.pathetic.site/index-all.html Methods to retrieve shared data and path positions from the search context. ```APIDOC ## getSharedData() ### Description Returns a mutable map that can be used by `Processor`s to share data throughout the lifecycle of this search operation. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` ```APIDOC ## getStartPathPosition() ### Description Returns the starting PathPosition of the path search. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` ```APIDOC ## getTargetPathPosition() ### Description Returns the target (or goal) PathPosition of the path search. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### SquaredHeuristicStrategy Source: https://docs.pathetic.site/index-all.html A performance-optimized heuristic strategy using squared distance metrics. ```APIDOC ## SquaredHeuristicStrategy ### Description A performance-optimized heuristic strategy using squared distance metrics. ### Class `de.bsommerfeld.pathetic.api.pathing.heuristic.SquaredHeuristicStrategy` ### Constructor `SquaredHeuristicStrategy()` ``` -------------------------------- ### Depth.of Source: https://docs.pathetic.site/index-all.html Creates a new Depth instance with the specified value. ```APIDOC ## Depth.of ### Description Creates a new `Depth` instance with the specified value. ### Method Static factory method ### Parameters - **value** (int) - The depth value. ### Response Example ```json { "example": "Depth object" } ``` ``` -------------------------------- ### PathfinderResult.successful() Source: https://docs.pathetic.site/index-all.html Returns whether the pathfinding was successful. ```APIDOC ## successful() ### Description Returns whether the pathfinding was successful. ### Method N/A (Java method signature) ### Response - **boolean** - True if pathfinding was successful, false otherwise. ``` -------------------------------- ### siftUp Source: https://docs.pathetic.site/index-all.html Moves a node up the heap until the heap property is restored. ```APIDOC ## siftUp(int) ### Description Moves a node up the heap until the heap property is restored. ### Method `siftUp(int index)` ### Parameters * **index** (int) - The index of the node to sift up. ``` -------------------------------- ### getHeuristicStrategy Source: https://docs.pathetic.site/index-all.html Retrieves the heuristic strategy used for pathfinding. ```APIDOC ## getHeuristicStrategy ### Description Retrieves the heuristic strategy used for pathfinding. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters None ### Response - Returns the heuristic strategy configuration. ``` -------------------------------- ### result Source: https://docs.pathetic.site/index-all.html Retrieves the result of the pathfinding operation if it has completed normally. ```APIDOC ## result() ### Description Retrieves the result of the pathfinding operation if it has completed normally. ### Method Method ### Endpoint N/A (Interface Method) ``` -------------------------------- ### getNavigationPointProvider Source: https://docs.pathetic.site/index-all.html Convenience method to access the navigation point provider. ```APIDOC ## getNavigationPointProvider ### Description Convenience method to access the navigation point provider. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters None ### Response - Returns the NavigationPointProvider. ``` -------------------------------- ### PathState Enum Source: https://docs.pathetic.site/index-all.html Represents the possible states of a pathfinding operation. ```APIDOC ## Enum: PathState ### Description Represents the possible states of a pathfinding operation. ### Enum Constants - **FOUND** - The Path was successfully found. - **FAILED** - The Path wasn't found, either it reached its max search depth or it couldn't find more positions. - **FALLBACK** - Signifies that the pathfinder fell back during the pathfinding attempt. ``` -------------------------------- ### AStarPathfinderFactory.createPathfinder (Deprecated) Source: https://docs.pathetic.site/index-all.html Deprecated method to create an AStarPathfinder instance without explicit configuration. Use the overload with PathfinderConfiguration. ```APIDOC ## AStarPathfinderFactory.createPathfinder (Deprecated) ### Description Deprecated. Use `AStarPathfinderFactory.createPathfinder(PathfinderConfiguration)` with an explicit configuration that supplies a real `NavigationPointProvider`. ### Method Method in class ### Endpoint N/A (Class method) ``` -------------------------------- ### getParent Source: https://docs.pathetic.site/index-all.html Retrieves the parent node. ```APIDOC ## getParent ### Description Retrieves the parent node. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters None ### Response - Returns the parent node. ``` -------------------------------- ### PathfinderFactory.createPathfinder (Deprecated) Source: https://docs.pathetic.site/index-all.html Deprecated method to create a Pathfinder instance without explicit configuration. Use the overload with PathfinderConfiguration. ```APIDOC ## PathfinderFactory.createPathfinder (Deprecated) ### Description Deprecated. Use `PathfinderFactory.createPathfinder(PathfinderConfiguration)` with an explicit configuration that supplies a real `NavigationPointProvider`. Calling this no-arg overload almost always indicates a misconfiguration. ### Method Method in interface ### Endpoint N/A (Interface method) ``` -------------------------------- ### getPath Source: https://docs.pathetic.site/index-all.html Returns the found `Path` regardless if successful or not. ```APIDOC ## getPath ### Description Returns the found `Path` regardless if successful or not. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters None ### Response - Returns the `Path` object. ``` -------------------------------- ### registerPathfindingHook (Deprecated) Source: https://docs.pathetic.site/index-all.html Registers a pathfinding hook. This method is deprecated and should be replaced by configuring hooks via PathfinderConfiguration. ```APIDOC ## registerPathfindingHook(PathfinderHook hook) ### Description Deprecated. Use `PathfinderConfiguration.PathfinderConfigurationBuilder.pathfindingHooks(java.util.List)` to configure hooks in the `PathfinderConfiguration` instead. ### Method Method ### Endpoint N/A (Interface/Class Method) ``` -------------------------------- ### Path.length Source: https://docs.pathetic.site/index-all.html Returns the length of the Path compiled from the number of positions. ```APIDOC ## length() ### Description The length of the Path compiled from the number of positions. ### Method Method in interface ### Interface de.bsommerfeld.pathetic.api.pathing.result.Path ``` -------------------------------- ### getCurrentNodeDepth Source: https://docs.pathetic.site/index-all.html Retrieves the depth of the current path position within the search tree. This is essential for understanding the progress and structure of the pathfinding algorithm's exploration. ```APIDOC ## getCurrentNodeDepth ### Description Returns the depth of the `current PathPosition` in the search tree. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### setGCost Source: https://docs.pathetic.site/index-all.html Sets the calculated G-cost for this node. ```APIDOC ## setGCost(double) ### Description Sets the calculated G-cost for this node. ### Method `setGCost(double cost)` ### Parameters * **cost** (double) - The G-cost to set for the node. ``` -------------------------------- ### DistanceCalculator.calculate Source: https://docs.pathetic.site/index-all.html Calculates and returns the distance metric for the given pathfinding progress. ```APIDOC ## calculate(PathfindingProgress) ### Description Calculates and returns the distance metric for the given pathfinding progress. ### Method Method ### Parameters #### Path Parameters - **PathfindingProgress** (PathfindingProgress) - The progress of the pathfinding. #### Query Parameters - None ### Request Example ```json { "example": "Not applicable for this method" } ``` ### Response #### Success Response (200) - **double** - The calculated distance metric. #### Response Example ```json { "example": "Not applicable for this method" } ``` ``` -------------------------------- ### setX Source: https://docs.pathetic.site/index-all.html Creates a new PathPosition or PathVector with the x-coordinate set to the given value. ```APIDOC ## setX(double) ### Description Creates a new `PathPosition` or `PathVector` with the x-coordinate set to the given value. ### Method `setX(double x)` ### Parameters * **x** (double) - The new x-coordinate value. ``` -------------------------------- ### getHeuristicWeights Source: https://docs.pathetic.site/index-all.html Retrieves the heuristic weights used for pathfinding calculations. ```APIDOC ## getHeuristicWeights ### Description Retrieves the heuristic weights used for pathfinding calculations. ### Method GET (assumed, as it's a getter method) ### Endpoint N/A (This is a method call, not an HTTP endpoint) ### Parameters None ### Response - Returns the heuristic weights configuration. ``` -------------------------------- ### CostProcessor.calculateCostContribution Source: https://docs.pathetic.site/index-all.html Calculates the cost contribution of this processor for the transition to the current node (PathPosition). ```APIDOC ## calculateCostContribution(EvaluationContext) ### Description Calculates the cost contribution of this processor for the transition to the current node (PathPosition). ### Method Method ### Parameters #### Path Parameters - **EvaluationContext** (EvaluationContext) - The context for evaluating the cost. #### Query Parameters - None ### Request Example ```json { "example": "Not applicable for this method" } ``` ### Response #### Success Response (200) - **double** - The calculated cost contribution. #### Response Example ```json { "example": "Not applicable for this method" } ``` ``` -------------------------------- ### PathVector Methods Source: https://docs.pathetic.site/index-all.html Methods to retrieve components of a path vector. ```APIDOC ## getX() ### Description Returns the x-component of this vector. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` ```APIDOC ## getY() ### Description Returns the y-component of this vector. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` ```APIDOC ## getZ() ### Description Returns the z-component of this vector. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### MinHeap.contains Source: https://docs.pathetic.site/index-all.html Checks if a specific node is currently in the heap. ```APIDOC ## contains(long) ### Description Checks if a specific node is currently in the heap. ### Method Method ### Parameters #### Path Parameters - **long nodeId** (long) - The ID of the node to check. #### Query Parameters - None ### Request Example ```json { "example": "Not applicable for this method" } ``` ### Response #### Success Response (200) - **boolean** - True if the node is in the heap, false otherwise. #### Response Example ```json { "example": "Not applicable for this method" } ``` ``` -------------------------------- ### getBaseTransitionCost Source: https://docs.pathetic.site/index-all.html Retrieves the base cost for transitioning between two path positions. This is useful for understanding the fundamental cost of movement in the pathfinding process. ```APIDOC ## getBaseTransitionCost ### Description Returns the base traversal cost for the transition from the `previous PathPosition` to the `current PathPosition`. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### PathImpl.length Source: https://docs.pathetic.site/index-all.html Calculates the length of the path. ```APIDOC ## length() ### Description Calculates the length of the path. ### Method Method in class ### Class de.bsommerfeld.pathetic.engine.result.PathImpl ``` -------------------------------- ### setY Source: https://docs.pathetic.site/index-all.html Creates a new PathPosition or PathVector with the y-coordinate set to the given value. ```APIDOC ## setY(double) ### Description Creates a new `PathPosition` or `PathVector` with the y-coordinate set to the given value. ### Method `setY(double y)` ### Parameters * **y** (double) - The new y-coordinate value. ```