@adatechnology/game-destruction-three 0.1.0 → 0.1.1

package/README.md

@@ -69,7 +69,7 @@ renderer.impulse(id, [0, 40, -120], [2, 0.6, -3])
 
 `bind` finds the meshes of each part from `options.parts` (what `specFromObject3D` returns), else from `userData.destructionPart` or a mesh name that
 equals a part id, else by the part box that contains the mesh centre. `specFromObject3D` reads `userData.destructionMaterial`,
-`destructionPart`, `destructionIgnore`, `destructionTags` and `hollow`.
+`destructionPart` (a part id, or `{ id, material?, parent?, kind? }`: `parent` + `kind` attach the part to its parent with a joint of that kind), `destructionIgnore`, `destructionTags` and `hollow`.
 
 ## What each event draws
 

package/dist/index.d.ts

@@ -123,6 +123,13 @@ interface SpecFromObjectResult {
 /** Create the renderer. See `DestructionRenderer`. */
 declare function createDestructionRenderer(THREE: ThreeNamespace, options: RendererOptions): DestructionRenderer;
 
+/** What `userData.destructionPart` says: a string (the part id) or an object `{ id, material?, parent?, kind? }`. */
+interface PartHint {
+    id: string;
+    material?: string;
+    parent?: string;
+    kind?: string;
+}
 /**
  * Build a `DestructibleSpec` from a three.js object: one part per mesh (meshes sharing `userData.destructionPart` become one part), each an
  * axis-aligned box in the root's space (rotation omitted), with the material taken from `options.materialOf`, `userData.destructionMaterial`
@@ -142,4 +149,4 @@ declare function heatColor(temperatureC: number): number;
 /** Every particle kind the renderer can emit. */
 type ParticleKind = DebrisKind | 'fire' | 'flash' | 'foam';
 
-export { type BindOptions, type DestructionRenderer, type Mesh, type Object3D, type ParticleKind, type Piece, type Quality, type RendererOptions, type SpecFromObjectOptions, type SpecFromObjectResult, type ThreeNamespace, createDestructionRenderer, heatColor, specFromObject3D };
+export { type BindOptions, type DestructionRenderer, type Mesh, type Object3D, type PartHint, type ParticleKind, type Piece, type Quality, type RendererOptions, type SpecFromObjectOptions, type SpecFromObjectResult, type ThreeNamespace, createDestructionRenderer, heatColor, specFromObject3D };