@adatechnology/game-items-three 0.1.4 → 0.1.6

package/README.md

@@ -20,3 +20,8 @@ scene.add(buildItemLod(THREE, items.get('hammer')).root)  // merged, with LOD an
 ```
 
 three.js is a peer dependency (`^0.160`). The global of the IIFE build is `GameItemsThree`.
+
+The geometry comes from [`game-shapes`](../game-shapes): the kit's `T` is `shapeGeometries(THREE)`, so the ported builders keep writing
+`new T.CylinderGeometry(...)` and get the same bytes from game-shapes' template cache (a tube still comes from three), and `mergeItem` joins on
+`game-shapes-three`. `tests/exact-golden.test.ts` holds every bit of the 24 models and 25 shapes (alone, merged, half detail, LOD) as the old
+path made them.

package/dist/index.d.ts

@@ -16,7 +16,9 @@ interface ItemMaterialData {
 type Vec3Tuple = readonly [number, number, number];
 /**
  * The helpers the showcase page defines before its models (`M`, `mesh`, `cyl`, `bx`, `lathe`, `torus`, `extrude`, `G` and the seven material makers), so that the
- * builders ported from the page read the same as the originals. `T` is the three.js the kit was made with; `materials` lists every material it made, in order.
+ * builders ported from the page read the same as the originals. `T` is the three.js the kit was made with, with its box, cylinder, cone, sphere, plane, lathe, torus and
+ * (straight-edged) extrude geometries made by game-shapes (`shapeGeometries`: the same bytes, the same classes, a template cache); `materials` lists every material it made,
+ * in order.
  */
 interface ItemKit {
     readonly T: Three;
@@ -38,7 +40,7 @@ interface ItemKit {
     glass(color: number, opacity: number): THREE_NS.MeshStandardMaterial;
 }
 /** The helpers of the showcase page on a given three.js; every kit has its own list of materials. */
-declare function createItemKit(T: Three): ItemKit;
+declare function createItemKit(three: Three): ItemKit;
 
 /** 0 new, 1 used, 2 spoiled (the three stages of the showcase). */
 type WearStage = 0 | 1 | 2;