getPath

getPath

> Functions

Returns the shortest path between two cells start and end that avoids obstacles, if there is one, ignoring the cells contained in the array ignoredCells.

The starting cell start is never part of the resulting path. The cell end is part of the resulting path if and only if it is empty or ignored by ignoredCells.

If no path exists between the two cells, getPath returns null.

Be careful: it is possible that getPath(start, end) != getPath(end, start).

Parameters

• start: The starting cell.
• end: The destination cell.
• ignoredCells: The array of cells to ignore. Defaults to an empty list.

Return

• path
• If a path exists: an array containing the cells that make up the path between the two cells
• If no path was found: null.

Examples

See also

• getCellDistance
• getPathLength