@adatechnology/game-test-room 0.7.0 → 0.9.0

package/README.md

@@ -91,6 +91,8 @@ room.bench()?.set('size', 2) // clamped and snapped; false for an unknown id, a
 room.metrics() // { room: { fps, draw_calls, ... }, module: { particles: 120 } }
 ```
 
+The room's explosions take the blast options of `game-destruction` (`createTestRoom({ blast: { shelter: true } })`, `room.blast()`, `room.setBlast({ fragmentHits: true })`); three HUD toggles (Shelter, Fragments, Confinement; Abrigo, Estilhaços, Confinamento) flip them, and the numbers of the last blast show as the room metrics `blast_shelter` (% that reached the most sheltered target), `blast_confinement` and `blast_fragments`, and as a `blast_report` line in the log.
+
 A module can put a **sheet** on the panel (`host.bench.sheet(sheet)`, `BenchSheet` of the contracts): a card with a kicker, a title, a text, facts, steps, colour swatches and a timeline of named segments whose playhead follows one of the module's numeric metrics.
 The room also runs the film of the liquids that have one (`createFilmManager` of `game-fluids-three`): a leak of fuel, oil or blood drips into grids on the floor near the camera.
 

package/dist/index.d.ts

@@ -1,11 +1,12 @@
 import * as THREE_NS from 'three';
-import { DestructibleSpec, Vec3, DestructionWorld, DestructionOptions, DestructionEvent, MaterialDef } from '@adatechnology/game-destruction';
+import { AudioEngine } from '@adatechnology/game-audio';
+import { DestructibleSpec, Vec3, DestructionWorld, BlastOptions, DestructionOptions, DestructionEvent, MaterialDef } from '@adatechnology/game-destruction';
 export { DestructionEvent, Vec3 } from '@adatechnology/game-destruction';
 import { SpecFromObjectOptions, DestructionRenderer, Quality } from '@adatechnology/game-destruction-three';
 import { Arsenal, WeaponState, WeaponDef } from '@adatechnology/game-weapons';
 import { FluidRenderer } from '@adatechnology/game-fluids-three';
 import { ContainerSpec, FluidWorld, LiquidDef, ItemUseDef, SurfaceSpec } from '@adatechnology/game-fluids';
-import { ModuleControl, ControlValue, ModuleLayer, DestructibleImpl, AnimationClipSpec, TestableModule } from '@adatechnology/game-contracts';
+import { ModuleControl, ControlValue, ModuleLayer, DestructibleImpl, AnimationClipSpec, EnvironmentBus, TestableModule } from '@adatechnology/game-contracts';
 export { AnimationClipSpec, DestructibleImpl, ItemAnimationContract, ModuleScenario, TestableItem, TestableModule } from '@adatechnology/game-contracts';
 
 type NewEntry = NewLogEntry;
@@ -97,6 +98,12 @@ interface HudState {
     timeScale: number;
     fast: boolean;
     tap: boolean;
+    /** The room's blast options that are on. */
+    blast: {
+        shelter: boolean;
+        fragmentHits: boolean;
+        confinement: boolean;
+    };
     quality: string;
     objects: number;
 }
@@ -194,10 +201,19 @@ interface TestRoomOptions {
     /** Called for every destruction event (to log, play sounds, sync over LAN). Fluid events reach the log too. */
     onEvent?: (event: DestructionEvent) => void;
     onSound?: (key: string, point: Vec3, volume: number) => void;
+    /**
+     * The sound engine of the room (@adatechnology/game-audio): the destruction renderer's sound keys play on it, and modules get it as `host.audio`.
+     * Default: a new engine of the room's own (it makes no AudioContext until the first sound); `false` for a silent room.
+     */
+    audio?: AudioEngine | false;
+    /** The environment store modules get as `host.environment` (the weather module writes it, the others read it). Default: a new one with a calm dry day. */
+    environment?: EnvironmentBus;
     /** Show the built-in HUD and panels (default true). */
     ui?: boolean;
     /** Room counters the bench panel shows and `TestRoom.metrics()` returns (default all); `false` for none. */
     metrics?: readonly RoomMetricId[] | false;
+    /** Blast options every explosion of the room starts with (`shelter`, `fragmentHits`, `confinement`; default all off). The HUD toggles them and `TestRoom.setBlast` changes them. */
+    blast?: BlastOptions;
     /**
      * Module bench state. `state` maps a module id to its encoded state, restored when that module is first loaded (a module reloaded
      * keeps its live state instead) before its first changes are sent; ids are per module, so two modules may share a control id.
@@ -209,7 +225,9 @@ interface TestRoomOptions {
     };
 }
 /** Counters the room measures itself. `fps` and `frame_ms` use the real frame time, so slow motion does not change them. */
-type RoomMetricId = 'fps' | 'frame_ms' | 'draw_calls' | 'triangles' | 'objects' | 'fragments' | 'particles' | 'decals';
+type RoomMetricId = 'fps' | 'frame_ms' | 'draw_calls' | 'triangles' | 'objects' | 'fragments' | 'particles' | 'decals'
+/** Of the last blast, once the room's blast options are on: the share that reached the most sheltered target (%), the pressure multiplier, the fragment hits. */
+ | 'blast_shelter' | 'blast_confinement' | 'blast_fragments';
 /** A module control as the room holds it: the declaration with the module's patches applied, and its value (none for an action). */
 type BenchControl = ModuleControl & {
     readonly disabled: boolean;
@@ -238,6 +256,10 @@ interface SpawnedObject {
     movable: boolean;
 }
 interface TestRoom {
+    /** The room's sound engine, or `null` in a silent room. */
+    readonly audio: AudioEngine | null;
+    /** The environment store lent to modules as `host.environment`. */
+    readonly environment: EnvironmentBus;
     readonly world: DestructionWorld;
     readonly renderer: DestructionRenderer;
     readonly scene: THREE_NS.Scene;
@@ -281,6 +303,9 @@ interface TestRoom {
     tilt(rad: number): void;
     /** Open or close the tap over the table (default: toggle). Returns whether it is open. */
     toggleTap(on?: boolean): boolean;
+    /** The blast options the room's explosions use now, and a way to change them (each key replaces the old one; `undefined` clears it). */
+    blast(): BlastOptions;
+    setBlast(options: BlastOptions): void;
     /** Stop the simulation (time, physics, animations, tools, walks): the UI, the camera and the log stay live. `step` and `update` do nothing until `resume`. Scenarios run unpaused. */
     pause(): void;
     resume(): void;