Skip to main content

generatePath

Pathfinding function that computes a grid path between start and end cells.

TypePathFindingFunction
DefaultpathfindingAStarDiagonal (bezier/straight presets)

Built-in functions

ExportBehavior
pathfindingAStarDiagonalA* with diagonal moves (SmartBezierEdge, SmartStraightEdge)
pathfindingAStarNoDiagonalOrthogonal-only A* (custom edges)
pathfindingJumpPointNoDiagonalJump-point search, no diagonals (SmartStepEdge)
import {
getSmartEdge,
pathfindingJumpPointNoDiagonal,
} from "@tisoap/react-flow-smart-edge";

const result = getSmartEdge({
/* ... */
options: { generatePath: pathfindingJumpPointNoDiagonal },
});

Signature

type PathFindingFunction = (
grid: Grid,
start: XYPosition,
end: XYPosition,
) => number[][];

See generatePath.ts source.