@adatechnology/game-test-room 0.25.1 → 0.26.0

package/dist/index.d.ts

@@ -4,7 +4,7 @@ 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, Knock, BusyTask, BusyOptions, TestableModule, ModuleItemSeal, DestructibleImpl, AnimationClipSpec, ItemSounds, GroundLayout, BlastImpulseOptions, BlastShoveOptions } from '@adatechnology/game-contracts';
+import { BusySink, ItemSeat, Vec3, HandTargets, ModuleControl, ControlValue, ModuleLayer, EnvironmentBus, Knock, BusyTask, BusyOptions, TestableModule, WarmUpProbes, ModuleItemSeal, DestructibleImpl, AnimationClipSpec, ItemSounds, GroundLayout, BlastImpulseOptions, BlastShoveOptions } from '@adatechnology/game-contracts';
 export { AnimationClipSpec, DestructibleImpl, ItemAnimationContract, ModuleScenario, TestableItem, TestableModule } from '@adatechnology/game-contracts';
 import { DestructionRenderer, SpecFromObjectOptions, Quality, SoundDetail, FragmentLifeRule } from '@adatechnology/game-destruction-three';
 import { StorageLike, GraphicsController } from '@adatechnology/game-graphics';
@@ -147,6 +147,27 @@ interface LogOptions {
 }
 declare function createLog(options?: LogOptions): WritableLog;
 
+/** One tool the menu offers: its id, name and, when the catalogue has one, its silhouette. */
+interface ToolMenuTool {
+    readonly id: string;
+    readonly name: string;
+    /** More words a search finds it by (a weapon's maker). */
+    readonly keywords?: string;
+    readonly thumbnail?: string;
+    readonly thumbnailCredit?: string;
+}
+interface ToolMenuSection {
+    readonly id: string;
+    readonly name: string;
+    readonly tools: readonly ToolMenuTool[];
+}
+/** A tab of the menu (firearms, melee, explosives, tools...): its sections in order. */
+interface ToolMenuGroup {
+    readonly id: string;
+    readonly name: string;
+    readonly sections: readonly ToolMenuSection[];
+}
+
 /**
  * What a trial does to one object: a shot, a punch, a knife blow, a flame on it or a blast beside it. The test table runs one on the object it has picked, so every item of the
  * catalogue can be tried one by one with the same hit.
@@ -633,6 +654,11 @@ interface SceneryObject {
         dispose?(): void;
         update?(): void;
     } | null | void;
+    /**
+     * Throwaway meshes of what the object draws later on demand (the breach of a wall: its shell and its bare bricks), drawn once at load so their shader programs are
+     * built then and not at the first shot or blast of play (`WarmUpProbes` of game-contracts).
+     */
+    warmUpProbes?: (THREE: ThreeNamespace) => WarmUpProbes;
     /** Name shown in the inspector and the log (default the translated name of a default id, else the id). */
     label?: string;
     /**
@@ -685,7 +711,7 @@ interface TestRoomOptions {
     /** `en` (default) or `pt-BR`. */
     locale?: string;
     catalog: TestRoomItem[];
-    /** Weapons and tools in the hotbar: ids of the arsenal (default `DEFAULT_LOADOUT`), plus extra definitions merged into the arsenal. */
+    /** Weapons and tools in the hotbar: ids of the arsenal (default `DEFAULT_LOADOUT` with each generic gun swapped for the real weapon that stands for it, `realLoadout`), plus extra definitions merged into the arsenal. */
     loadout?: string[];
     weapons?: WeaponDef[];
     /** An existing arsenal (default `createArsenal({ locale })`). */
