@wingit/cellmap
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

CellMap

npm npm GitHub

Spatial Hash Grid that extends Map

Features

  • ✔️ Elements are stored on a 2D grid
  • ✔️ Filter nearby elements
  • ✔️ Extends Map
  • 🟦 Written in TypeScript

Installation

Using npm

npm i @wingit/cellmap

Using bun

bun i @wingit/cellmap

Usage

import CellMap from "@wingit/cellmap";

// create a CellMap(width, height, cell size)
const units = new CellMap(100, 100, 10);

// add a unit
// set hash to -1, it is used internally and gets reassigned when added
const unit = { id: "1", hash: -1, pos: {x: 0, y: 0}, name: "Bob" };
units.set(units.id, unit);

// delete a unit
units.delete("1");

// update a unit
unit.pos.x = 35;
units.update(unit);

// get cells in range
const cellsInRange = g.ig.units.query(pos, radius);
for (const cell of cellsInRange) {
    for (const u of cell){
        console.log(u);
    }
}

License

MIT

Package Sidebar

Install

npm i @wingit/cellmap

Weekly Downloads

0

Version

1.0.3

License

MIT

Unpacked Size

7.89 kB

Total Files

5

Last publish

Collaborators

  • jgtools