Skip to content

spatial-monorepo


spatial-monorepo / wayfinding/src / LadderGridRouteResult

Type Alias: LadderGridRouteResult

LadderGridRouteResult = { cells: GridCell[]; coordinates: Position2D[]; found: true; grid: OccupancyGrid; rung: string; snapped?: { destination?: boolean; origin?: boolean; }; } | { found: false; grid: OccupancyGrid; reason: "no-path" | "origin-outside-grid" | "destination-outside-grid"; }

Defined in: packages/wayfinding/src/grid-types.ts:292

Union Members

Type Literal

{ cells: GridCell[]; coordinates: Position2D[]; found: true; grid: OccupancyGrid; rung: string; snapped?: { destination?: boolean; origin?: boolean; }; }

cells

cells: GridCell[]

coordinates

coordinates: Position2D[]

found

found: true

grid

grid: OccupancyGrid

rung

rung: string

Name of the rung (from ladder) that produced this route.

snapped?

optional snapped?: object

Set when the origin and/or destination had to be spiral-snapped to the nearest walkable cell.

snapped.destination?

optional destination?: boolean

snapped.origin?

optional origin?: boolean


Type Literal

{ found: false; grid: OccupancyGrid; reason: "no-path" | "origin-outside-grid" | "destination-outside-grid"; }

Released under commercial licensing.