API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceGridSpaceOptions

@codexo/exojs-pathfinding / pathfinding / stable

Construction options for GridSpace.

6
props
0
methods
0
events
Import
import { GridSpaceOptions } from '@codexo/exojs-pathfinding'

Construction options for GridSpace.

Properties6
cellOriginX?: number
World x of cell 0's left edge, before the window origin. Defaults to 0.
cellOriginY?: number
World y of cell 0's top edge, before the window origin. Defaults to 0.
cellSize?: number
World size of one cell. The distance metric assumes square cells, so a tilemap with non-square tiles has to pick one axis. Defaults to 1.
diagonals?: DiagonalPolicyHow diagonal steps are allowed on a GridSpace. - `never` - four-connected movement only. - `no-corner-cutting` - a diagonal step needs both cells it passes bet…
Defaults to 'no-corner-cutting'.
originX?: number
Cell x of the window's left column. Defaults to 0.
originY?: number
Cell y of the window's top row. Defaults to 0.
Source
packages/exojs-pathfinding/src/spaces/GridSpace.ts