path(row1, col1, row2, col2, directions)

Returns a shortest path between two cells as an array of {row, col} steps — excluding start, including end (the moves, not the position) — following the search return convention. Sugar over reach plus greedy descent: from the target, step to any neighbor one ring closer; the wavefront invariant guarantees such a neighbor exists. Failure is uniform: unreachable target, filled endpoint (either one), off-board endpoint, and start === end all yield an empty array.

Note

This is the backtrace half of Lee's algorithm — reach expands the wave, path walks back down the stamps. Because the invariant guarantees a lower neighbor at every step, there is no failure branch in the descent and no priority queue anywhere: the emptiness of the returned array is the only error channel.

Ties break in a fixed neighbor order, so the result is a shortest path, not the shortest path — equal-length routes are equally correct, and the one you get is stable for a given board. A* would visit fewer cells for a single query; reach-then-descend is the deliberate trade, since the field is reusable across targets and agents.

Example

(move the mouse to lead the 🐭; click to regenerate the maze)

edit, then run

Note

The 🐭 sits at (0, 0) — always open in a generated maze — and the trail redraws each frame from path's answer. Hover a wall, leave the board, or hover the 🐭 itself and the trail vanishes: failure is uniformly the empty array, with no special cases to test for.

Note

The docs say a shortest path, not the: ties are broken deterministically by neighbor order, and other equally short paths may exist. Like reach, path works on any quadrille — filled cells are obstacles — so move validity on a game board is simply the emptiness of the answer: board.path(row1, col1, row2, col2).length. No separate predicate exists, on purpose.

Note

directions mirrors flood fill: 4 (default) or 8 (corner-cutting); other values warn and fall back to 4.

Syntax

path(row1, col1, row2, col2, [directions = 4])

Parameters

Param Description
row1 Number: start row index [0..height]
col1 Number: start column index [0..width]
row2 Number: target row index [0..height]
col2 Number: target column index [0..width]
directions Number: neighborhood, 4 (default) or 8 (corner-cutting); other values warn and fall back to 4
What this page's examples use
p5.quadrille
drawQuadrille createQuadrille cellLength mouseRow mouseCol fill clear maze path
p5.js
createCanvas background color

Names the analysis can prove are called, and the line each one is documented on. Local variables and members of an unknown receiver are left out.