API reference

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

I

interfacePathResult

@codexo/exojs-pathfinding / pathfinding / stable

Result of Pathfinder.findPath and Pathfinder.findPathBetween.

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

Result of Pathfinder.findPath and Pathfinder.findPathBetween.

Properties7
cost: number
Total traversal cost of nodes. Smoothing does not change it.
edges: readonly PathEdgeOne traversal step of a path, as described by the space it came from. Spaces that model traversal kinds - WaypointGraph is the one in this package - report the…<Payload>[]
Traversal steps for spaces that describe them, empty otherwise. Not filled for smoothed paths, whose steps are no longer space edges.
expandedNodes: number
Nodes taken off the open list. Useful for sizing maxExpandedNodes.
nodes: readonly number[]
Node ids from start to goal inclusive. Consecutive entries are adjacent in the space unless the path was smoothed, which removes intermediate nodes by design.
points: readonly VectorConcrete mutable 2D vector with full AbstractVector arithmetic and Collidable collision support (treated as a point collider). `Vector.temp` provides a shared…[]
nodes mapped through the space's node-to-point conversion.
revision: number
space.revision at search time. Compare it against the space's current revision to detect a path that the world has invalidated since.
status: PathStatusOutcome of a path query. - `found` - a complete path from start to goal (or, with `snapToNearest`, to the reachable node closest to the goal). - `unreachable`…
Source
packages/exojs-pathfinding/src/types.ts