@adatechnology/game-destruction-three 0.9.0 → 0.11.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import * as THREE_NS from 'three';
-import { Vec3, DebrisKind, HitResult, DestructionWorld, MaterialId, DestructibleSpec } from '@adatechnology/game-destruction';
+import { Vec3, DebrisKind, HitResult, DestructionWorld, MaterialId, DestructibleSpec, MaterialDef } from '@adatechnology/game-destruction';
 export { Quat, Vec3 } from '@adatechnology/game-destruction';
+import * as THREE_NS from 'three';
 import { WarmUpProbes, BlastShoveOptions, Vec3 as Vec3$1 } from '@adatechnology/game-contracts';
 import { VfxWorld, SpriteKind } from '@adatechnology/game-vfx';
 import { LoopRecipe, SoundBank, SoundRecipe, AudioEngine } from '@adatechnology/game-audio';
@@ -121,6 +121,22 @@ interface ExplodeOptions {
      */
     readonly report?: readonly HitResult[];
 }
+/** One box of `DestructionRenderer.solidsNear`. */
+interface SolidBox {
+    readonly objectId: string;
+    readonly min: Vec3;
+    readonly max: Vec3;
+    /** The piece the box belongs to; null for a fixed object and a loose body. */
+    readonly piece: Piece | null;
+    /** A big fragment (a broken board): not a piece, but it lies there and is kicked along. */
+    readonly loose?: LooseBody;
+}
+/** A fragment big enough to be walked on (`DestructionRenderer.solidsNear`). */
+interface LooseBody {
+    readonly mass: number;
+    /** Gives it this speed on the floor (m/s). */
+    push(velocityX: number, velocityZ: number): void;
+}
 interface DestructionRenderer {
     /** Attach a world object to its three.js root. */
     bind(objectId: string, root: Object3D, options?: BindOptions): void;
@@ -131,7 +147,16 @@ interface DestructionRenderer {
         velocity?: Vec3;
     }): Piece;
     pieces(): Piece[];
+    /** What lies in the disc looks at the ground again (`groundAt` changed under it: a crater, a heap). */
+    wakeRegion(x: number, z: number, radius: number): void;
     piece(objectId: string): Piece | null;
+    /**
+     * World boxes of what is drawn around (x, z) within `radius`: each drawn mesh of a fixed object (meshes wider than 3 m and parts inside a merged
+     * mesh are left out: walls, floors, roofs), of every piece and of the big fragments, with the object's id and its piece, if it is one. A turned mesh
+     * gives several boxes along its length, so that they follow it instead of its axis box. A walking body uses it to step onto low debris, stop at what is
+     * taller and kick what is light.
+     */
+    solidsNear(x: number, z: number, radius: number): SolidBox[];
     /** Push a piece (throws, blasts). */
     impulse(objectId: string, impulse: Vec3, point?: Vec3): void;
     /** Integrate fragments, pieces and particles; apply pending visual changes. Call once per frame after `world.update`. */
@@ -182,6 +207,10 @@ interface SpecFromObjectResult {
     parts: Record<string, Object3D[]>;
 }
 
+/** Sound key for an impact on a material. */
+declare function impactKey(def: MaterialDef | undefined): string;
+/** Sound key (`drag_*`) of a base of this material dragged on a floor. */
+declare const dragSoundKey: (def: MaterialDef | undefined) => string;
 /** Create the renderer. See `DestructionRenderer`. */
 declare function createDestructionRenderer(THREE: ThreeNamespace, options: RendererOptions): DestructionRenderer;
 
@@ -219,6 +248,8 @@ declare const EXPLOSION_BOOM: SoundRecipe;
  * silent there; here `createDestructionSound` raises it while something burns (the level is the kit's, in `fire`).
  */
 declare const BURN_LOOP: LoopRecipe;
+/** Something heavy dragged on a floor, by what its base is made of. */
+declare const DRAG_SOUNDS: readonly SoundRecipe[];
 declare const DESTRUCTION_SOUND_BANK: SoundBank;
 
 /**
@@ -276,4 +307,4 @@ declare function createDestructionSound(engine: AudioEngine, options?: Destructi
 /** Every particle kind the renderer can emit (the game's sprite kinds, see `@adatechnology/game-vfx`). */
 type ParticleKind = SpriteKind;
 
-export { BURN_LOOP, type BindOptions, DEFAULT_FIRE, DESTRUCTION_SOUND_BANK, DESTRUCTION_SOUND_KEYS, type DestructionRenderer, type DestructionSound, type DestructionSoundOptions, type DestructionSoundStyle, EXPLOSION_BOOM, type ExplodeOptions, type Mesh, type MeshRange, type Object3D, type PartHint, type ParticleKind, type Piece, type Quality, type RendererOptions, SCENE_SOUNDS, type SoundKeyRule, type SpecFromObjectOptions, type SpecFromObjectResult, type ThreeNamespace, createDestructionRenderer, createDestructionSound, heatColor, specFromObject3D };
+export { BURN_LOOP, type BindOptions, DEFAULT_FIRE, DESTRUCTION_SOUND_BANK, DESTRUCTION_SOUND_KEYS, DRAG_SOUNDS, type DestructionRenderer, type DestructionSound, type DestructionSoundOptions, type DestructionSoundStyle, EXPLOSION_BOOM, type ExplodeOptions, type LooseBody, type Mesh, type MeshRange, type Object3D, type PartHint, type ParticleKind, type Piece, type Quality, type RendererOptions, SCENE_SOUNDS, type SolidBox, type SoundKeyRule, type SpecFromObjectOptions, type SpecFromObjectResult, type ThreeNamespace, createDestructionRenderer, createDestructionSound, dragSoundKey, heatColor, impactKey, specFromObject3D };