Class CoordMap<D, V>

constructor

• new CoordMap<D extends number[], V = unknown>(): CoordMap<D, V>

  Type Parameters

  • D extends number[]
  • V = unknown

  Returns CoordMap<D, V>

[toStringTag]

size

• get size(): number

  Get the number of set coordinates.

  Returns number

  the number of items.

[iterator]

• "[iterator]"(): MapIterator<[D, V]>

  Allow CoordMap to be iterated on.

  Returns MapIterator<[D, V]>

  Yields

clear

• clear(): void

  Clear all elements from the coordinates.

  Returns void

delete

• delete(coordinates: D): boolean

  Delete the element at the coordinate.

  Parameters

  • coordinates: D

    The coordinates to delete from the space.

  Returns boolean

  true if an element in the Map existed and has been removed, or false if the element does not exist.

forEach

• forEach(
      callbackfn: (value: V, key: D, map: Map<D, V>) => void,
      thisArg?: unknown,
  ): void

  Executes a provided function once per each key/value pair in the CoordMap, in insertion order.

  Parameters

  • callbackfn: (value: V, key: D, map: Map<D, V>) => void

    The function to call over each element.

  • OptionalthisArg: unknown

    the element representing this

  Returns void

has

• has(coordinates: D): boolean

  Determine if coordinates are set with a value.

  Parameters

  • coordinates: D

    The coordinates to check.

  Returns boolean

  boolean indicating whether an element with the specified key exists or not.

entries

• entries(): MapIterator<[D, V]>

  Returns an iterable of key, value pairs for every entry in the map.

  Returns MapIterator<[D, V]>

  Yields

keys

• keys(): MapIterator<D>

  Returns an iterable of key for every entry in the map.

  Returns MapIterator<D>

  Yields

values

• values(): MapIterator<V>

  Returns an iterable of values for every entry in the map.

  Returns MapIterator<V>

  Yields

get

• get(coordinates: D): V | undefined

  Get the value at the provided point in space.

  Parameters

  • coordinates: D

    The coordinates to retrieve from the space.

  Returns V | undefined

  the value stored at the point.

getByOffset

• getByOffset(
      dimensions: number,
      dimension: number,
      offset: -1 | 1,
  ): V | undefined

  Get the value at the provided offset.

  Parameters

  • dimensions: number

    The number of dimensions

  • dimension: number

    The dimension to get the offset

  • offset: -1 | 1

    The amount of offset

  Returns V | undefined

  the value stored at the offset

set

• set(coordinates: D, value: V): this

  Set the value at the provided point in space.

  Parameters

  • coordinates: D

    The coordinates to set a value.

  • value: V

    The value to set.

  Returns this

  this CoordMap instance.

getNeighbors

• getNeighbors(coordinates: D): BeforeAfter<D, V>[]

  Get all the neighbors of a coordinate.

  Parameters

  • coordinates: D

    The coordinates to convert.

  Returns BeforeAfter<D, V>[]

  a tupled array of Dimensions, Before/After, and Coordinate/Value pairs.

fill

• fill(generator: (coord: D) => V, start: D, end: D): this

  Fill the CoordinateMap with a predefined value. Always square.

  Parameters

  • generator: (coord: D) => V

    Function returning a value to fill.

  • start: D

    the minimum size of the area to fill.

  • end: D

    the maximum size of the area to fill.

  Returns this

  this CoordMap instance.

toJSON

• toJSON(): Record<string, V>

  Convert coordinate map to a simple object for storage and testing.

  Returns Record<string, V>

  An object representing all coordinates in the map. Keys are comma delineated coordinates.