@adatechnology/game-destruction-three 0.14.0 → 0.15.0

package/dist/index.d.ts

@@ -32,6 +32,10 @@ interface SoundDetail {
     readonly confinement?: number;
     /** `primed`: seconds until the vessel bursts (the gas leak lasts that long). */
     readonly seconds?: number;
+    /** `burn_loop` / `burn_end`: the material burning (`wood_hard`, `rubber`...), which picks the fire's sound. */
+    readonly material?: string;
+    /** `burn_loop` / `burn_end`: the fuel itself, when it is not a material (a gas jet, a pool of fuel). Wins over `material`. */
+    readonly fuel?: 'wood' | 'fabric' | 'plastic' | 'gas' | 'liquid';
 }
 interface RendererOptions {
     /** Scene that receives fragments, loose pieces, decals and particles. */
@@ -352,6 +356,12 @@ declare const BLAST_SOUNDS: readonly SoundRecipe[];
 declare const FIRE_SOUNDS: readonly SoundRecipe[];
 /** The roar of the fires: low, soft noise; `createDestructionSound` raises it with every part that burns and sprinkles crackles on it. */
 declare const FIRE_LOOP: LoopRecipe;
+/**
+ * What is burning, for the sound: each fuel has its own roar (a gas jet, a fuel pool, wood, plastic) and its own share of crackles. The rules are the
+ * same for all (the level grows with how much burns, fades with distance, never clips); only the timbre comes from the fuel.
+ */
+declare const FIRE_FUELS: readonly ["wood", "fabric", "plastic", "gas", "liquid"];
+type FireFuel = (typeof FIRE_FUELS)[number];
 /** The sound of a blast family. */
 declare const BLAST_SOUND_OF: Readonly<Record<BlastKind, string>>;
 
@@ -394,8 +404,14 @@ type DestructionSoundOptions = {
     };
     /** Burn loop on or off (default on). */
     readonly burnLoop?: boolean;
-    /** The fire loop played while something burns (default `fire_loop`; `burn_loop` is the art scene's bright one). */
+    /** The loop of the wood fire (default `fire_loop`; `burn_loop` is the art scene's bright one). */
     readonly fireLoop?: string;
+    /** Adds to or changes `FIRE_FUEL_OF`: which fuel a burning material sounds like. */
+    readonly fuels?: Readonly<Record<string, FireFuel>>;
+    /** Adds to or changes `FIRE_LOOP_OF`: the loop of each fuel. */
+    readonly fireLoops?: Partial<Readonly<Record<FireFuel, string>>>;
+    /** The fuel of a fire whose material is not in the table (default `wood`). */
+    readonly defaultFuel?: FireFuel;
     /** Crackles per second over the fire loop: `base + perSqrtFire × √(parts burning)`, at most `max` (default 2, 3, 14). `false` turns them off. */
     readonly crackles?: false | {
         readonly base?: number;
@@ -423,6 +439,10 @@ type DestructionSound = {
     rule(key: string, detail?: SoundDetail): SoundKeyRule | undefined;
     /** Parts burning now. */
     readonly burning: () => number;
+    /** Parts burning now, by fuel. */
+    readonly burningBy: () => Readonly<Partial<Record<FireFuel, number>>>;
+    /** Puts every fire sound out (the scene was cleared); the engine and the bank stay. */
+    reset(): void;
     dispose(): void;
 };
 declare const DEFAULT_FIRE: {

package/dist/index.global.js

@@ -13728,7 +13728,7 @@ void main(){vec2 d=gl_PointCoord-.5;float r=length(d)*2.;if(r>1.)discard;float a
           this.startFire(ev);
           this.activate(ev.object, ev.part);
           this.sound("ignite", ev.point, 0.7);
-          this.sound("burn_loop", ev.point, 0.5);
+          this.sound("burn_loop", ev.point, 0.5, this.burning(ev.object, ev.part));
           break;
         case "primed":
           if (ev.trigger !== "explosion") {
@@ -13736,7 +13736,7 @@ void main(){vec2 d=gl_PointCoord-.5;float r=length(d)*2.;if(r>1.)discard;float a
             this.primedBurning.add(`${ev.object}|${ev.part}`);
             this.activate(ev.object, ev.part);
             this.sound("primed", ev.point, 0.7, { seconds: ev.delay });
-            this.sound("burn_loop", ev.point, 0.5);
+            this.sound("burn_loop", ev.point, 0.5, { fuel: "gas" });
           }
           break;
         case "spall":
@@ -13762,15 +13762,15 @@ void main(){vec2 d=gl_PointCoord-.5;float r=length(d)*2.;if(r>1.)discard;float a
             this.stopFire(`${ev.object}|${ev.part}`);
             this.vfx.burst("steam", f.point, [0, 1, 0], 14, 1.2);
           }
-          if (f || primed) this.sound("burn_end", f?.point ?? this.rootPoint(ev.object), 0.5);
+          if (f || primed) this.sound("burn_end", f?.point ?? this.rootPoint(ev.object), 0.5, primed ? { fuel: "gas" } : this.burning(ev.object, ev.part));
           this.activate(ev.object, ev.part);
           this.sound("extinguish", f?.point ?? this.rootPoint(ev.object), 0.6);
           break;
         }
         case "burnout": {
           this.stopFire(`${ev.object}|${ev.part}`);
-          this.primedBurning.delete(`${ev.object}|${ev.part}`);
-          this.sound("burn_end", ev.point, 0.5);
+          const primed = this.primedBurning.delete(`${ev.object}|${ev.part}`);
+          this.sound("burn_end", ev.point, 0.5, primed ? { fuel: "gas" } : this.burning(ev.object, ev.part));
           this.vfx.burst("ash", ev.point, [0, 1, 0], 16, 1);
           this.vfx.burst("smoke", ev.point, [0, 1, 0], 6, 0.8, { color: SMOKE_TONES.grey });
           const pv = this.partVis(ev.object, ev.part);
@@ -13838,7 +13838,7 @@ void main(){vec2 d=gl_PointCoord-.5;float r=length(d)*2.;if(r>1.)discard;float a
           break;
         }
         case "explode":
-          this.primedBurning.delete(`${ev.object}|${ev.part}`);
+          if (this.primedBurning.delete(`${ev.object}|${ev.part}`)) this.sound("burn_end", ev.point, 0.5, { fuel: "gas" });
           this.onExplode(ev);
           break;
         case "destroyed":
@@ -13853,6 +13853,11 @@ void main(){vec2 d=gl_PointCoord-.5;float r=length(d)*2.;if(r>1.)discard;float a
       if (detail) this.o.onSound?.(key, point, volume, detail);
       else this.o.onSound?.(key, point, volume);
     }
+    /** What a burning part is made of, for the fire's sound. */
+    burning(objectId, partId) {
+      const material = this.partVis(objectId, partId)?.material || this.world.part(objectId, partId)?.material;
+      return material ? { material } : void 0;
+    }
     partVis(objectId, partId) {
       return this.bounds.get(objectId)?.parts.get(partId) ?? null;
     }
@@ -16087,6 +16092,47 @@ void main(){vec2 d=gl_PointCoord-.5;float r=length(d)*2.;if(r>1.)discard;float a
     volume: 0,
     sources: ["sdk: the roar under the crackles of a fire"]
   };
+  var FIRE_FUEL_OF = {
+    wood_soft: "wood",
+    wood_hard: "wood",
+    plywood: "wood",
+    mdf: "wood",
+    green_wood: "wood",
+    foliage: "wood",
+    cactus: "wood",
+    paper: "fabric",
+    fabric: "fabric",
+    leather: "fabric",
+    foam: "plastic",
+    plastic: "plastic",
+    rubber: "plastic",
+    wax: "plastic"
+  };
+  var FIRE_LOOP_OF = {
+    wood: "fire_loop",
+    fabric: "fire_loop",
+    plastic: "fire_loop_plastic",
+    gas: "fire_loop_gas",
+    liquid: "fire_loop_liquid"
+  };
+  var FIRE_CRACKLE_OF = { wood: 1, fabric: 0.5, plastic: 0.35, gas: 0, liquid: 0 };
+  var roar = (id, bank, source) => ({
+    id,
+    bus: "world",
+    order: "chain_loop",
+    source: { kind: "noise", loop: true },
+    filters: { mode: "serial", bank },
+    volume: 0,
+    sources: [source]
+  });
+  var FIRE_FUEL_LOOPS = [
+    // a gas jet: a steady, broad roar, brighter than wood and without crackles
+    roar("fire_loop_gas", [{ type: "highpass", frequency: { set: 220 }, q: 0.7 }, { type: "lowpass", frequency: { set: 2400 }, q: 0.6 }], "sdk: a gas jet burning (a vessel venting into the flame)"),
+    // a fuel pool: a soft, low, rolling roar
+    roar("fire_loop_liquid", [{ type: "highpass", frequency: { set: 90 }, q: 0.7 }, { type: "lowpass", frequency: { set: 650 }, q: 0.9 }], "sdk: a pool of fuel burning"),
+    // plastic and rubber: a thin sizzle over a low burn
+    roar("fire_loop_plastic", [{ type: "bandpass", frequency: { set: 1800 }, q: 0.6 }], "sdk: plastic and rubber melting in the fire")
+  ];
   var BLAST_SOUND_OF = {
     grenade: "explosion_grenade",
     big: "explosion_big",
@@ -16233,7 +16279,7 @@ void main(){vec2 d=gl_PointCoord-.5;float r=length(d)*2.;if(r>1.)discard;float a
     impact2("plastic_crack", [sceneNoise({ type: "bandpass", f: 1800, q: 2, d: 0.06, vol: 0.75 }), sceneTone({ f: [450, 550], f2: 250, d: 0.05, vol: 0.22 })]),
     impact2("mdf_crumble", [sceneNoise({ type: "lowpass", f: 700, d: 0.25, vol: 0.75, wet: 0.2 }), ...sceneMany(4, () => sceneNoise({ type: "lowpass", f: 500, d: 0.05, vol: 0.32, delay: [0.05, 0.3] }))])
   ];
-  var DESTRUCTION_SOUND_BANK = { id: "destruction_three", sounds: [...SCENE_SOUNDS, ...DRAG_SOUNDS, ...LEAF_SOUNDS, ...IMPACT_SOUNDS, EXPLOSION_BOOM, ...BLAST_SOUNDS, ...FIRE_SOUNDS], loops: [BURN_LOOP, FIRE_LOOP] };
+  var DESTRUCTION_SOUND_BANK = { id: "destruction_three", sounds: [...SCENE_SOUNDS, ...DRAG_SOUNDS, ...LEAF_SOUNDS, ...IMPACT_SOUNDS, EXPLOSION_BOOM, ...BLAST_SOUNDS, ...FIRE_SOUNDS], loops: [BURN_LOOP, FIRE_LOOP, ...FIRE_FUEL_LOOPS] };
 
   // src/audio/sound.ts
   var IMPACT_SOUND_KEYS = {
@@ -16384,31 +16430,52 @@ void main(){vec2 d=gl_PointCoord-.5;float r=length(d)*2.;if(r>1.)discard;float a
     const rules = { ...DESTRUCTION_SOUND_KEYS.art_scene, ...options.style === "game" ? DESTRUCTION_SOUND_KEYS.game : {}, ...options.keys };
     const blastByKind = options.style !== "game" && !(options.keys && "explode" in options.keys);
     const channel = engine.channel({ seed: options.seed ?? 1 });
-    let loop;
-    let burning = 0;
+    const fuelOf = { ...FIRE_FUEL_OF, ...options.fuels };
+    const loopOf = { ...FIRE_LOOP_OF, ...options.fireLoop ? { wood: fireLoop, fabric: fireLoop } : {}, ...options.fireLoops };
+    const defaultFuel = options.defaultFuel ?? "wood";
+    const loops = /* @__PURE__ */ new Map();
     const fires = [];
     let nextCrackle = 0;
+    const fuelFor = (detail) => detail?.fuel ?? (detail?.material !== void 0 ? fuelOf[detail.material] : void 0) ?? defaultFuel;
     const setFire = () => {
       if (options.burnLoop === false) return;
-      if (burning <= 0) {
-        loop?.stop();
-        loop = void 0;
-        return;
+      const count = /* @__PURE__ */ new Map();
+      for (const f of fires) {
+        const id = loopOf[f.fuel];
+        count.set(id, (count.get(id) ?? 0) + 1);
+      }
+      for (const [id, handle] of loops) {
+        if (count.has(id)) continue;
+        handle.stop();
+        loops.delete(id);
+      }
+      for (const [id, n] of count) {
+        let handle = loops.get(id);
+        if (!handle) {
+          handle = engine.loop(id);
+          loops.set(id, handle);
+        }
+        handle.set({ volume: Math.min(fire2.max, fire2.perFire * n) });
       }
-      loop ?? (loop = engine.loop(fireLoop));
-      loop.set({ volume: Math.min(fire2.max, fire2.perFire * burning) });
     };
-    const forget = (point) => {
+    const forget = (point, fuel) => {
       let best = -1;
       let bestD = Infinity;
       fires.forEach((f, i) => {
-        const d = (f[0] - point[0]) ** 2 + (f[1] - point[1]) ** 2 + (f[2] - point[2]) ** 2;
+        if (fuel !== void 0 && f.fuel !== fuel) return;
+        const d = (f.point[0] - point[0]) ** 2 + (f.point[1] - point[1]) ** 2 + (f.point[2] - point[2]) ** 2;
         if (d < bestD) {
           bestD = d;
           best = i;
         }
       });
-      if (best >= 0) fires.splice(best, 1);
+      if (best < 0 && fuel !== void 0) forget(point, void 0);
+      else if (best >= 0) fires.splice(best, 1);
+    };
+    const reset = () => {
+      for (const handle of loops.values()) handle.stop();
+      loops.clear();
+      fires.length = 0;
     };
     const blastSound = (point, volume, detail) => {
       const named = detail?.effect === void 0 ? void 0 : kinds[detail.effect];
@@ -16420,14 +16487,12 @@ void main(){vec2 d=gl_PointCoord-.5;float r=length(d)*2.;if(r>1.)discard;float a
     return {
       onSound(key, point, volume, detail) {
         if (key === "burn_loop") {
-          burning += 1;
-          fires.push(point);
+          fires.push({ point, fuel: fuelFor(detail) });
           setFire();
           return;
         }
         if (key === "burn_end") {
-          if (burning > 0) burning -= 1;
-          forget(point);
+          forget(point, detail?.fuel ?? (detail?.material !== void 0 ? fuelOf[detail.material] : void 0));
           setFire();
           return;
         }
@@ -16457,12 +16522,15 @@ void main(){vec2 d=gl_PointCoord-.5;float r=length(d)*2.;if(r>1.)discard;float a
       },
       update(dt) {
         if (!crackles || fires.length === 0 || options.burnLoop === false) return;
+        const weight = fires.reduce((sum, f) => sum + FIRE_CRACKLE_OF[f.fuel], 0);
+        if (weight <= 0) return;
         nextCrackle -= dt;
         for (let i = 0; i < 4 && nextCrackle <= 0; i++) {
-          const rate = Math.min(crackles.max, crackles.base + crackles.perSqrtFire * Math.sqrt(fires.length));
+          const rate = Math.min(crackles.max, crackles.base * Math.min(1, weight) + crackles.perSqrtFire * Math.sqrt(weight));
           nextCrackle += (0.4 + channel.random() * 1.2) / rate;
-          const at3 = fires[Math.floor(channel.random() * fires.length)];
-          engine.play(channel.random() < 0.18 ? "fire_pop" : "fire_crackle", { position: at3, volume: crackles.volume });
+          let pick3 = channel.random() * weight;
+          const at3 = fires.find((f) => (pick3 -= FIRE_CRACKLE_OF[f.fuel]) <= 0) ?? fires[fires.length - 1];
+          engine.play(channel.random() < 0.18 ? "fire_pop" : "fire_crackle", { position: at3.point, volume: crackles.volume });
         }
         if (nextCrackle < 0) nextCrackle = 0;
       },
@@ -16471,13 +16539,14 @@ void main(){vec2 d=gl_PointCoord-.5;float r=length(d)*2.;if(r>1.)discard;float a
         for (const k of detail?.keys ?? []) if (k in rules) return rules[k] ?? void 0;
         return rules[key] ?? void 0;
       },
-      burning: () => burning,
-      dispose() {
-        loop?.stop();
-        loop = void 0;
-        burning = 0;
-        fires.length = 0;
-      }
+      burning: () => fires.length,
+      burningBy: () => {
+        const by = {};
+        for (const f of fires) by[f.fuel] = (by[f.fuel] ?? 0) + 1;
+        return by;
+      },
+      reset,
+      dispose: reset
     };
   }
 
@@ -16498,7 +16567,11 @@ void main(){vec2 d=gl_PointCoord-.5;float r=length(d)*2.;if(r>1.)discard;float a
     fire_extinguish: fire(0.7),
     gas_leak: fire(0.5),
     // the roar: recorded fires chained with a crossfade (the level comes from `createDestructionSound`, by how much burns)
-    fire_loop: { bus: "world", gain: 4, loop: { crossfade: 1 } }
+    fire_loop: { bus: "world", gain: 4, loop: { crossfade: 1 } },
+    // each fuel has its own roar: a gas jet (burners and torches), a pool of fuel, plastic and rubber sizzling under the flames
+    fire_loop_gas: { bus: "world", gain: 6, loop: { crossfade: 1 } },
+    fire_loop_liquid: { bus: "world", gain: 3.5, loop: { crossfade: 1 } },
+    fire_loop_plastic: { bus: "world", gain: 1, loop: { crossfade: 0.6 } }
   };
   function blastFireSampleBank(manifest, options = {}) {
     const sounds = options.sounds ?? BLAST_FIRE_SAMPLES;