@adatechnology/game-contracts 0.3.0 → 0.5.0

package/README.md

@@ -100,6 +100,27 @@ room.loadModule(RENTAL_CARS) // items join the catalogue, scenarios become butto
 `build` receives the host's three.js namespace and returns its `Object3D` (both are `unknown` here: this package has no dependency on three.js).
 `impl` receives the object id the host gives the item and `DestructibleImpl.id` must equal it.
 
+### A bench for the module
+
+A module can also declare a bench as data: `controls` (number, boolean, choice, action), `layers` (things the viewer turns on or off) and
+`metrics` (counters the host pulls with `read()` a few times a second). The host keeps the values, draws them, and lends the module a
+`ModuleBench` in `attach` (`host.bench`): `value(id)`, `layer(id)`, `onChange(listener)` (right after `attach` it gets one change per control and
+layer, in order), `patch(id, { hidden, disabled, options, value })` (no echo) and `look(eye, target)`. `checkBench({ controls, layers, metrics })`
+checks the declaration (snake_case ids unique across the three, `min < max`, `step > 0`, defaults in range and among the options, `max > 0`).
+
+```ts
+controls: () => [
+  { kind: 'choice', id: 'distance', name: 'Distance', options: [{ id: 'near', name: 'Near' }, { id: 'far', name: 'Far' }], default: 'near' },
+  { kind: 'action', id: 'replay', name: 'Replay' },
+],
+layers: () => [{ id: 'smoke', name: 'Smoke' }],
+metrics: () => [{ id: 'particles', name: 'Particles', max: 400, read: () => fx.particles }],
+```
+
+Tool events are named after a tool's cycle, not a firearm: `mode`, `fault`, `clear` (start / end) and `safety`, and `shot` carries `rounds`
+(cartridges spent) next to `shots` (projectiles, always 1 or more) and the `mode`; a dud round is its own `misfire` event, not a `shot` of zero. `HostTool` may report `mode`, `fault`, `safety` and `heat` (0..1).
+`host.configureTool(settings)` takes a `Record<string, string>` keyed by the id of the module's own control; the test room applies `condition` and `ammo_quality` and ignores other ids.
+
 ## API
 
 Everything is exported from the package root; see `src/*.ts` for the doc comments. Units: metres, seconds, joules, millimetres (calibre), degrees Celsius.
@@ -119,3 +140,5 @@ antes definiam, então `import { Hit } from '@adatechnology/game-destruction'` c
 - **Animações**: `AnimationClipSpec` e `checkAnimation(clipe, idsDasPeças)` (uma porta `open`, uma pistola `reload`).
 - **Módulo**: `TestableModule` entrega itens, animações e cenários à sala de testes; `room.loadModule(modulo)` roda as verificações e escreve linhas
   ✓ / ✗ no log. Assim o módulo de um carro de aluguel já nasce com as suas animações e o seu jeito de quebrar.
+- **Bancada**: o módulo declara `controls`, `layers` e `metrics` como dados; a sala guarda os valores, desenha e empresta `host.bench`
+  (`ModuleBench`). `checkBench` valida a declaração. Eventos de ciclo da ferramenta: `mode`, `fault`, `clear`, `safety`, e `rounds` no `shot`.

package/dist/index.d.ts

@@ -37,6 +37,16 @@ type PartShape = {
     radius: number;
 };
 type FluidKind = 'water' | 'fuel' | 'oil' | 'gas' | 'sap' | 'acid' | 'blood' | string;
