@adatechnology/game-contracts 0.11.0 → 0.13.0

package/dist/index.d.ts

@@ -1085,6 +1085,10 @@ interface EffectRequest {
     readonly param?: number | string;
     /** Multiplies the effect's size and amount. */
     readonly scale?: number;
+    /** Which way a thing the effect belongs to is turned, as a unit quaternion `[x, y, z, w]` (the barrel of a weapon, pitch and roll included): an effect written around the thing's own axes follows it. A host that cannot turn an effect fully uses `direction`. */
+    readonly orientation?: readonly [number, number, number, number];
+    /** Named numbers the effect reads (a size, a length of time, a rate): which ones belong to the effect, and an effect that does not read one ignores it. */
+    readonly values?: Readonly<Record<string, number>>;
 }
 /** Identifies a running effect so it can be stopped. */
 type EffectHandle = number;
@@ -1518,6 +1522,11 @@ interface ModuleHost {
     on(listener: (event: HostEvent) => void): () => void;
     /** Run every simulated frame with the frame's seconds. Returns the unsubscribe function. */
     onFrame(update: (dt: number) => void): () => void;
+    /**
+     * Follow the host clearing its area (`clear()`, opening an area, running scenarios): everything the module put in the world on its own (not as items) is to be taken away or put back. Returns the
+     * unsubscribe function. A host that never clears leaves it out.
+     */
+    onClear?(listener: () => void): () => void;
     /** Write a line to the host's behaviour log. */
     log(text: string, data?: Record<string, unknown>): void;
     /**
@@ -1525,6 +1534,11 @@ interface ModuleHost {
      * 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;
+    /**
+     * Adds a place the walking player cannot enter: `blocked(x, z, radius)` answers for a disc of the player's `radius` centred on the world point (x, z). A module with walls of its own (a house) uses it so the
+     * player stops at them; the function is asked on every step, so it may follow a door that opens. Returns the function that takes it away. A host without a walking player leaves it out.
+     */
+    addBlocker?(blocked: (x: number, z: number, radius: number) => boolean): () => void;
     /** Asks the tool in hand to do something (see `ToolCommand`). A host without accessories leaves it out. */
     command?(command: ToolCommand): ToolCommandResult;
     /** Lent only to a module that declares controls, layers or metrics. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adatechnology/game-contracts",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "license": "MIT",
   "description": "The contracts every game module depends on, and nothing else: destruction (parts, hits, events, DestructibleImpl), weapons (shots), fluids (containers, item uses), item animations and the TestableModule a module hands the test room. Types plus tiny checkers, no runtime dependencies.",
   "keywords": [