@adatechnology/game-floorplan-three 0.4.2 → 0.6.0

package/README.md

@@ -58,7 +58,7 @@ const shelf = furnitureSpec(THREE, 'bookcase') // 1.2 x 0.35 x 2 m: uprights, ba
 world.add(shelf.spec, { id: 'shelf', position: [-3.5, 0, 0] })
 scene.add(shelf.build(THREE)) // meshes named by part id
 const table = furnitureSpec(THREE, 'dining_table', { w: 1.6, d: 0.8, h: 0.78, options: { chairs: false } })
-table.top // { part: 'wood_0', y: 0.78 }: what loose things rest on
+table.top // { part: 'wood_0_b2', y: 0.78, parts: ['wood_0_b0', ...] }: what loose things rest on (a solid wooden top is boards: it breaks board by board where it is hit)
 ```
 
 `tapSpec(THREE, { kind: 'counter' | 'wall', reach? })` does the same for the team's tap (`counterTap` of the sink, `wallTap` of the laundry tub): the steel parts of the base, column, spout and lever, and `spout`, where the water thread starts (the thread itself is not drawn).

package/dist/index.d.ts

@@ -577,9 +577,11 @@ interface FurnitureSpecResult {
     /** Draws the piece: one mesh per part, named by the part id, coloured as the builder coloured it. */
     build(THREE: any): any;
     /** The widest high horizontal part and the height of its upper face (what loose things rest on), or null when the piece has none. */
+    /** What loose things rest on. A solid top is boards: `parts` are all of them, `part` the one in the middle. */
     top: {
         part: string;
         y: number;
+        parts?: string[];
     } | null;
     /** Size the piece was drawn at. */
     size: {
@@ -599,7 +601,8 @@ interface FurnitureSpecResult {
  * Materials: `wood` is `wood_hard`, and `wood_soft` for thin boards and panels (under 3.5 cm); `metal` is `steel`; `fabric`, `glass` and `plant` keep
  * their name; `plain` is `plastic`, or `paper` for shelves and racks (their books and boxes). Parts that touch the floor are anchored. Joints come from
  * `inferJoints` (screws between wood, welds or bolts between metal...), except that paper rests on what it lies on with a `resting` joint (weak: it falls when
- * the board breaks) and is not joined to its neighbours.
+ * the board breaks) and is not joined to its neighbours. Shelves and racks stand as a carcass: the sides carry, each shelf needs both of its ends
+ * held, and the back panel carries nothing, so a broken side drops the shelves it held, with their books.
  *
  * @example
  * const { spec, build, top } = furnitureSpec(THREE, 'bookcase') // 1.2 x 0.35 x 2 m, boards and books
@@ -648,6 +651,15 @@ interface WallPiece {
     readonly spec: any;
     /** Draws the wall with the house renderer: meshes carry `userData.destructionPart` of their part, in the space of the spec. */
     build(THREE: any): any;
+    /**
+     * Once a drawing from `build` is in a destruction world as `objectId` (with this `spec`), the house renderer follows its events and draws on it what
+     * a generic destruction renderer cannot: the bricks that shots and blows knock out (`chip`) and the opening of a breach, as gaps in the wall's
+     * courses. `restore` puts the wall back (after `world.reset`), `dispose` stops following.
+     */
+    follow(root: any, world: any, objectId: string): {
+        restore(): void;
+        dispose(): void;
+    } | null;
 }
 /**
  * The plan of a free-standing wall along x, centred on the origin: a one-storey plan whose only wall is exterior on both sides, with the masonry construction of