@xtia/grid 0.0.5 → 0.0.6

package/README.md

@@ -22,7 +22,7 @@ npm i @xtia/grid
 ```
 
 ```ts
-import { Grid } from "@xtia/grid"; // ~5.3kb gzipped
+import { Grid } from "@xtia/grid"; // ~4.8kb gzipped
 
 // initialise a 30x20 Grid<number> of 0's
 const numGrid = Grid.solid(30, 20, 0);
@@ -46,6 +46,34 @@ const source = imagePipe
 const grid = Grid.from(source);
 ```
 
+### Wrapping existing structures
+
+Use Grid's interface over any read/write 2D structure:
+
+```ts
+const gameMap = [
+	[0, 1, -1, 2],
+	[1, 0, 1, 0],
+	[-1, 1, 0, 2],
+	[2, 0, 2, -1]
+];
+
+// create a *live view* Grid over gameMap
+const grid = Grid.wrap(
+	gameMap[0].length, // width
+	gameMap.length, // height
+	(x, y) => gameMap[y][x], // get
+	(x, y, value) => gameMap[y][x] = value // set
+);
+
+// reading the grid = reading the source
+gameMap[0][0] = 50;
+console.log(grid.get(0, 0)); // 50
+// writing to the grid = writing to the source
+grid.set(3, 3, 100);
+console.log(gameMap[3][3]); // 100
+```
+
 ## Regions
 
 Use `grid.region(x, y, w, h)` to define a subgrid. The subgrid is **zero-copy view** into the parent; changes to the subgrid affect the parent and vice-versa.
@@ -176,7 +204,7 @@ const pathToCentre = pathMap.get(50, 50);
 const pathToCorner = pathMap.get(99, 99);
 ```
 
-Unlike visibility maps, which are lazily evaluated according to the supplied `isWall` function *when the map is queried*, path maps necessarily reflect the underlying data *when the map is created*. This distinction is hinted through the `create*` vs `get*` naming.
+Unlike visibility maps, which are lazily evaluated according to the supplied `isClear` function *when the map is queried* (but can be easily cached with `visMap.withCache()`), path maps use a relatively expensive traversal map that's created *when the map is created*. This distinction is hinted through the `create*` vs `get*` naming.
 
 ## The storage layer
 

package/lib/grid.d.ts

@@ -77,6 +77,7 @@ export declare class Grid<T> {
     static init<T>(width: number, height: number, initCell: (x: number, y: number) => T): GridBase<T>;
     static from<T>(source: Source2D<T>): GridBase<T>;
     static solid<T>(width: number, height: number, fillValue: T): GridBase<T>;
+    static wrap<T>(width: number, height: number, get: (x: number, y: number) => T, set: (x: number, y: number, value: T) => void, batch?: (callback: () => void) => void): Grid<T>;
 }
 export declare class GridBase<T> extends Grid<T> {
     private data;

package/lib/grid.js

@@ -314,6 +314,9 @@ export class Grid {
     static solid(width, height, fillValue) {
         return new GridBase(Pipe2D.solid(fillValue, width, height));
     }
+    static wrap(width, height, get, set, batch = cb => cb()) {
+        return new Grid(width, height, get, set, batch);
+    }
 }
 export class GridBase extends Grid {
     triggerEvent(name, data) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "2D store and utilities, with zero-copy regions and transform layers, pathfinding, Pipe2D interop",
   "name": "@xtia/grid",
   "exports": {
@@ -9,6 +9,7 @@
     },
     "./lib/*": null
   },
+  "keywords": ["grid", "game-dev", "pathfinding", "cellular-automata"],
   "scripts": {
     "build": "npx tsc",
     "test": "npx vitest run"