@@ -711,7 +737,7 @@ interface TestRoomOptions {
      * renderer the room makes. Default off (the fixed look of `quality`).
      */
     graphics?: boolean | RoomGraphicsOptions;
-    /** What the floor is made of until an area lays its own (`TestableModule.ground`). Default a concrete slab. */
+    /** What the floor is made of until an area is opened: the area lays its own (`TestableModule.ground`), or a concrete slab. Default a concrete slab. */
     ground?: GroundLayout;
     /** Limits of the floor's marks, thrown pieces and redraws per frame. */
     terrainBudget?: Partial<TerrainBudget>;
@@ -781,6 +807,10 @@ interface TestRoomOptions {
     kick?: {
         keys?: string[];
     };
+    /** The weapon picker: every weapon of the arsenal by group (firearms, melee, explosives, tools) and category, a click equips it and adds it to the hotbar. `keys` open it (default `['Backquote']`, the key left of 1); `false`: no picker. */
+    toolMenu?: false | {
+        keys?: string[];
+    };
     /** Which hand throws the one-handed strikes (`punchTools`): `alternate` (default) swaps at each punch starting with the right, or always `left` or `right`. */
     punchHand?: PunchHand;
     /** The tools whose strike is thrown with one hand, so `punchHand` picks it (default `['hand', 'fists']`); the shove and the kick are not. */
@@ -991,6 +1021,8 @@ interface TestRoom {
     kick(): boolean;
     /** Equip a weapon by id, adding it to the hotbar when it is not there. Same as selecting a catalogue item with `TestRoomItem.weapon`. */
     equip(weaponId: string): void;
+    /** Opens or closes the weapon picker (no argument: toggles); answers whether it is open. Always false without the panels (`ui: false`) or with `toolMenu: false`. */
+    toggleToolMenu(open?: boolean): boolean;
     /**
      * Set the room up to test one catalogue group or loaded module (by its group or id): clear it and open the catalogue on that tab. A module
      * 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.
@@ -1265,4 +1297,4 @@ declare function encodeBenchState(controls: readonly BenchControl[], layers: rea
 /** Reads an encoded state as hostile input: unknown ids, NaN, options not offered and malformed pairs are dropped; numbers are clamped. */
 declare function decodeBenchState(encoded: string, controls: readonly ModuleControl[], layers: readonly ModuleLayer[]): Map<string, ControlValue>;
 
-export { type AnimationInfo, type BenchControl, type BenchHandle, type BenchLayer, type BuildFromSpecOptions, type CameraMode, DEFAULT_HAND_STANCES, DEFAULT_STRIKE_CLIPS, DEFAULT_TRIALS, type HudState, type InspectInfo, type KickLeg, LOADING_CLASS, LOADING_CSS, type LoadingOptions, type LoadingState, type LogEntry, MATERIAL_COLORS, type ModuleReport, type NewEntry, type NewLogEntry, type ProjectileModel, type ProjectileQuery, type PunchHand, type RoomAvatar, type RoomAvatarState, type RoomDoorEvent, type RoomDoorState, type RoomFirstPersonState, type RoomGraphicsOptions, type RoomLoading, type RoomMetricId, type RoomPushEvent, type RoomPushState, type RoomReachView, type RoomSeat, type RoomStrings, type ScenarioContext, type ScenarioReport, type SceneryObject, type SceneryTap, type SpawnedObject, type StrikeComboOption, TRIAL_KINDS, type TestRoom, type TestRoomItem, type TestRoomLocale, type TestRoomLog, type TestRoomOptions, type TestRoomScenario, type TestTable, type TestTableContext, type TestTableObject, type TestTableOptions, type TestTablePage, type ThirdPersonOptions, type ThreeNamespace, type TrialKind, type TrialTool, type UseStatus, type WritableLog, brickWallSpec, buildFromSpec, createLoading, createLog, createTestRoom, createTestTable, decodeBenchState, encodeBenchState, fitRow, loadingMarkup, locales, nextPaint, resolveStrings, rowCentres, trialView };
+export { type AnimationInfo, type BenchControl, type BenchHandle, type BenchLayer, type BuildFromSpecOptions, type CameraMode, DEFAULT_HAND_STANCES, DEFAULT_STRIKE_CLIPS, DEFAULT_TRIALS, type HudState, type InspectInfo, type KickLeg, LOADING_CLASS, LOADING_CSS, type LoadingOptions, type LoadingState, type LogEntry, MATERIAL_COLORS, type ModuleReport, type NewEntry, type NewLogEntry, type ProjectileModel, type ProjectileQuery, type PunchHand, type RoomAvatar, type RoomAvatarState, type RoomDoorEvent, type RoomDoorState, type RoomFirstPersonState, type RoomGraphicsOptions, type RoomLoading, type RoomMetricId, type RoomPushEvent, type RoomPushState, type RoomReachView, type RoomSeat, type RoomStrings, type ScenarioContext, type ScenarioReport, type SceneryObject, type SceneryTap, type SpawnedObject, type StrikeComboOption, TRIAL_KINDS, type TestRoom, type TestRoomItem, type TestRoomLocale, type TestRoomLog, type TestRoomOptions, type TestRoomScenario, type TestTable, type TestTableContext, type TestTableObject, type TestTableOptions, type TestTablePage, type ThirdPersonOptions, type ThreeNamespace, type ToolMenuGroup, type ToolMenuSection, type ToolMenuTool, type TrialKind, type TrialTool, type UseStatus, type WritableLog, brickWallSpec, buildFromSpec, createLoading, createLog, createTestRoom, createTestTable, decodeBenchState, encodeBenchState, fitRow, loadingMarkup, locales, nextPaint, resolveStrings, rowCentres, trialView };