@adatechnology/game-test-room 0.12.0 → 0.14.0

package/dist/index.d.ts

@@ -156,6 +156,11 @@ interface HudState {
  * that fits it, such as `createPlayerAvatar` of `@adatechnology/game-characters-three`), and no character code is imported here.
  */
 
+interface RoomAvatarItemUse {
+    readonly id: string;
+    readonly position: readonly [number, number, number];
+    readonly rotation: readonly [number, number, number];
+}
 /** What the room tells the avatar every frame. */
 interface RoomAvatarState {
     /** Ground speed of the player, m/s (from the movement of the feet, jumps ignored). */
@@ -168,6 +173,10 @@ interface RoomAvatarState {
     armed: boolean;
     /** Camera pitch, radians, positive looking up (the room's own convention). */
     pitch: number;
+    /** Whether the player is carrying an item in hand. */
+    holding?: boolean;
+    /** Active scripted item use (`drink`, `sip`, `chug`, `pour`, `open`, `close`, `tilt`). */
+    itemUse?: RoomAvatarItemUse | null;
 }
 /** What the room tells the first-person arms every frame, after the modules have placed the tool in the hands. */
 interface RoomFirstPersonState {
@@ -397,6 +406,10 @@ interface TestRoomOptions {
      * supplies the real model; where it answers nothing the room draws a plain primitive (a sphere, a cylinder, a box).
      */
     projectileModel?: (query: ProjectileQuery) => ProjectileModel | null | undefined;
+    /** Keys (`KeyboardEvent.code`) that crouch while held; default `['KeyC']`. Ctrl is left out on purpose: Ctrl+W closes the tab. */
+    crouch?: {
+        keys?: string[];
+    };
     /** Spawn these catalogue ids on start, in a row in front of the player. */
     initial?: string[];
     /** Open on one catalogue group (`furniture`, `structure`, `weapons`…): see `TestRoom.openArea`. */
@@ -550,6 +563,13 @@ interface TestRoom {
      * that brings an `area` is laid out by it; any other group is laid in rows (small items in front, fixed big ones behind). Unknown: nothing.
      */
     openArea(group: string): SpawnedObject[];
+    /** The loaded modules (`loadModule`): id, name, catalogue group and whether it lays an area of its own. */
+    modules(): Array<{
+        id: string;
+        name: string;
+        group?: string;
+        hasArea: boolean;
+    }>;
     /**
      * `openArea` with the loading indicator: shows "Opening <area>…", waits for it to be painted and then lays the area (an area with hundreds of items takes a second or more and would
      * otherwise look frozen). Resolves with the spawned objects. Use it where a person waits for the result (a page that opens an area on load); scenarios call `openArea`, which is synchronous.