@adatechnology/game-test-room 0.28.2 → 0.29.0

package/README.md

@@ -145,7 +145,8 @@ An `explosion` moves the loose items, the heavy furniture that is not fixed, and
 The room makes **one** effects world (`game-vfx` and its `game-vfx-three` layer) and steps it once per frame, after the destruction renderer. The destruction
 renderer draws into it, every module gets it as `host.effects` (an `EffectSink`: `play({ effect: 'm67', point })`, `catalog()`), grenades and rockets play the
 profile of their explosive (`explosive` is on the `explosion` host event), the camera shakes and the screen flashes through an overlay in the container, and the
-`particles` metric counts its pools. Without a DOM nothing is drawn on the screen. `TestRoom.applyCamera()` wraps a host's own `render`; the room's loop does it itself.
+`particles` metric counts its pools. The same sink is `room.effects`, for what a page builds before its module loads (the vehicle kit's `effects`); `room.vfx` is the
+world under it, whose `play` takes an id and a point, so a request given to it plays nothing. Without a DOM nothing is drawn on the screen. `TestRoom.applyCamera()` wraps a host's own `render`; the room's loop does it itself.
 `craters: true` swaps the floor for a deformable patch that big explosions dig into.
 
 A module that declares `controls`, `layers` or `metrics` (see `@adatechnology/game-contracts`) gets a bench: `loadModule` checks it with

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, WarmUpProbes, ModuleItemSeal, DestructibleImpl, AnimationClipSpec, ItemSounds, GroundLayout, BlastImpulseOptions, BlastShoveOptions } from '@adatechnology/game-contracts';
+import { BusySink, ItemSeat, Vec3, HandTargets, ModuleControl, ControlValue, ModuleLayer, EnvironmentBus, EffectSink, 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';
@@ -835,7 +835,7 @@ interface TestRoomOptions {
     };
     /** 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. */
+    /** The tools whose strike is thrown with one hand, so `punchHand` picks it (default `['hand', 'fists', 'brass_knuckles']`); the shove and the kick are not. */
     punchTools?: readonly string[];
     /**
      * A strike combo the player has (an ability, such as `PUNCH_COMBO` of game-characters-people): while it is on (N, the combo button or `setStrikeCombo`), each blow of its
@@ -963,9 +963,25 @@ interface TestRoom {
     readonly film: FilmBridge;
     /** The room's one effects world (what `host.effects` draws into): the weather moves its wind. */
     readonly vfx: VfxWorld;
+    /**
+     * The room's effect sink, the same one modules get as `host.effects`: an effect asked for by request (`play({ id, at, ... })`). Give this, not `vfx`, to whatever is
+     * built before the module loads and wants an `EffectSink` (the vehicle kit's `effects`): `vfx.play` takes an id and a point, so a request there plays nothing.
+     */
+    readonly effects: EffectSink;
     /** Equip a weapon or tool of the loadout (or any arsenal id). */
     setTool(weaponId: string): void;
     readonly tool: WeaponState;
+    /**
+     * Puts one of a weapon in the left hand beside the tool in hand (a pistol in each hand: the left mouse button fires the right one, the right button the left one, and neither aims).
+     * False, and nothing changes, when the arsenal's `rules.dualWield` does not take the weapon or the tool in hand; `null` lets the left hand go. `setTool` also lets it go.
+     */
+    setOffTool(weaponId: string | null): boolean;
+    /** The tool in the left hand (its own rounds and reload), or null with one tool. */
+    readonly offTool: WeaponState | null;
+    /** `use` for the tool in the left hand, as the right mouse button does with a tool in each hand; `cooldown` with nothing there. */
+    useOff(hold?: number): UseStatus;
+    /** The R key: reloads the tool in hand and, with one in each hand, the left one after the right one (one hand holds the other weapon meanwhile). */
+    reload(): void;
     /** Play an item use on the held item (`drink`, `pour`...). Returns false when nothing is held or the use does not apply. */
     useItem(useId: string): boolean;
     /**