Class GridCell<PropertiesType>

Represents a grid cell with coordinates and properties.

Type Parameters

PropertiesType extends object = UnknownObject
The type of the properties of the grid cell.

Index

Constructors

Properties

getValue properties setValue x y

Accessors

Methods

direction down get left right set translate up

Constructors

constructor

new GridCell<PropertiesType>(x, y, props?, gridSymbol): GridCell<PropertiesType>
Initializes a new instance of the grid cell. Note: The properties are copied using object spread to prevent reference sharing. This may break with getters and setters.
Type Parameters
- PropertiesType extends object = UnknownObject
Parameters
- x: number
  The x-coordinate.
- y: number
  The y-coordinate.
- props: PropertiesType | ((grid: GridCell<PropertiesType>) => PropertiesType) = ...
  The properties to initialize with.
- gridSymbol: symbol
  The symbol of the grid the cell belongs to.
Returns GridCell<PropertiesType>
- Defined in classes/Grid.ts:51

Properties

getValue

getValue: ((name: keyof PropertiesType) => PropertiesType[keyof PropertiesType]) = ...

Type declaration

- (name): PropertiesType[keyof PropertiesType]
- Gets the value of a property on the cell.
  Parameters
  - name: keyof PropertiesType
    The name of the property.
  Returns PropertiesType[keyof PropertiesType]
  - The value of the property.

Deprecated

Use get instead.

properties

properties: PropertiesType

The properties of the cell.

setValue

setValue: ((name: keyof PropertiesType, value: PropertiesType[keyof PropertiesType]) => PropertiesType[keyof PropertiesType]) = ...

Type declaration

- (name, value): PropertiesType[keyof PropertiesType]
- Sets the value of a property on the cell.
  Parameters
  - name: keyof PropertiesType
    The name of the property.
  - value: PropertiesType[keyof PropertiesType]
    The value to set.
  Returns PropertiesType[keyof PropertiesType]
  The set value.

Deprecated

Use set instead.

x

x: number

The x-coordinate of the cell.

y

y: number

The y-coordinate of the cell.

Accessors

grid

get grid(): Grid<PropertiesType>
Returns Grid<PropertiesType>
The grid instance the cell belongs to.
- Defined in classes/Grid.ts:36

Methods

direction

direction<D>(direction, distance?, fill?): D extends GridDirectionCollection
? GridCellCollection<PropertiesType>
: GridCell<PropertiesType>
Gets the cell in a specific direction from the current cell.
Type Parameters
- D extends GridDirection
Parameters
- direction: D
  The direction to move.
- distance: number = 1
  The distance to move. Defaults to 1.
- Optionalfill: boolean
  Whether to fill the cells. Defaults to false.
Returns D extends GridDirectionCollection
? GridCellCollection<PropertiesType>
: GridCell<PropertiesType>
- The cell in the specified direction.
- Defined in classes/Grid.ts:108

down

down(distance?): GridCell<PropertiesType>
Gets the cell below the current cell. Can be chained.
Parameters
- distance: number = 1
  The distance to move. Defaults to 1.
Returns GridCell<PropertiesType>
- The cell below.
- Defined in classes/Grid.ts:162

get

get(name): PropertiesType[keyof PropertiesType]
Gets the value of a property on the cell.
Parameters
- name: keyof PropertiesType
  The name of the property.
Returns PropertiesType[keyof PropertiesType]
- The value of the property.
- Defined in classes/Grid.ts:83

left

left(distance?): GridCell<PropertiesType>
Gets the cell to the left of the current cell. Can be chained.
Parameters
- distance: number = 1
  The distance to move. Defaults to 1.
Returns GridCell<PropertiesType>
- The cell to the left.
- Defined in classes/Grid.ts:171

right

right(distance?): GridCell<PropertiesType>
Gets the cell to the right of the current cell. Can be chained.
Parameters
- distance: number = 1
  The distance to move. Defaults to 1.
Returns GridCell<PropertiesType>
- The cell to the right.
- Defined in classes/Grid.ts:153

set

set(name, value): PropertiesType[keyof PropertiesType]
Sets the value of a property on the cell.
Parameters
- name: keyof PropertiesType
  The name of the property.
- value: PropertiesType[keyof PropertiesType]
  The value to set.
Returns PropertiesType[keyof PropertiesType]
The set value.
- Defined in classes/Grid.ts:71

translate

translate(x?, y?): GridCell<PropertiesType>
Gets the cell a specified distance away from the current cell.
Parameters
- x: number = 0
  The x distance to move
- y: number = 0
  The y distance to move
Returns GridCell<PropertiesType>
The translated cell
- Defined in classes/Grid.ts:97

up

up(distance?): GridCell<PropertiesType>
Gets the cell to the right of the current cell. Can be chained.
Parameters
- distance: number = 1
  The distance to move. Defaults to 1.
Returns GridCell<PropertiesType>
- The cell to the right.
- Defined in classes/Grid.ts:144