Class Grid<PropertiesType>

constructor

• new Grid<PropertiesType>(xSize, ySize?, starterProps?): Grid<PropertiesType>

• Initializes a new instance of the grid.

  Type Parameters

  • PropertiesType extends object = UnknownObject

  Parameters

  • xSize: number

    The size of the grid along the x-axis.
  • OptionalySize: number

    The size of the grid along the y-axis. Defaults to xSize.
  • OptionalstarterProps: PropertiesType | ((grid: GridCell<PropertiesType>) => PropertiesType)

    The properties to initialize with.

  Returns Grid<PropertiesType>

all

allX

allY

cells

get

set

xSize

ySize

getAdjacent

• getAdjacent(x, y, distance?, fill?, overflow?): GridCellCollection<PropertiesType>

• Gets an array containing all cells orthogonally adjacent to a specific cell.

  Parameters

  • x: number

    The x coordinate to check.
  • y: number

    The y coordinate to check.
  • distance: number = 1

    The distance to check. Defaults to 1.
  • fill: boolean = false

    Whether to fill the adjacent cells. Defaults to false.
  • overflow: boolean = true

    Whether to allow overflow. Defaults to true.

  Returns GridCellCollection<PropertiesType>

  • An array of all cells.

getAll

• getAll(): GridCellCollection<PropertiesType>

• Gets an array containing all cells in the grid.

  Returns GridCellCollection<PropertiesType>

  • An array of all cells.

getAllX

• getAllX(x): GridCellCollection<PropertiesType>

• Gets an array containing all cells that have the same x coordinate.

  Parameters

  • x: number

    The x coordinate to check.

  Returns GridCellCollection<PropertiesType>

  • An array of all cells.

getAllY

• getAllY(y): GridCellCollection<PropertiesType>

• Gets an array containing all cells that have the same y coordinate.

  Parameters

  • y: number

    The y coordinate to check.

  Returns GridCellCollection<PropertiesType>

  • An array of all cells.

getCell

• getCell<O>(x, y, overflow?): O extends true
      ? GridCell<PropertiesType>
      : undefined | GridCell<PropertiesType>

• Gets a cell.

  Type Parameters

  • O extends boolean = true

    Whether to allow overflow. Defaults to true. If false, the cell can exist or be undefined.

  Parameters

  • x: number

    The x coordinate to check.
  • y: number

    The y coordinate to check.
  • overflow: O = ...

    Whether to allow overflow. Defaults to true.

  Returns O extends true
      ? GridCell<PropertiesType>
      : undefined | GridCell<PropertiesType>

  • The cell.

getDiagonal

• getDiagonal(x, y, distance?, fill?, overflow?): GridCellCollection<PropertiesType>

• Gets an array containing all cells diagonally adjacent from a specific cell.

  Parameters

  • x: number

    The x coordinate to check.
  • y: number

    The y coordinate to check.
  • distance: number = 1

    The distance to check. Defaults to 1.
  • fill: boolean = false

    Whether to fill the diagonal. Defaults to false.
  • overflow: boolean = true

    Whether to allow overflow. Defaults to true.

  Returns GridCellCollection<PropertiesType>

  • An array of all cells.

getEncircling

• getEncircling(x, y, distance?, fill?, overflow?): GridCellCollection<PropertiesType>

• Gets an array containing all cells that surround a cell.

  Parameters

  • x: number

    The x coordinate to check.
  • y: number

    The y coordinate to check.
  • distance: number = 1

    The distance to check. Defaults to 1.
  • fill: boolean = false

    Whether to fill the surrounding cells. Defaults to false.
  • overflow: boolean = true

    Whether to allow overflow. Defaults to true.

  Returns GridCellCollection<PropertiesType>

  • An array of all cells.

resize

• resize(xSize, ySize?): void

• Resizes the grid. Merges the cells if the new grid is bigger and truncates the cells if the new grid is smaller.

  Parameters

  • xSize: number

    The new size of the grid along the x-axis.
  • OptionalySize: number

    The new size of the grid along the y-axis. Defaults to xSize.

  Returns void

setCell

• setCell(x, y, value): void

• Sets the value of a cell in the grid.

  Parameters

  • x: number

    The x-coordinate of the cell.
  • y: number

    The y-coordinate of the cell.
  • value: GridCell<PropertiesType>

    The value to set for the cell.

  Returns void

StaticgetDistance

• getDistance(x1, y1, x2, y2): number

• Calculates the distance between two points on the grid.

  Parameters

  • x1: number

    The x-coordinate of the first point.
  • y1: number

    The y-coordinate of the first point.
  • x2: number

    The x-coordinate of the second point.
  • y2: number

    The y-coordinate of the second point.

  Returns number

  The distance between the two points.

  Deprecated

  Use your own distance function instead.

StaticgetInstance

• getInstance<T>(key): Grid<T>

• Gets the grid instance with the specified key.

  Type Parameters

  • T extends object = UnknownObject

  Parameters

  • key: symbol

    The key of the grid instance.

  Returns Grid<T>

  • The grid instance.