FindPathOptions
Defined in: src/modules/pathfinding/pathfinding.ts:8
Inputs to findPath: from/to and a traversable test, plus optional cost, heuristic, neighbors, and maxCost overrides.
Properties
Section titled “Properties”
optionalcost?: (fromX,fromY,toX,toY) =>number
Defined in: src/modules/pathfinding/pathfinding.ts:14
Per-edge cost. Defaults to 2 cardinal / 3 diagonal.
Parameters
Section titled “Parameters”number
number
number
number
Returns
Section titled “Returns”number
from:
PathNode
Defined in: src/modules/pathfinding/pathfinding.ts:9
heuristic?
Section titled “heuristic?”
optionalheuristic?: (ax,ay,bx,by) =>number
Defined in: src/modules/pathfinding/pathfinding.ts:16
Heuristic estimate (admissible for A* optimality). Defaults to Chebyshev using default cost weights.
Parameters
Section titled “Parameters”number
number
number
number
Returns
Section titled “Returns”number
maxCost?
Section titled “maxCost?”
optionalmaxCost?:number
Defined in: src/modules/pathfinding/pathfinding.ts:11
Abort and return null if accumulated g exceeds this. Defaults to Infinity.
neighbors?
Section titled “neighbors?”
optionalneighbors?: (x,y) =>Iterable<PathNode>
Defined in: src/modules/pathfinding/pathfinding.ts:18
Iterable of neighbor candidates from (x, y). Defaults to 8-directional.
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”Iterable<PathNode>
to:
PathNode
Defined in: src/modules/pathfinding/pathfinding.ts:12
traversable
Section titled “traversable”traversable: (
x,y) =>boolean
Defined in: src/modules/pathfinding/pathfinding.ts:20
Returns true if the given tile can be stood on / traversed.
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”boolean