API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceFindPathOptions

@codexo/exojs-pathfinding / pathfinding / stable

Options for Pathfinder.findPath and Pathfinder.findPathBetween.

5
props
0
methods
0
events
Import
import { FindPathOptions } from '@codexo/exojs-pathfinding'

Options for Pathfinder.findPath and Pathfinder.findPathBetween.

Properties5
agentSize?: number
Agent width in nodes. Spaces that model clearance restrict expansion to nodes where an agent this wide fits; spaces that do not ignore it. Defaults to 1.
maxExpandedNodes?: number
Stop after this many expanded nodes and return the best partial path with status budget-exceeded. Defaults to 0, meaning no budget - a search over a finite space terminates regardless.
pruning?: boolean
Allow the space to substitute a pruned expansion (jump-point search on uniform grids) for plain neighbour expansion. Both produce a cost-optimal path; pruning expands far fewer nodes. Defaults to true.
smooth?: boolean
Run the space's path smoother over the result. No-op for spaces that implement none. Defaults to false.
snapToNearest?: boolean
When the goal cannot be reached, return the path to the reachable node closest to it instead of unreachable. For coordinate queries this also resolves a goal point outside the space to the space's nearest node. Defaults to false.
Source
packages/exojs-pathfinding/src/types.ts