+/** Seconds from a trigger to the blast: fixed, or `[min, max]` drawn from the world seed. */
+type ChainDelay = number | readonly [number, number];
+/** How an explosive part is set off by what happens around it. See `PartSpec.explodes`. */
+interface ExplosionChain {
+    shot?: ChainDelay;
+    fire?: ChainDelay;
+    explosion?: ChainDelay;
+    /** Fraction of the part's hit points a shot must have taken off before it sets the part off (default 0: any hit). */
+    shotDamageFraction?: number;
+}
 interface PartSpec {
     /** Unique inside the object. */
     id: string;
@@ -67,6 +77,12 @@ interface PartSpec {
         energy: number;
         radius: number;
         atC?: number;
+        /**
+         * Chain reaction: what sets the part off before it is destroyed and the seconds from that to the blast (a number, or `[min, max]` drawn
+         * from the world seed). `shot`: a bullet hit; `fire`: the part gets to `atC` (default 300 °C) or burns; `explosion`: a blast reaches it.
+         * Each part goes off once. Without `chain`, it explodes only when destroyed (or at `atC`).
+         */
+        chain?: ExplosionChain;
     };
     /** Fixed to the world (a wall-mounted cabinet, a tree trunk in the ground). Groups that keep an anchored part stay in place. */
     anchored?: boolean;
@@ -360,6 +376,14 @@ type DestructionEvent = (EventBase & {
     energy: number;
     radius: number;
 })
+/** An explosive part was set off by a bullet, fire or a nearby blast and will explode `delay` seconds from now (`explodes.chain`). */
+ | (EventBase & {
+    type: 'primed';
+    part: string;
+    point: Vec3;
+    trigger: 'shot' | 'fire' | 'explosion';
+    delay: number;
+})
 /** A structural part is overloaded (`stress` > 1); throttled to once per 0.5 s per part. Brittle parts also `crack` at stress > 0.8. */
  | (EventBase & {
     type: 'stress';
@@ -532,6 +556,53 @@ type Use = {
         radius: number;
         seconds: number;
     };
+    /** Explosive id (`m67`, `molotov`, `pg7v`...): the host looks the numbers up in the arsenal. Absent on a plain thrown object. */
+    explosive?: string;
+    /** What sets it off: `timer` after `fuse` seconds, `impact` on the first hit once armed. */
+    trigger?: 'timer' | 'impact';
+    /** Metres the projectile must fly before an impact sets it off; closer, it hits without exploding (rocket launchers). */
+    armDistance?: number;
+    /** Radius in metres of the wounding area (`radius` is the lethal one). */
+    injuryRadius?: number;
+    /** Seconds the blast stuns whoever is inside the injury radius (flashbang). */
+    stunSeconds?: number;
+    /** Seconds the thrower held it after pulling the pin: `fuse` is what was left of the full fuse when it left the hand. */
+    cooked?: number;
+    /** Went off in the thrower's hand (held past the fuse): no velocity, `fuse` is 0 and the blast is at `origin`. */
+    inHand?: boolean;
+}
+/** An explosive set down where the trigger is pulled (mine, C4, charge): it waits for its trigger instead of flying. */
+ | {
+    kind: 'place';
+    explosive: string;
+    /** `wire`: something trips it; `remote`: the player fires it; `timer`: after `fuse` seconds. */
+    triggers: readonly ('timer' | 'wire' | 'remote')[];
+    energy: number;
+    /** Lethal radius in metres. */
+    radius: number;
+    injuryRadius: number;
+    /** Cone the blast goes through, in front of `direction` (mine); absent for a blast in every direction. */
+    cone?: {
+        halfAngleDeg: number;
+        length: number;
+    };
+    /** The wire a `wire` charge stretches from where it is set down: metres out, degrees from its facing (counter-clockwise from above) and metres above it. */
+    tripwire?: {
+        length: number;
+        angleDeg: number;
+        height: number;
+    };
+    fuse?: number;
+    origin: Vec3;
+    direction: Vec3;
+}
+/** The blast behind a rocket launcher: dangerous inside `radius` metres, in the cone around `direction` (pointing away from the target). */
+ | {
+    kind: 'backblast';
+    radius: number;
+    halfAngleDeg: number;
+    origin: Vec3;
+    direction: Vec3;
 } | {
     kind: 'tool';
     tool: string;
@@ -656,6 +727,103 @@ declare const checkAnimation: (clip: AnimationClipSpec, partIds: Iterable<string
     problems: string[];
 };
 
+/**
+ * The bench of a module: controls, layers and counters it declares as data. The host keeps the values, draws them in a generic way and hands
+ * every change back through `ModuleHost.bench`. Nothing here is specific to a kind of module.
+ */
+type ControlValue = number | boolean | string;
+interface ChoiceOption {
+    readonly id: string;
+    readonly name: string;
+}
+interface ControlBase {
+    /** snake_case, unique across the module's controls, layers and metrics. */
+    readonly id: string;
+    /** Display name, already translated for the locale the host asked for. */
+    readonly name: string;
+    readonly hint?: string;
+    readonly hidden?: boolean;
+}
+interface NumberControl extends ControlBase {
+    readonly kind: 'number';
+    readonly min: number;
+    readonly max: number;
+    readonly step?: number;
+    readonly unit?: string;
+    readonly default: number;
+}
+interface BooleanControl extends ControlBase {
+    readonly kind: 'boolean';
+    readonly default: boolean;
+}
+interface ChoiceControl extends ControlBase {
+    readonly kind: 'choice';
+    readonly options: readonly ChoiceOption[];
+    readonly default: string;
+}
+/** A button: no value, only the press. */
+interface ActionControl extends ControlBase {
+    readonly kind: 'action';
+}
+type ModuleControl = NumberControl | BooleanControl | ChoiceControl | ActionControl;
+/** Something of the module the viewer turns on or off (smoke, flash, casings). */
+interface ModuleLayer {
+    readonly id: string;
+    readonly name: string;
+    /** On unless `false`. */
+    readonly default?: boolean;
+}
+/** Pulled: the room calls read only when it samples (~4 Hz, or on TestRoom.metrics()). */
+interface ModuleMetric {
+    readonly id: string;
+    readonly name: string;
+    readonly unit?: string;
+    /** Budget: the host shows a bar and warns past it. */
+    readonly max?: number;
+    readonly digits?: number;
+    read(): number | string;
+}
+type BenchChange = {
+    readonly kind: 'control';
+    readonly id: string;
+    readonly value: ControlValue;
+} | {
+    readonly kind: 'layer';
+    readonly id: string;
+    readonly on: boolean;
+} | {
+    readonly kind: 'action';
+    readonly id: string;
+};
+interface ControlPatch {
+    readonly hidden?: boolean;
+    readonly disabled?: boolean;
+    readonly options?: readonly ChoiceOption[];
+    readonly value?: ControlValue;
+}
+/** What the host lends a module that declares a bench: the current values and the changes. */
+interface ModuleBench {
+    value(id: string): ControlValue | undefined;
+    layer(id: string): boolean;
+    /** Right after attach returns, the host sends one change per control (not actions) and per layer, in declaration order. */
+    onChange(listener: (change: BenchChange) => void): () => void;
+    /** `value` sets without emitting (no echo loops); `options` falls back to the first option if the value is no longer offered. */
+    patch(id: string, patch: ControlPatch): void;
+    /** Move the host camera (a near / middle / far choice). */
+    look(eye: Vec3, target: Vec3): void;
+}
+interface BenchReport {
+    readonly ok: boolean;
+    readonly problems: readonly string[];
+}
+interface BenchDeclaration {
+    readonly controls?: readonly ModuleControl[];
+    readonly layers?: readonly ModuleLayer[];
+    readonly metrics?: readonly ModuleMetric[];
+}
+/** snake_case ids unique across controls, layers and metrics; min < max; step > 0; default in range; options non-empty, unique, default among them; metric max > 0. */
+declare function checkBench(declared: BenchDeclaration): BenchReport;
+
 /** An item that holds a liquid (a cup, a bottle, a fuel tank). `part` is the destruction part that is the container; a hole in it makes it leak. */
 interface ModuleItemFluid {
     container: ContainerSpec;
@@ -716,22 +884,96 @@ interface ModuleArea {
         target: Vec3;
     };
 }
-/** What the player did with the tool in hand, as the host reports it. Hosts emit what they support; modules ignore what they do not need. */
-type HostEvent = {
+/**
+ * What the player did with the tool in hand, as the host reports it. Hosts emit what they support; modules ignore what they do not need. The
+ * names are of a tool's cycle, not of a firearm: a nail gun, a chainsaw or a hose has modes, faults and a safety too.
+ */
+type HostEvent = 
+/** The tool is put in hand; `duration` is the seconds the rule takes to ready it (absent: no draw time). */
+{
     type: 'tool';
     weapon: string;
-} | {
+    duration?: number;
+}
+/** `shots` are projectiles (a shotgun shell is many), `rounds` the cartridges spent (a burst is several). */
+ | {
     type: 'shot';
     weapon: string;
     shots: number;
     recoil: [number, number];
-} | {
+    rounds?: number;
+    mode?: string;
+}
+/** The trigger was pulled, the round was spent and nothing left the tool (a dud cartridge): no projectile, no recoil. */
+ | {
+    type: 'misfire';
+    weapon: string;
+}
+/** `kind` is how the rule reloads (`tactical`, `empty`, `one_by_one`); `duration` the seconds of the whole reload, on `start`. */
+ | {
     type: 'reload';
     weapon: string;
     phase: 'start' | 'end';
+    kind?: string;
+    duration?: number;
 } | {
     type: 'empty';
     weapon: string;
+} | {
+    type: 'mode';
+    weapon: string;
+    mode: string;
+} | {
+    type: 'fault';
+    weapon: string;
+    fault: string;
+} | {
+    type: 'clear';
+    weapon: string;
+    fault: string;
+    phase: 'start' | 'end';
+    duration?: number;
+} | {
+    type: 'safety';
+    weapon: string;
+    on: boolean;
+}
+/** The action works between shots (a pump, a bolt); `duration` is the seconds of the cycle, on `start`. */
+ | {
+    type: 'cycle';
+    weapon: string;
+    phase: 'start' | 'end';
+    duration?: number;
+}
+/** A step of a longer phase (a reload's magazine out, magazine in, charge), at the moment the rule reaches it. */
+ | {
+    type: 'stage';
+    weapon: string;
+    stage: string;
+}
+/** One more round went into the tool while it loads round by round. */
+ | {
+    type: 'feed';
+    weapon: string;
+}
+/**
+ * A throwable with a timer fuse is cooked: the trigger pulls the pin (`start`, `fuse` is the whole fuse), releasing throws it with what is left of
+ * the fuse (`throw`), and holding past the fuse sets it off in the hand (`burst`, `fuse` 0).
+ */
+ | {
+    type: 'cook';
+    weapon: string;
+    phase: 'start' | 'throw' | 'burst';
+    fuse: number;
+}
+/** Something blew up: a thrown or launched explosive, a charge, or a part of the world (a fuel barrel); `source` is the weapon or the object, `cause` what set it off. */
+ | {
+    type: 'explosion';
+    source: string;
+    point: Vec3;
+    energy: number;
+    radius: number;
+    cause: string;
 };
 /** The tool in hand as the host sees it. */
 interface HostTool {
@@ -741,6 +983,12 @@ interface HostTool {
     capacity: number;
     reserve: number;
     reloading: boolean;
+    mode?: string;
+    /** The fault the tool is stuck with, if any. */
+    fault?: string;
+    safety?: boolean;
+    /** 0..1 */
+    heat?: number;
 }
 /**
  * What the host lends a module that brings its own presentation (a weapon in the hands, sounds, ejected casings). `THREE`, `scene` and `camera`
@@ -760,6 +1008,13 @@ interface ModuleHost {
     onFrame(update: (dt: number) => void): () => void;
     /** Write a line to the host's behaviour log. */
     log(text: string, data?: Record<string, unknown>): void;
+    /**
+     * Sets what the host lets a module tune on its tools, keyed by the id of the module's own control (`ModuleControl.id`) with the id of the option as the value; the tool in hand changes at once and the
+     * ones taken later start that way. A host applies the ids it knows and ignores the rest. The test room knows `condition` (how worn the tools are) and `ammo_quality` (how good what they load is).
+     */
+    configureTool?(settings: Readonly<Record<string, string>>): void;
+    /** Lent only to a module that declares controls, layers or metrics. */
+    bench?: ModuleBench;
 }
 /** What a module hands the test room: its items and, optionally, scenarios that exercise them, its area and its own presentation. */
 interface TestableModule<Context = unknown> {
@@ -772,8 +1027,94 @@ interface TestableModule<Context = unknown> {
     scenarios?(locale: string): Array<ModuleScenario<Context>>;
     /** How to set the area up when the host opens the module's group. Without it the host lays the items in rows. */
     area?(locale: string): ModuleArea;
+    /** The bench: what the viewer can set (controls), turn on or off (layers) and watch (metrics). Names already translated for `locale`. */
+    controls?(locale: string): ModuleControl[];
+    layers?(locale: string): ModuleLayer[];
+    metrics?(locale: string): ModuleMetric[];
     /** Called once when the module is loaded, with what the host lends. Returns the function that undoes it. */
     attach?(host: ModuleHost): () => void;
 }
 
-export { type AnimationClipSpec, type AnimationEventSpec, type AnimationKey, type AnimationPose, type AreaPlacement, type CheckOptions, type CheckSpecOptions, type ContainerSpec, type Crack, type DamageType, type DebrisKind, type Dent, type DestructibleImpl, type DestructibleSpec, type DestructionEvent, type DestructionEventType, type FluidKind, type FractureStyle, type Fragment, type Hit, type HitResult, type Hole, type HostEvent, type HostTool, IMPACT_CONTRACT, type ImpactContract, type ItemAnimationContract, type ItemUseDef, type JointKind, type JointSpec, type JointState, type LiquidId, type MaterialId, type ModuleArea, type ModuleHost, type ModuleItemFluid, type ModuleScenario, type ObjectState, type PartShape, type PartSpec, type PartState, type PartStatus, type Quat, type RayHit, type Shot, type SpecReport, type StructureRole, type TestableItem, type TestableModule, type ToolKind, type Use, type Vec3, checkAnimation, checkDestructible, checkHit, checkSpec, shotToHit };
+/** Clips a tool can bring, one per move of its cycle. A tool brings the ones it has; a missing clip is simply not played. */
+declare const TOOL_CLIP: {
+    readonly DRAW: "draw";
+    readonly SHOT: "shot";
+    readonly MISFIRE: "misfire";
+    readonly EMPTY: "empty";
+    readonly CYCLE: "cycle";
+    readonly RELOAD: "reload";
+    readonly FEED: "feed";
+    readonly FAULT: "fault";
+    readonly CLEAR: "clear";
+    readonly SAFETY_ON: "safety_on";
+    readonly SAFETY_OFF: "safety_off";
+    readonly MODE: "mode";
+    /** A throwable with the pin out, held until it is thrown. */
+    readonly COOK: "cook";
+};
+type ToolClipId = (typeof TOOL_CLIP)[keyof typeof TOOL_CLIP];
+/** What a renderer does when a rule event arrives. `variant` picks `<clip>_<variant>` when the tool has it, else `<clip>`. */
+type ToolAnimationStep = {
+    readonly type: 'play';
+    readonly clip: ToolClipId;
+    readonly variant?: string;
+    readonly duration?: number;
+    readonly repeat?: number;
+}
+/** Move the clip that is playing to the marker (a clip event `stage` with `data.stage`) the rule just reached. */
+ | {
+    readonly type: 'sync';
+    readonly stage: string;
+}
+/** The rule says the phase is over: the clip jumps to its end if it is still running. */
+ | {
+    readonly type: 'finish';
+    readonly clip: ToolClipId;
+};
+/** The move a host event asks of the tool in hand, or null when it has no motion. */
+declare const toolAnimationStep: (event: HostEvent) => ToolAnimationStep | null;
+/** Where a renderer puts the poses: every part of the tool by id (the ids the clips move), and the whole tool. Poses are offsets from rest. */
+interface ToolRig {
+    setPartPose(partId: string, pose: AnimationPose): void;
+    setRootPose?(pose: AnimationPose): void;
+}
+/** Clips by id, with the variants as `<clip>_<variant>`. */
+type ToolClipSet = Readonly<Record<string, AnimationClipSpec>>;
+/** A renderer's tool animator: feed it the host events and the frame time. */
+interface ToolAnimator {
+    handle(event: HostEvent): void;
+    update(dt: number): void;
+    /** Ids of the clips playing now. */
+    readonly playing: readonly string[];
+    dispose(): void;
+}
+declare const STAGE_EVENT = "stage";
+/** The clip with its times (keys and events) scaled so that it lasts `duration` seconds. */
+declare const scaleClip: (clip: AnimationClipSpec, duration: number) => AnimationClipSpec;
+/** Pose of the whole tool (`partId` undefined) or of one part at `time`, linear between keys; a key that does not name it means rest. */
+declare const sampleClip: (clip: AnimationClipSpec, partId: string | undefined, time: number) => {
+    position: [number, number, number];
+    rotation: [number, number, number];
+};
+/** Problems with a clip set (empty when valid): each key is the clip id (or `<clip>_<variant>`), every clip passes `checkAnimation`, and a `stage` event names its stage. */
+declare const checkToolClips: (clips: ToolClipSet, partIds: Iterable<string>) => {
+    ok: boolean;
+    problems: string[];
+};
+interface ToolClipPlayerOptions {
+    clips: ToolClipSet;
+    rig: ToolRig;
+    /** Called for each clip event as its time passes (`eject_casing`, `drop_magazine`, `stage`...). */
+    onEvent?(event: AnimationEventSpec, clip: string): void;
+    /** Seconds between the rounds of a `repeat` (a burst): default 0.1. */
+    repeatInterval?(): number;
+}
+/** The default player of a tool's clips: runs the steps of `toolAnimationStep` against a rig, scaled to the duration the rule gives. */
+interface ToolClipPlayer {
+    apply(step: ToolAnimationStep): void;
+    update(dt: number): void;
+    readonly playing: readonly string[];
+}
+declare const createToolClipPlayer: (options: ToolClipPlayerOptions) => ToolClipPlayer;
+
+export { type ActionControl, type AnimationClipSpec, type AnimationEventSpec, type AnimationKey, type AnimationPose, type AreaPlacement, type BenchChange, type BenchDeclaration, type BenchReport, type BooleanControl, type ChainDelay, type CheckOptions, type CheckSpecOptions, type ChoiceControl, type ChoiceOption, type ContainerSpec, type ControlPatch, type ControlValue, type Crack, type DamageType, type DebrisKind, type Dent, type DestructibleImpl, type DestructibleSpec, type DestructionEvent, type DestructionEventType, type ExplosionChain, type FluidKind, type FractureStyle, type Fragment, type Hit, type HitResult, type Hole, type HostEvent, type HostTool, IMPACT_CONTRACT, type ImpactContract, type ItemAnimationContract, type ItemUseDef, type JointKind, type JointSpec, type JointState, type LiquidId, type MaterialId, type ModuleArea, type ModuleBench, type ModuleControl, type ModuleHost, type ModuleItemFluid, type ModuleLayer, type ModuleMetric, type ModuleScenario, type NumberControl, type ObjectState, type PartShape, type PartSpec, type PartState, type PartStatus, type Quat, type RayHit, STAGE_EVENT, type Shot, type SpecReport, type StructureRole, TOOL_CLIP, type TestableItem, type TestableModule, type ToolAnimationStep, type ToolAnimator, type ToolClipId, type ToolClipPlayer, type ToolClipPlayerOptions, type ToolClipSet, type ToolKind, type ToolRig, type Use, type Vec3, checkAnimation, checkBench, checkDestructible, checkHit, checkSpec, checkToolClips, createToolClipPlayer, sampleClip, scaleClip, shotToHit, toolAnimationStep };