getPathLength

getPathLength

> Functions

Returns the length of a path between cell1 and cell2 that avoids occupied cells, except ignoredCells which are considered empty even when an entity is present. This function is equivalent to count(getPath(cell1, cell2, ignoredCells)).

The starting cell cell1 is never counted in the result. The destination cell cell2 is counted in the result if and only if it is empty or ignored by ignoredCells.

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

Parameters

• cell1: Cell id of starting point.
• cell2: Cell id of destination.
• ignoredCells: Array of cells considered inoccupied even when an entity is present. By default an empty array.

Return

• length
• If a path exists: length of the path between cell1 and cell2.
• If the path was not found: null.