@adatechnology/game-test-room 0.21.0 → 0.23.0

package/dist/index.d.ts

@@ -4,9 +4,9 @@ import { AudioEngine } from '@adatechnology/game-audio';
 import { Vec3 as Vec3$1, DestructionWorld, BlastOptions, DestructibleSpec, DestructionOptions, DestructionEvent } from '@adatechnology/game-destruction';
 export { DestructionEvent, Vec3 } from '@adatechnology/game-destruction';
 import { DoorUsePhase, FurniturePushPhase, FurniturePushBlock, FurniturePushRules, DoorUseRules } from '@adatechnology/game-player';
-import { BusySink, ItemSeat, Vec3, HandTargets, ModuleControl, ControlValue, ModuleLayer, EnvironmentBus, BusyTask, BusyOptions, TestableModule, ModuleItemSeal, DestructibleImpl, AnimationClipSpec, GroundLayout, BlastShoveOptions } from '@adatechnology/game-contracts';
+import { BusySink, ItemSeat, Vec3, HandTargets, ModuleControl, ControlValue, ModuleLayer, EnvironmentBus, Knock, BusyTask, BusyOptions, TestableModule, ModuleItemSeal, DestructibleImpl, AnimationClipSpec, ItemSounds, GroundLayout, BlastShoveOptions } from '@adatechnology/game-contracts';
 export { AnimationClipSpec, DestructibleImpl, ItemAnimationContract, ModuleScenario, TestableItem, TestableModule } from '@adatechnology/game-contracts';
-import { DestructionRenderer, SpecFromObjectOptions, Quality, FragmentLifeRule } from '@adatechnology/game-destruction-three';
+import { DestructionRenderer, SpecFromObjectOptions, Quality, SoundDetail, FragmentLifeRule } from '@adatechnology/game-destruction-three';
 import { StorageLike, GraphicsController } from '@adatechnology/game-graphics';
 import { GraphicsScreen } from '@adatechnology/game-graphics/screen';
 import { Arsenal, WeaponState, TriggerResult, WeaponDef } from '@adatechnology/game-weapons';
@@ -406,6 +406,8 @@ interface RoomAvatarState {
     running: boolean;
     crouch: boolean;
     down: boolean;
+    /** Which way the body falls while `down`: true face down, false on its back; left out, the avatar picks. A blast falls it the way it pushed. */
+    fallForward?: boolean;
     /** A firearm is the tool in hand. */
     armed: boolean;
     /** Camera pitch, radians, positive looking up (the room's own convention). */
@@ -596,6 +598,8 @@ interface TestRoomItem {
     animations?: AnimationClipSpec[];
     /** Where the player can sit or lie on it (see `TestRoom.sit`). */
     seats?: readonly ItemSeat[];
+    /** What it sounds like in the hand and the sound set of its doors and lids (`TestableItem.sounds`). */
+    sounds?: ItemSounds;
     /** Picture for the catalogue, the search results and the aimed-item label: an image URL or inline `<svg…>` markup (see `TestableItem.thumbnail`). */
     thumbnail?: string;
     /** Author and licence of the thumbnail, shown as the tooltip of the picture in the inspector. */
@@ -738,12 +742,15 @@ interface TestRoomOptions {
     area?: string;
     /** 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$1, volume: number) => void;
+    /** Every sound key the room plays, with its detail: the more specific keys of an impact, the named explosion, a leak's seconds (`SoundDetail` of game-destruction-three). */
+    onSound?: (key: string, point: Vec3$1, volume: number, detail?: SoundDetail) => 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;
+    /** Where the kit's recorded sound files (game-audio `assets/sfx/`) are served, for the room's engine (default `./sfx/`); `null` plays the recipes only. */
+    samplesBaseUrl?: string | null;
     /** 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). */
@@ -820,6 +827,8 @@ interface TestRoomOptions {
      * Default: the SDK's (`DEFAULT_BLAST_SHOVE` of game-contracts: 2 % of the energy becomes speed, 20 m/s at most, falloff `(1 - d / r)^2`).
      */
     blastShove?: BlastShoveOptions;
+    /** Mass of the player's body in kg: how far a blast throws it and whether it knocks it down (default 70, the `bodyMass` of 1.75 m). */
+    playerMass?: number;
     /**
      * 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.
@@ -908,6 +917,8 @@ interface TestRoom {
     use(hold?: number): UseStatus;
     /** Where the player's feet are. */
     readonly playerPosition: Vec3$1;
+    /** The knock of a blast on the player while it lasts (thrown, down, getting up), or null on its feet. */
+    readonly playerKnock: Readonly<Knock> | null;
     /** Grab what the camera looks at (or drop what is held). */
     grab(): boolean;
     /**
@@ -1205,10 +1216,6 @@ interface ScenarioReport {
 /** What the trigger answered to `TestRoom.use`: the status of the weapons package's trigger. */
 type UseStatus = TriggerResult['status'];
 
-/**
- * Create the test room. See `TestRoomOptions`. The room owns a renderer, scene and camera unless you pass them; with your own renderer you call
- * `room.update(dt)` every frame and render yourself.
- */
 declare function createTestRoom(options: TestRoomOptions): TestRoom;
 
 /** Spec of the brick target wall: `cols` x `rows` brick panels, the bottom row anchored, mortar joints between neighbours. */