@adatechnology/game-destruction-three 0.12.1 → 0.13.0

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { Fragment, Vec3, DebrisKind, HitResult, DestructionWorld, MaterialId, DestructibleSpec, MaterialDef } from '@adatechnology/game-destruction';
 export { Quat, Vec3 } from '@adatechnology/game-destruction';
+import { DeferredQueue, WarmUpProbes, BlastShoveOptions, Vec3 as Vec3$1 } from '@adatechnology/game-contracts';
 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';
 
@@ -175,6 +175,11 @@ interface DestructionRenderer {
     impulse(objectId: string, impulse: Vec3, point?: Vec3): void;
     /** Integrate fragments, pieces and particles; apply pending visual changes. Call once per frame after `world.update`. */
     update(dt: number): void;
+    /**
+     * The waiting events and the presentation slices they left, as a `DeferredQueue` for a shared frame budget (id `destruction.events`). `budget.register`
+     * attaches it and `update` stops draining by itself; unregistering gives the draining back to `update` and `eventBudgetMs`. Asking for it changes nothing.
+     */
+    deferredQueue?(): DeferredQueue;
     /** Emit particles directly (muzzle flashes, extinguisher foam, tool sparks). */
     emit(kind: DebrisKind | 'fire' | 'flash' | 'foam', point: Vec3, normal: Vec3, count: number, speed?: number): void;
     /**
@@ -230,7 +235,10 @@ interface SpecFromObjectResult {
 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;
-declare function createDestructionRenderer(THREE: ThreeNamespace, options: RendererOptions): DestructionRenderer;
+/** The renderer this package makes always has its `deferredQueue`; a third-party `DestructionRenderer` may leave it out. */
+declare function createDestructionRenderer(THREE: ThreeNamespace, options: RendererOptions): DestructionRenderer & {
+    deferredQueue(): DeferredQueue;
+};
 
 /** What `userData.destructionPart` says: a string (the part id) or an object `{ id, material?, parent?, kind? }`. */
 interface PartHint {