@datamoc/mw_games 0.3.1 → 0.4.1

package/dist/core/Scene.d.ts

@@ -1,14 +1,30 @@
-import { Container } from 'pixi.js';
 import { Signal } from './Signal.ts';
 /**
  * One screen of the game: a title, a menu, the dungeon itself.
  *
- * A scene owns a Pixi container and everything in it. Switching scenes destroys the old
- * one, so a scene may hold whatever state it likes without cleaning up by hand.
+ * This is the lifecycle half only, and owns no renderer: `create`, `update`, `resize`, the
+ * suspend/resume pair a pushed scene needs, and a destroy that fires once. `two-d.Scene2D`
+ * adds the Pixi container a 2D game draws into; a Babylon game supplies its own equivalent.
+ * The split exists so `SceneStack` - which never touches a display node, only these methods -
+ * works for either, rather than scene management being something only a Pixi game gets.
+ *
+ * Switching scenes destroys the old one, so a scene may hold whatever state it likes without
+ * cleaning up by hand.
+ *
+ * @example
+ * ```ts
+ * import { Scene } from '@datamoc/mw_games/core';
+ *
+ * // a 2D game extends two-d.Scene2D instead, which adds the Pixi display container;
+ * // this base is what a renderer-free game (or a Babylon one) extends directly.
+ * class TitleScreen extends Scene {
+ *   create(): void {
+ *     // build the screen's own state here
+ *   }
+ * }
+ * ```
  */
 export declare abstract class Scene {
-    /** everything this scene draws hangs off here */
-    readonly stage: Container<import("pixi.js").ContainerChild>;
     /** fires when the scene is torn down, for listeners that need to detach */
     readonly onDestroy: Signal<void>;
     private destroyed;
@@ -34,7 +50,14 @@ export declare abstract class Scene {
      */
     onResume(_result: unknown): void;
     destroy(): void;
+    /**
+     * Renderer-owned resources this scene holds, released exactly once as it is destroyed.
+     *
+     * The base owns none, because it owns no renderer; `two-d.Scene2D` destroys its container
+     * here. A subclass overriding it does not need to call `super.teardown()`.
+     */
+    protected teardown(): void;
     get isDestroyed(): boolean;
 }
-export type SceneClass = new () => Scene;
+export type SceneClass<T extends Scene = Scene> = new () => T;
 //# sourceMappingURL=Scene.d.ts.map

package/dist/core/Scene.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Scene.d.ts","sourceRoot":"","sources":["../../src/core/Scene.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;;;GAKG;AACH,8BAAsB,KAAK;IAC1B,iDAAiD;IACjD,QAAQ,CAAC,KAAK,8CAAmB;IAEjC,2EAA2E;IAC3E,QAAQ,CAAC,SAAS,eAAsB;IAExC,OAAO,CAAC,SAAS,CAAS;IAE1B,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC;IAExB,kEAAkE;IAClE,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAExB;IAED,6EAA6E;IAC7E,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAE5C;IAED;;;;;;OAMG;IACH,SAAS,IAAI,IAAI,CAEhB;IAED;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAE/B;IAED,OAAO,IAAI,IAAI,CAOd;IAED,IAAI,WAAW,IAAI,OAAO,CAEzB;CACD;AAED,MAAM,MAAM,UAAU,GAAG,UAAU,KAAK,CAAC"}
+{"version":3,"file":"Scene.d.ts","sourceRoot":"","sources":["../../src/core/Scene.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,8BAAsB,KAAK;IAC1B,2EAA2E;IAC3E,QAAQ,CAAC,SAAS,eAAsB;IAExC,OAAO,CAAC,SAAS,CAAS;IAE1B,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC;IAExB,kEAAkE;IAClE,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAExB;IAED,6EAA6E;IAC7E,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAE5C;IAED;;;;;;OAMG;IACH,SAAS,IAAI,IAAI,CAEhB;IAED;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAE/B;IAED,OAAO,IAAI,IAAI,CAOd;IAED;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,IAAI,IAAI,CAEzB;IAED,IAAI,WAAW,IAAI,OAAO,CAEzB;CACD;AAED,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,IAAI,UAAU,CAAC,CAAC"}

package/dist/core/Scene.js

@@ -1,15 +1,31 @@
-import { Container } from 'pixi.js';
 import { Signal } from './Signal.js';
 /**
  * One screen of the game: a title, a menu, the dungeon itself.
  *
- * A scene owns a Pixi container and everything in it. Switching scenes destroys the old
- * one, so a scene may hold whatever state it likes without cleaning up by hand.
+ * This is the lifecycle half only, and owns no renderer: `create`, `update`, `resize`, the
+ * suspend/resume pair a pushed scene needs, and a destroy that fires once. `two-d.Scene2D`
+ * adds the Pixi container a 2D game draws into; a Babylon game supplies its own equivalent.
+ * The split exists so `SceneStack` - which never touches a display node, only these methods -
+ * works for either, rather than scene management being something only a Pixi game gets.
+ *
+ * Switching scenes destroys the old one, so a scene may hold whatever state it likes without
+ * cleaning up by hand.
+ *
+ * @example
+ * ```ts
+ * import { Scene } from '@datamoc/mw_games/core';
+ *
+ * // a 2D game extends two-d.Scene2D instead, which adds the Pixi display container;
+ * // this base is what a renderer-free game (or a Babylon one) extends directly.
+ * class TitleScreen extends Scene {
+ *   create(): void {
+ *     // build the screen's own state here
+ *   }
+ * }
+ * ```
  */
 export class Scene {
     constructor() {
-        /** everything this scene draws hangs off here */
-        this.stage = new Container();
         /** fires when the scene is torn down, for listeners that need to detach */
         this.onDestroy = new Signal();
         this.destroyed = false;
@@ -47,7 +63,16 @@ export class Scene {
         this.destroyed = true;
         this.onDestroy.dispatch();
         this.onDestroy.removeAll();
-        this.stage.destroy({ children: true });
+        this.teardown();
+    }
+    /**
+     * Renderer-owned resources this scene holds, released exactly once as it is destroyed.
+     *
+     * The base owns none, because it owns no renderer; `two-d.Scene2D` destroys its container
+     * here. A subclass overriding it does not need to call `super.teardown()`.
+     */
+    teardown() {
+        //nothing renderer-shaped at this level
     }
     get isDestroyed() {
         return this.destroyed;

package/dist/core/Scene.js.map

@@ -1 +1 @@
-{"version":3,"file":"Scene.js","sourceRoot":"","sources":["../../src/core/Scene.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;;;GAKG;AACH,MAAM,OAAgB,KAAK;IAA3B;QACC,iDAAiD;QACxC,UAAK,GAAG,IAAI,SAAS,EAAE,CAAC;QAEjC,2EAA2E;QAClE,cAAS,GAAG,IAAI,MAAM,EAAQ,CAAC;QAEhC,cAAS,GAAG,KAAK,CAAC;IAgD3B,CAAC;IA3CA,kEAAkE;IAClE,MAAM,CAAC,GAAW;QACjB,wDAAwD;IACzD,CAAC;IAED,6EAA6E;IAC7E,MAAM,CAAC,MAAc,EAAE,OAAe;QACrC,yDAAyD;IAC1D,CAAC;IAED;;;;;;OAMG;IACH,SAAS;QACR,kDAAkD;IACnD,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,OAAgB;QACxB,uDAAuD;IACxD,CAAC;IAED,OAAO;QACN,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;QAC3B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,IAAI,WAAW;QACd,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;CACD"}
+{"version":3,"file":"Scene.js","sourceRoot":"","sources":["../../src/core/Scene.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,OAAgB,KAAK;IAA3B;QACC,2EAA2E;QAClE,cAAS,GAAG,IAAI,MAAM,EAAQ,CAAC;QAEhC,cAAS,GAAG,KAAK,CAAC;IA0D3B,CAAC;IArDA,kEAAkE;IAClE,MAAM,CAAC,GAAW;QACjB,wDAAwD;IACzD,CAAC;IAED,6EAA6E;IAC7E,MAAM,CAAC,MAAc,EAAE,OAAe;QACrC,yDAAyD;IAC1D,CAAC;IAED;;;;;;OAMG;IACH,SAAS;QACR,kDAAkD;IACnD,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,OAAgB;QACxB,uDAAuD;IACxD,CAAC;IAED,OAAO;QACN,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;QAC3B,IAAI,CAAC,QAAQ,EAAE,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACO,QAAQ;QACjB,uCAAuC;IACxC,CAAC;IAED,IAAI,WAAW;QACd,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;CACD"}

package/dist/core/SceneStack.d.ts

@@ -2,6 +2,10 @@ import type { Scene } from './Scene.ts';
 /**
  * The stack of scenes a `Game` runs: exactly one updates, all render.
  *
+ * Generic over the scene type, and typed against `core.Scene`'s lifecycle rather than any
+ * display node, so a Pixi game uses `SceneStack<Scene2D>` and a Babylon game its own - this
+ * class only ever calls `create`, `destroy`, `resize`, `update`, `onSuspend` and `onResume`.
+ *
  * `switchScene` replaces the whole stack, for moving between screens.
  * `pushScene` suspends the current scene and starts another on top of it - a
  * minigame over the dungeon, a pause menu over play - and `popScene` destroys
@@ -11,16 +15,36 @@ import type { Scene } from './Scene.ts';
  *
  * Takes instances, never classes: constructing scenes is the `Game`'s job, and
  * keeping it out is what keeps this testable without a browser.
+ *
+ * @example
+ * ```ts
+ * import { SceneStack, Scene } from '@datamoc/mw_games/core';
+ *
+ * class DungeonScene extends Scene {
+ *   create(): void {}
+ *   onResume(result: unknown): void {
+ *     console.log('the pushed scene reported back', result);
+ *   }
+ * }
+ * class PauseMenu extends Scene {
+ *   create(): void {}
+ * }
+ *
+ * const stack = new SceneStack();
+ * stack.replace(new DungeonScene());
+ * stack.push(new PauseMenu()); // dungeon suspends, pause menu draws over it
+ * stack.pop('resumed'); // pause menu destroyed, DungeonScene.onResume('resumed') fires
+ * ```
  */
-export declare class SceneStack {
+export declare class SceneStack<T extends Scene = Scene> {
     private scenes;
     /** the scene that updates, or null when the stack is empty */
-    get current(): Scene | null;
+    get current(): T | null;
     get depth(): number;
     /** replaces everything with one scene, destroying what was there */
-    replace(scene: Scene): void;
+    replace(scene: T): void;
     /** suspends the current scene and starts another above it */
-    push(scene: Scene): void;
+    push(scene: T): void;
     /**
      * Destroys the top scene and resumes the one below with `result`.
      *

package/dist/core/SceneStack.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SceneStack.d.ts","sourceRoot":"","sources":["../../src/core/SceneStack.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;;;;;;;GAYG;AACH,qBAAa,UAAU;IACtB,OAAO,CAAC,MAAM,CAAe;IAE7B,8DAA8D;IAC9D,IAAI,OAAO,IAAI,KAAK,GAAG,IAAI,CAE1B;IAED,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,oEAAoE;IACpE,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAI1B;IAED,6DAA6D;IAC7D,IAAI,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAIvB;IAED;;;;;OAKG;IACH,GAAG,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAO1B;IAED,kEAAkE;IAClE,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAEvB;IAED,6EAA6E;IAC7E,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAE1C;IAED,OAAO,IAAI,IAAI,CAGd;CACD"}
+{"version":3,"file":"SceneStack.d.ts","sourceRoot":"","sources":["../../src/core/SceneStack.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,UAAU,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK;IAC9C,OAAO,CAAC,MAAM,CAAW;IAEzB,8DAA8D;IAC9D,IAAI,OAAO,IAAI,CAAC,GAAG,IAAI,CAEtB;IAED,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,oEAAoE;IACpE,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,CAItB;IAED,6DAA6D;IAC7D,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,CAInB;IAED;;;;;OAKG;IACH,GAAG,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAO1B;IAED,kEAAkE;IAClE,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAEvB;IAED,6EAA6E;IAC7E,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAE1C;IAED,OAAO,IAAI,IAAI,CAGd;CACD"}

package/dist/core/SceneStack.js

@@ -1,6 +1,10 @@
 /**
  * The stack of scenes a `Game` runs: exactly one updates, all render.
  *
+ * Generic over the scene type, and typed against `core.Scene`'s lifecycle rather than any
+ * display node, so a Pixi game uses `SceneStack<Scene2D>` and a Babylon game its own - this
+ * class only ever calls `create`, `destroy`, `resize`, `update`, `onSuspend` and `onResume`.
+ *
  * `switchScene` replaces the whole stack, for moving between screens.
  * `pushScene` suspends the current scene and starts another on top of it - a
  * minigame over the dungeon, a pause menu over play - and `popScene` destroys
@@ -10,6 +14,26 @@
  *
  * Takes instances, never classes: constructing scenes is the `Game`'s job, and
  * keeping it out is what keeps this testable without a browser.
+ *
+ * @example
+ * ```ts
+ * import { SceneStack, Scene } from '@datamoc/mw_games/core';
+ *
+ * class DungeonScene extends Scene {
+ *   create(): void {}
+ *   onResume(result: unknown): void {
+ *     console.log('the pushed scene reported back', result);
+ *   }
+ * }
+ * class PauseMenu extends Scene {
+ *   create(): void {}
+ * }
+ *
+ * const stack = new SceneStack();
+ * stack.replace(new DungeonScene());
+ * stack.push(new PauseMenu()); // dungeon suspends, pause menu draws over it
+ * stack.pop('resumed'); // pause menu destroyed, DungeonScene.onResume('resumed') fires
+ * ```
  */
 export class SceneStack {
     constructor() {

package/dist/core/SceneStack.js.map

@@ -1 +1 @@
-{"version":3,"file":"SceneStack.js","sourceRoot":"","sources":["../../src/core/SceneStack.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,UAAU;IAAvB;QACS,WAAM,GAAY,EAAE,CAAC;IAsD9B,CAAC;IApDA,8DAA8D;IAC9D,IAAI,OAAO;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED,oEAAoE;IACpE,OAAO,CAAC,KAAY;QACnB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM;YAAE,GAAG,CAAC,OAAO,EAAE,CAAC;QAC7C,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,CAAC;QACtB,KAAK,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED,6DAA6D;IAC7D,IAAI,CAAC,KAAY;QAChB,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC;QAC1B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,KAAK,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,MAAgB;QACnB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;QAC5F,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QAC9B,GAAG,EAAE,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAED,kEAAkE;IAClE,MAAM,CAAC,EAAU;QAChB,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IAC1B,CAAC;IAED,6EAA6E;IAC7E,MAAM,CAAC,KAAa,EAAE,MAAc;QACnC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM;YAAE,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO;QACN,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM;YAAE,KAAK,CAAC,OAAO,EAAE,CAAC;QACjD,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IAClB,CAAC;CACD"}
+{"version":3,"file":"SceneStack.js","sourceRoot":"","sources":["../../src/core/SceneStack.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,OAAO,UAAU;IAAvB;QACS,WAAM,GAAQ,EAAE,CAAC;IAsD1B,CAAC;IApDA,8DAA8D;IAC9D,IAAI,OAAO;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED,oEAAoE;IACpE,OAAO,CAAC,KAAQ;QACf,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM;YAAE,GAAG,CAAC,OAAO,EAAE,CAAC;QAC7C,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,CAAC;QACtB,KAAK,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED,6DAA6D;IAC7D,IAAI,CAAC,KAAQ;QACZ,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC;QAC1B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,KAAK,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,MAAgB;QACnB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;QAC5F,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QAC9B,GAAG,EAAE,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAED,kEAAkE;IAClE,MAAM,CAAC,EAAU;QAChB,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IAC1B,CAAC;IAED,6EAA6E;IAC7E,MAAM,CAAC,KAAa,EAAE,MAAc;QACnC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM;YAAE,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO;QACN,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM;YAAE,KAAK,CAAC,OAAO,EAAE,CAAC;QACjD,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IAClB,CAAC;CACD"}

package/dist/core/Scramble.d.ts

@@ -6,6 +6,14 @@
  * classic XOR weakness, accepted on purpose rather than overlooked. Reach for this only
  * where "not trivially editable" is the actual requirement, per `SaveSystem.exportSlot`'s
  * own use of it.
+ *
+ * @example
+ * ```ts
+ * import { scramble, unscramble } from '@datamoc/mw_games/core';
+ *
+ * const scrambled = scramble('{"depth":3}', 'a-per-game-key');
+ * const restored = unscramble(scrambled, 'a-per-game-key'); // '{"depth":3}'
+ * ```
  */
 export declare function scramble(text: string, key: string): string;
 /** reverses `scramble`; throws if `key` does not match the one it was scrambled with (garbled UTF-8 rather than a silent wrong answer) */

package/dist/core/Scramble.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Scramble.d.ts","sourceRoot":"","sources":["../../src/core/Scramble.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAO1D;AAED,0IAA0I;AAC1I,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAO/D"}
+{"version":3,"file":"Scramble.d.ts","sourceRoot":"","sources":["../../src/core/Scramble.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAO1D;AAED,0IAA0I;AAC1I,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAO/D"}

package/dist/core/Scramble.js

@@ -6,6 +6,14 @@
  * classic XOR weakness, accepted on purpose rather than overlooked. Reach for this only
  * where "not trivially editable" is the actual requirement, per `SaveSystem.exportSlot`'s
  * own use of it.
+ *
+ * @example
+ * ```ts
+ * import { scramble, unscramble } from '@datamoc/mw_games/core';
+ *
+ * const scrambled = scramble('{"depth":3}', 'a-per-game-key');
+ * const restored = unscramble(scrambled, 'a-per-game-key'); // '{"depth":3}'
+ * ```
  */
 export function scramble(text, key) {
     if (!key)

package/dist/core/Scramble.js.map

@@ -1 +1 @@
-{"version":3,"file":"Scramble.js","sourceRoot":"","sources":["../../src/core/Scramble.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,GAAW;IACjD,IAAI,CAAC,GAAG;QAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC/C,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;IACzF,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;AACtB,CAAC;AAED,0IAA0I;AAC1I,MAAM,UAAU,UAAU,CAAC,OAAe,EAAE,GAAW;IACtD,IAAI,CAAC,GAAG;QAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC/C,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;IACzF,OAAO,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAC9D,CAAC;AAED,SAAS,QAAQ,CAAC,KAAiB;IAClC,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,IAAI,IAAI,KAAK;QAAE,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC9D,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;AACrB,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACxE,OAAO,KAAK,CAAC;AACd,CAAC"}
+{"version":3,"file":"Scramble.js","sourceRoot":"","sources":["../../src/core/Scramble.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,GAAW;IACjD,IAAI,CAAC,GAAG;QAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC/C,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;IACzF,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;AACtB,CAAC;AAED,0IAA0I;AAC1I,MAAM,UAAU,UAAU,CAAC,OAAe,EAAE,GAAW;IACtD,IAAI,CAAC,GAAG;QAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC/C,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;IACzF,OAAO,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAC9D,CAAC;AAED,SAAS,QAAQ,CAAC,KAAiB;IAClC,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,IAAI,IAAI,KAAK;QAAE,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC9D,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;AACrB,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACxE,OAAO,KAAK,CAAC;AACd,CAAC"}

package/dist/core/Session.d.ts

@@ -7,6 +7,16 @@ import { type SaveStorage } from './Save.ts';
  * Tauri, whatever a game ships through) needs to decide whether a player has used the
  * game enough to plausibly be worth asking for a rating. `mwg` only counts; it never
  * prompts, and has no opinion on what "enough" means.
+ *
+ * @example
+ * ```ts
+ * import { Session } from '@datamoc/mw_games/core';
+ *
+ * const session = new Session({ namespace: 'my-game' });
+ * if (session.launches === 5) {
+ *   // a native wrapper's own moment to ask for a rating - mwg never prompts itself
+ * }
+ * ```
  */
 export interface SessionOptions {
     /** namespaces the count, so two games sharing an origin never collide */

package/dist/core/Session.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Session.d.ts","sourceRoot":"","sources":["../../src/core/Session.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7D;;;;;;;;GAQG;AAEH,MAAM,WAAW,cAAc;IAC9B,yEAAyE;IACzE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,qBAAa,OAAO;IACnB,qEAAqE;IACrE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B,YAAY,OAAO,GAAE,cAAmB,EAOvC;CACD"}
+{"version":3,"file":"Session.d.ts","sourceRoot":"","sources":["../../src/core/Session.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7D;;;;;;;;;;;;;;;;;;GAkBG;AAEH,MAAM,WAAW,cAAc;IAC9B,yEAAyE;IACzE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,qBAAa,OAAO;IACnB,qEAAqE;IACrE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B,YAAY,OAAO,GAAE,cAAmB,EAOvC;CACD"}

package/dist/core/Session.js.map

@@ -1 +1 @@
-{"version":3,"file":"Session.js","sourceRoot":"","sources":["../../src/core/Session.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAoB,MAAM,WAAW,CAAC;AAkB7D,MAAM,OAAO,OAAO;IAInB,YAAY,OAAO,GAAmB,EAAE;QACvC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,cAAc,EAAE,CAAC;QACpD,MAAM,GAAG,GAAG,eAAe,OAAO,CAAC,SAAS,IAAI,SAAS,EAAE,CAAC;QAE5D,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC/D,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3C,CAAC;CACD"}
+{"version":3,"file":"Session.js","sourceRoot":"","sources":["../../src/core/Session.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAoB,MAAM,WAAW,CAAC;AA4B7D,MAAM,OAAO,OAAO;IAInB,YAAY,OAAO,GAAmB,EAAE;QACvC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,cAAc,EAAE,CAAC;QACpD,MAAM,GAAG,GAAG,eAAe,OAAO,CAAC,SAAS,IAAI,SAAS,EAAE,CAAC;QAE5D,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC/D,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3C,CAAC;CACD"}

package/dist/core/Signal.d.ts

@@ -4,6 +4,17 @@
  * Unlike a DOM event, a listener returning `true` stops the dispatch. Input handling in a
  * roguelike needs that: a modal window has to be able to swallow a keypress before the map
  * below it sees it.
+ *
+ * @example
+ * ```ts
+ * import { Signal } from '@datamoc/mw_games/core';
+ *
+ * const onDamage = new Signal<{ amount: number }>();
+ * onDamage.add(({ amount }) => {
+ *   console.log(`took ${amount} damage`);
+ * });
+ * onDamage.dispatch({ amount: 5 });
+ * ```
  */
 export type SignalListener<T> = (value: T) => boolean | void;
 export declare class Signal<T> {

package/dist/core/Signal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Signal.d.ts","sourceRoot":"","sources":["../../src/core/Signal.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAAG,IAAI,CAAC;AAE7D,qBAAa,MAAM,CAAC,CAAC;IACpB,OAAO,CAAC,SAAS,CAA2B;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IAEpC;;;OAGG;IACH,YAAY,SAAS,UAAQ,EAE5B;IAED,GAAG,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI,CAKrC;IAED,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI,CAGxC;IAED,SAAS,IAAI,IAAI,CAEhB;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,qDAAqD;IACrD,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAS1B;CACD"}
+{"version":3,"file":"Signal.d.ts","sourceRoot":"","sources":["../../src/core/Signal.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAAG,IAAI,CAAC;AAE7D,qBAAa,MAAM,CAAC,CAAC;IACpB,OAAO,CAAC,SAAS,CAA2B;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IAEpC;;;OAGG;IACH,YAAY,SAAS,UAAQ,EAE5B;IAED,GAAG,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI,CAKrC;IAED,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI,CAGxC;IAED,SAAS,IAAI,IAAI,CAEhB;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,qDAAqD;IACrD,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAS1B;CACD"}

package/dist/core/Signal.js.map

@@ -1 +1 @@
-{"version":3,"file":"Signal.js","sourceRoot":"","sources":["../../src/core/Signal.ts"],"names":[],"mappings":"AASA,MAAM,OAAO,MAAM;IAIlB;;;OAGG;IACH,YAAY,SAAS,GAAG,KAAK;QAPrB,cAAS,GAAwB,EAAE,CAAC;QAQ3C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC5B,CAAC;IAED,GAAG,CAAC,QAA2B;QAC9B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxC,IAAI,IAAI,CAAC,SAAS;gBAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;;gBAChD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC;IACF,CAAC;IAED,MAAM,CAAC,QAA2B;QACjC,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK,CAAC,CAAC;YAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED,SAAS;QACR,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,IAAI,IAAI;QACP,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED,qDAAqD;IACrD,QAAQ,CAAC,KAAQ;QAChB,yEAAyE;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACxC,KAAK,MAAM,QAAQ,IAAI,QAAQ,EAAE,CAAC;YACjC,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;gBACnE,OAAO,IAAI,CAAC;YACb,CAAC;QACF,CAAC;QACD,OAAO,KAAK,CAAC;IACd,CAAC;CACD"}
+{"version":3,"file":"Signal.js","sourceRoot":"","sources":["../../src/core/Signal.ts"],"names":[],"mappings":"AAoBA,MAAM,OAAO,MAAM;IAIlB;;;OAGG;IACH,YAAY,SAAS,GAAG,KAAK;QAPrB,cAAS,GAAwB,EAAE,CAAC;QAQ3C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC5B,CAAC;IAED,GAAG,CAAC,QAA2B;QAC9B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxC,IAAI,IAAI,CAAC,SAAS;gBAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;;gBAChD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC;IACF,CAAC;IAED,MAAM,CAAC,QAA2B;QACjC,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK,CAAC,CAAC;YAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED,SAAS;QACR,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,IAAI,IAAI;QACP,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED,qDAAqD;IACrD,QAAQ,CAAC,KAAQ;QAChB,yEAAyE;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACxC,KAAK,MAAM,QAAQ,IAAI,QAAQ,EAAE,CAAC;YACjC,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;gBACnE,OAAO,IAAI,CAAC;YACb,CAAC;QACF,CAAC;QACD,OAAO,KAAK,CAAC;IACd,CAAC;CACD"}

package/dist/core/Spawner.d.ts

@@ -30,6 +30,23 @@ export interface SpawnerOptions<T> {
  * The whole schedule is flattened and sorted once, at construction, rather than tracked wave
  * by wave - simpler to get right, and cheap enough that a spawner is not something a game
  * expects to have thousands of.
+ *
+ * @example
+ * ```ts
+ * import { Spawner } from '@datamoc/mw_games/core';
+ *
+ * const spawner = new Spawner<'rat' | 'bat'>({
+ *   waves: [
+ *     { delay: 0, entries: [{ kind: 'rat', count: 3 }], duration: 5 },
+ *     { delay: 20, entries: [{ kind: 'rat', count: 5 }, { kind: 'bat', count: 2 }], duration: 10 },
+ *   ],
+ *   onSpawn: (kind) => console.log('spawn', kind),
+ *   onWaveStart: (index) => console.log('wave', index, 'starting'),
+ * });
+ *
+ * // in the game loop:
+ * spawner.update(1 / 60);
+ * ```
  */
 export declare class Spawner<T> {
     private schedule;

package/dist/core/Spawner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Spawner.d.ts","sourceRoot":"","sources":["../../src/core/Spawner.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,IAAI,CAAC,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,SAAS;QAAE,IAAI,EAAE,CAAC,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAE/C,yFAAyF;IACzF,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc,CAAC,CAAC;IAChC,KAAK,EAAE,SAAS,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1B,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;IAE3B,uEAAuE;IACvE,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;IAE1C,sEAAsE;IACtE,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;CACxB;AAQD;;;;;;;;;;GAUG;AACH,qBAAa,OAAO,CAAC,CAAC;IACrB,OAAO,CAAC,QAAQ,CAA2B;IAC3C,OAAO,CAAC,MAAM,CAAK;IACnB,OAAO,CAAC,OAAO,CAAK;IAIpB,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,SAAS,CAAS;IAE1B,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,WAAW,CAAC,CAA8B;IAClD,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC,YAAY,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,EAuBrC;IAED,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAkBvB;IAED,mDAAmD;IACnD,IAAI,UAAU,IAAI,OAAO,CAExB;CACD"}
+{"version":3,"file":"Spawner.d.ts","sourceRoot":"","sources":["../../src/core/Spawner.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,IAAI,CAAC,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,SAAS;QAAE,IAAI,EAAE,CAAC,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAE/C,yFAAyF;IACzF,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc,CAAC,CAAC;IAChC,KAAK,EAAE,SAAS,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1B,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;IAE3B,uEAAuE;IACvE,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;IAE1C,sEAAsE;IACtE,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;CACxB;AAQD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,OAAO,CAAC,CAAC;IACrB,OAAO,CAAC,QAAQ,CAA2B;IAC3C,OAAO,CAAC,MAAM,CAAK;IACnB,OAAO,CAAC,OAAO,CAAK;IAIpB,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,SAAS,CAAS;IAE1B,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,WAAW,CAAC,CAA8B;IAClD,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC,YAAY,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,EAuBrC;IAED,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAkBvB;IAED,mDAAmD;IACnD,IAAI,UAAU,IAAI,OAAO,CAExB;CACD"}

package/dist/core/Spawner.js

@@ -8,6 +8,23 @@
  * The whole schedule is flattened and sorted once, at construction, rather than tracked wave
  * by wave - simpler to get right, and cheap enough that a spawner is not something a game
  * expects to have thousands of.
+ *
+ * @example
+ * ```ts
+ * import { Spawner } from '@datamoc/mw_games/core';
+ *
+ * const spawner = new Spawner<'rat' | 'bat'>({
+ *   waves: [
+ *     { delay: 0, entries: [{ kind: 'rat', count: 3 }], duration: 5 },
+ *     { delay: 20, entries: [{ kind: 'rat', count: 5 }, { kind: 'bat', count: 2 }], duration: 10 },
+ *   ],
+ *   onSpawn: (kind) => console.log('spawn', kind),
+ *   onWaveStart: (index) => console.log('wave', index, 'starting'),
+ * });
+ *
+ * // in the game loop:
+ * spawner.update(1 / 60);
+ * ```
  */
 export class Spawner {
     constructor(options) {

package/dist/core/Spawner.js.map

@@ -1 +1 @@
-{"version":3,"file":"Spawner.js","sourceRoot":"","sources":["../../src/core/Spawner.ts"],"names":[],"mappings":"AA8BA;;;;;;;;;;GAUG;AACH,MAAM,OAAO,OAAO;IAcnB,YAAY,OAA0B;QAb9B,aAAQ,GAAwB,EAAE,CAAC;QACnC,WAAM,GAAG,CAAC,CAAC;QACX,YAAO,GAAG,CAAC,CAAC;QACpB,uFAAuF;QACvF,uFAAuF;QACvF,oCAAoC;QAC5B,iBAAY,GAAG,IAAI,GAAG,EAAU,CAAC;QACjC,cAAS,GAAG,KAAK,CAAC;QAOzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QAErC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE;YACzC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACxE,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;YAEpC,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC3C,MAAM,MAAM,GAAG,KAAK,GAAG,CAAC,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC5E,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,GAAG,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBAChF,CAAC;YACF,CAAC;QACF,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;QACrB,CAAC;IACF,CAAC;IAED,MAAM,CAAC,EAAU;QAChB,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAC3B,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAEnB,OAAO,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC9F,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACzC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACvC,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACzB,IAAI,CAAC,MAAM,EAAE,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACzC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;QACrB,CAAC;IACF,CAAC;IAED,mDAAmD;IACnD,IAAI,UAAU;QACb,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;CACD"}
+{"version":3,"file":"Spawner.js","sourceRoot":"","sources":["../../src/core/Spawner.ts"],"names":[],"mappings":"AA8BA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,OAAO,OAAO;IAcnB,YAAY,OAA0B;QAb9B,aAAQ,GAAwB,EAAE,CAAC;QACnC,WAAM,GAAG,CAAC,CAAC;QACX,YAAO,GAAG,CAAC,CAAC;QACpB,uFAAuF;QACvF,uFAAuF;QACvF,oCAAoC;QAC5B,iBAAY,GAAG,IAAI,GAAG,EAAU,CAAC;QACjC,cAAS,GAAG,KAAK,CAAC;QAOzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QAErC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE;YACzC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACxE,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;YAEpC,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC3C,MAAM,MAAM,GAAG,KAAK,GAAG,CAAC,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC5E,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,GAAG,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBAChF,CAAC;YACF,CAAC;QACF,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;QACrB,CAAC;IACF,CAAC;IAED,MAAM,CAAC,EAAU;QAChB,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAC3B,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAEnB,OAAO,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC9F,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACzC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACvC,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACzB,IAAI,CAAC,MAAM,EAAE,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACzC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;QACrB,CAAC;IACF,CAAC;IAED,mDAAmD;IACnD,IAAI,UAAU;QACb,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;CACD"}

package/dist/core/Stats.d.ts

@@ -16,6 +16,20 @@ export interface PlayerStatsOptions<T, S = T> {
  * incrementally by `record` and never recomputed from a list that can shrink. A game wanting
  * both a "last 50 runs" list and a true lifetime total uses both classes side by side, each
  * for the question it actually answers.
+ *
+ * @example
+ * ```ts
+ * import { PlayerStats } from '@datamoc/mw_games/core';
+ *
+ * const lifetimeKills = new PlayerStats<number, number>({
+ *   namespace: 'my-game',
+ *   initial: 0,
+ *   combine: (total, killsThisRun) => total + killsThisRun,
+ * });
+ *
+ * lifetimeKills.record(12); // this run's own kill count folds into the total
+ * console.log(lifetimeKills.get());
+ * ```
  */
 export declare class PlayerStats<T, S = T> {
     private readonly storage;

package/dist/core/Stats.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Stats.d.ts","sourceRoot":"","sources":["../../src/core/Stats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7D,MAAM,WAAW,kBAAkB,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;IAC3C,gFAAgF;IAChF,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,uDAAuD;IACvD,OAAO,EAAE,CAAC,CAAC;IACX,yDAAyD;IACzD,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;CACrC;AAED;;;;;;;;GAQG;AACH,qBAAa,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAc;IACtC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAI;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA8B;IAEtD,YAAY,OAAO,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EAK5C;IAED,6EAA6E;IAC7E,GAAG,IAAI,CAAC,CAGP;IAED,sFAAsF;IACtF,MAAM,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAIpB;IAED,6EAA6E;IAC7E,KAAK,IAAI,IAAI,CAEZ;CACD"}
+{"version":3,"file":"Stats.d.ts","sourceRoot":"","sources":["../../src/core/Stats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7D,MAAM,WAAW,kBAAkB,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;IAC3C,gFAAgF;IAChF,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,uDAAuD;IACvD,OAAO,EAAE,CAAC,CAAC;IACX,yDAAyD;IACzD,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;CACrC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAc;IACtC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAI;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA8B;IAEtD,YAAY,OAAO,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EAK5C;IAED,6EAA6E;IAC7E,GAAG,IAAI,CAAC,CAGP;IAED,sFAAsF;IACtF,MAAM,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAIpB;IAED,6EAA6E;IAC7E,KAAK,IAAI,IAAI,CAEZ;CACD"}

package/dist/core/Stats.js

@@ -7,6 +7,20 @@ import { defaultStorage } from './Save.js';
  * incrementally by `record` and never recomputed from a list that can shrink. A game wanting
  * both a "last 50 runs" list and a true lifetime total uses both classes side by side, each
  * for the question it actually answers.
+ *
+ * @example
+ * ```ts
+ * import { PlayerStats } from '@datamoc/mw_games/core';
+ *
+ * const lifetimeKills = new PlayerStats<number, number>({
+ *   namespace: 'my-game',
+ *   initial: 0,
+ *   combine: (total, killsThisRun) => total + killsThisRun,
+ * });
+ *
+ * lifetimeKills.record(12); // this run's own kill count folds into the total
+ * console.log(lifetimeKills.get());
+ * ```
  */
 export class PlayerStats {
     constructor(options) {

package/dist/core/Stats.js.map

@@ -1 +1 @@
-{"version":3,"file":"Stats.js","sourceRoot":"","sources":["../../src/core/Stats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAoB,MAAM,WAAW,CAAC;AAY7D;;;;;;;;GAQG;AACH,MAAM,OAAO,WAAW;IAMvB,YAAY,OAAiC;QAC5C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,cAAc,EAAE,CAAC;QACnD,IAAI,CAAC,GAAG,GAAG,aAAa,OAAO,CAAC,SAAS,EAAE,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAChC,CAAC;IAED,6EAA6E;IAC7E,GAAG;QACF,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxC,OAAO,GAAG,CAAC,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACpD,CAAC;IAED,sFAAsF;IACtF,MAAM,CAAC,OAAU;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC;IACb,CAAC;IAED,6EAA6E;IAC7E,KAAK;QACJ,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC;CACD"}
+{"version":3,"file":"Stats.js","sourceRoot":"","sources":["../../src/core/Stats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAoB,MAAM,WAAW,CAAC;AAY7D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAO,WAAW;IAMvB,YAAY,OAAiC;QAC5C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,cAAc,EAAE,CAAC;QACnD,IAAI,CAAC,GAAG,GAAG,aAAa,OAAO,CAAC,SAAS,EAAE,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAChC,CAAC;IAED,6EAA6E;IAC7E,GAAG;QACF,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxC,OAAO,GAAG,CAAC,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACpD,CAAC;IAED,sFAAsF;IACtF,MAAM,CAAC,OAAU;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC;IACb,CAAC;IAED,6EAA6E;IAC7E,KAAK;QACJ,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC;CACD"}

package/dist/core/Telemetry.d.ts

@@ -20,6 +20,17 @@ export interface TelemetryResponse {
  * given game (a settings toggle, a first-launch prompt, a platform-level flag), and where the
  * endpoint lives - the same boundary `FeedbackClient`'s own doc comment draws for manual
  * reports.
+ *
+ * @example
+ * ```ts
+ * import { TelemetryClient } from '@datamoc/mw_games/core';
+ *
+ * const telemetry = new TelemetryClient({ endpoint: 'https://example.com/api/telemetry' });
+ *
+ * // nothing sends until a game's own consent flow grants it
+ * telemetry.setConsent(true);
+ * await telemetry.send({ name: 'level_started', properties: { level: 3 } });
+ * ```
  */
 export declare class TelemetryClient extends HttpTransport {
     private consented;

package/dist/core/Telemetry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Telemetry.d.ts","sourceRoot":"","sources":["../../src/core/Telemetry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE9E,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC;CAC9D;AAED,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC;AAEpD,MAAM,WAAW,iBAAiB;IACjC,EAAE,EAAE,OAAO,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,eAAgB,SAAQ,aAAa;IACjD,OAAO,CAAC,SAAS,CAAS;IAE1B,YAAY,OAAO,EAAE,gBAAgB,EAEpC;IAED,+DAA+D;IAC/D,IAAI,UAAU,IAAI,OAAO,CAExB;IAED,yFAAyF;IACzF,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAEjC;IAED,yFAAyF;IACnF,IAAI,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAcnE;CACD"}
+{"version":3,"file":"Telemetry.d.ts","sourceRoot":"","sources":["../../src/core/Telemetry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE9E,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC;CAC9D;AAED,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC;AAEpD,MAAM,WAAW,iBAAiB;IACjC,EAAE,EAAE,OAAO,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,eAAgB,SAAQ,aAAa;IACjD,OAAO,CAAC,SAAS,CAAS;IAE1B,YAAY,OAAO,EAAE,gBAAgB,EAEpC;IAED,+DAA+D;IAC/D,IAAI,UAAU,IAAI,OAAO,CAExB;IAED,yFAAyF;IACzF,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAEjC;IAED,yFAAyF;IACnF,IAAI,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAcnE;CACD"}

package/dist/core/Telemetry.js

@@ -11,6 +11,17 @@ import { HttpTransport } from './HttpTransport.js';
  * given game (a settings toggle, a first-launch prompt, a platform-level flag), and where the
  * endpoint lives - the same boundary `FeedbackClient`'s own doc comment draws for manual
  * reports.
+ *
+ * @example
+ * ```ts
+ * import { TelemetryClient } from '@datamoc/mw_games/core';
+ *
+ * const telemetry = new TelemetryClient({ endpoint: 'https://example.com/api/telemetry' });
+ *
+ * // nothing sends until a game's own consent flow grants it
+ * telemetry.setConsent(true);
+ * await telemetry.send({ name: 'level_started', properties: { level: 3 } });
+ * ```
  */
 export class TelemetryClient extends HttpTransport {
     constructor(options) {

package/dist/core/Telemetry.js.map

@@ -1 +1 @@
-{"version":3,"file":"Telemetry.js","sourceRoot":"","sources":["../../src/core/Telemetry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAA6B,MAAM,oBAAoB,CAAC;AAc9E;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,eAAgB,SAAQ,aAAa;IAGjD,YAAY,OAAyB;QACpC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAHrB,cAAS,GAAG,KAAK,CAAC;IAI1B,CAAC;IAED,+DAA+D;IAC/D,IAAI,UAAU;QACb,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IAED,yFAAyF;IACzF,UAAU,CAAC,OAAgB;QAC1B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,yFAAyF;IACzF,KAAK,CAAC,IAAI,CAAC,KAAqB;QAC/B,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACjE,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC;QAEjC,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACxC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE;gBAClD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;gBAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;gBAC3B,MAAM;aACN,CAAC,CAAC;YACH,IAAI,CAAC,QAAQ,CAAC,EAAE;gBAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YAC3F,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC9C,CAAC,CAAC,CAAC;IACJ,CAAC;CACD"}
+{"version":3,"file":"Telemetry.js","sourceRoot":"","sources":["../../src/core/Telemetry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAA6B,MAAM,oBAAoB,CAAC;AAc9E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,eAAgB,SAAQ,aAAa;IAGjD,YAAY,OAAyB;QACpC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAHrB,cAAS,GAAG,KAAK,CAAC;IAI1B,CAAC;IAED,+DAA+D;IAC/D,IAAI,UAAU;QACb,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IAED,yFAAyF;IACzF,UAAU,CAAC,OAAgB;QAC1B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,yFAAyF;IACzF,KAAK,CAAC,IAAI,CAAC,KAAqB;QAC/B,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACjE,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC;QAEjC,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACxC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE;gBAClD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;gBAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;gBAC3B,MAAM;aACN,CAAC,CAAC;YACH,IAAI,CAAC,QAAQ,CAAC,EAAE;gBAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YAC3F,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC9C,CAAC,CAAC,CAAC;IACJ,CAAC;CACD"}

package/dist/core/Tween.d.ts

@@ -7,7 +7,22 @@
 export type Easing = (t: number) => number;
 /** a small standard set, named the way CSS and most engines already do */
 export declare const Easing: Record<'linear' | 'easeInQuad' | 'easeOutQuad' | 'easeInOutQuad' | 'easeInCubic' | 'easeOutCubic' | 'easeInOutCubic', Easing>;
-/** Runs any number of concurrent tweens; a game or a widget drives it from its own `update(dt)`. */
+/**
+ * Runs any number of concurrent tweens; a game or a widget drives it from its own `update(dt)`.
+ *
+ * @example
+ * ```ts
+ * import { Tweener, Easing } from '@datamoc/mw_games/core';
+ *
+ * const tweener = new Tweener();
+ * const sprite = { alpha: 0 };
+ *
+ * tweener.tween(0.5, (t) => { sprite.alpha = t; }, Easing.easeOutQuad);
+ *
+ * // in the game loop:
+ * tweener.update(1 / 60);
+ * ```
+ */
 export declare class Tweener {
     private tweens;
     /**

package/dist/core/Tween.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Tween.d.ts","sourceRoot":"","sources":["../../src/core/Tween.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;AAE3C,0EAA0E;AAC1E,eAAO,MAAM,MAAM,EAAE,MAAM,CAC1B,QAAQ,GAAG,YAAY,GAAG,aAAa,GAAG,eAAe,GAAG,aAAa,GAAG,cAAc,GAAG,gBAAgB,EAC7G,MAAM,CASN,CAAC;AAUF,oGAAoG;AACpG,qBAAa,OAAO;IACnB,OAAO,CAAC,MAAM,CAAqB;IAEnC;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,EAAE,IAAI,GAAE,MAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAQ/F;IAED,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAevB;IAED,4CAA4C;IAC5C,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,8GAA8G;IAC9G,KAAK,IAAI,IAAI,CAEZ;CACD"}
+{"version":3,"file":"Tween.d.ts","sourceRoot":"","sources":["../../src/core/Tween.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;AAE3C,0EAA0E;AAC1E,eAAO,MAAM,MAAM,EAAE,MAAM,CAC1B,QAAQ,GAAG,YAAY,GAAG,aAAa,GAAG,eAAe,GAAG,aAAa,GAAG,cAAc,GAAG,gBAAgB,EAC7G,MAAM,CASN,CAAC;AAUF;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,OAAO;IACnB,OAAO,CAAC,MAAM,CAAqB;IAEnC;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,EAAE,IAAI,GAAE,MAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAQ/F;IAED,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAevB;IAED,4CAA4C;IAC5C,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,8GAA8G;IAC9G,KAAK,IAAI,IAAI,CAEZ;CACD"}

package/dist/core/Tween.js

@@ -14,7 +14,22 @@ export const Easing = {
     easeOutCubic: (t) => 1 - (1 - t) ** 3,
     easeInOutCubic: (t) => (t < 0.5 ? 4 * t * t * t : 1 - ((-2 * t + 2) ** 3) / 2),
 };
-/** Runs any number of concurrent tweens; a game or a widget drives it from its own `update(dt)`. */
+/**
+ * Runs any number of concurrent tweens; a game or a widget drives it from its own `update(dt)`.
+ *
+ * @example
+ * ```ts
+ * import { Tweener, Easing } from '@datamoc/mw_games/core';
+ *
+ * const tweener = new Tweener();
+ * const sprite = { alpha: 0 };
+ *
+ * tweener.tween(0.5, (t) => { sprite.alpha = t; }, Easing.easeOutQuad);
+ *
+ * // in the game loop:
+ * tweener.update(1 / 60);
+ * ```
+ */
 export class Tweener {
     constructor() {
         this.tweens = [];

package/dist/core/Tween.js.map

@@ -1 +1 @@
-{"version":3,"file":"Tween.js","sourceRoot":"","sources":["../../src/core/Tween.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,0EAA0E;AAC1E,MAAM,CAAC,MAAM,MAAM,GAGf;IACH,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAChB,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC;IACxB,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAC/B,aAAa,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACzE,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAC7B,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;IACrC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;CAC9E,CAAC;AAUF,oGAAoG;AACpG,MAAM,OAAO,OAAO;IAApB;QACS,WAAM,GAAkB,EAAE,CAAC;IA2CpC,CAAC;IAzCA;;;;OAIG;IACH,KAAK,CAAC,QAAgB,EAAE,KAA0B,EAAE,IAAI,GAAW,MAAM,CAAC,MAAM;QAC/E,IAAI,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,CAAC,CAAC,CAAC;YACT,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC;QACD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,EAAU;QAChB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAErC,iFAAiF;QACjF,+BAA+B;QAC/B,KAAK,MAAM,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC;YACpB,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;YACtD,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAE3B,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACZ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;gBAClD,KAAK,CAAC,OAAO,EAAE,CAAC;YACjB,CAAC;QACF,CAAC;IACF,CAAC;IAED,4CAA4C;IAC5C,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IAC/B,CAAC;IAED,8GAA8G;IAC9G,KAAK;QACJ,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IAClB,CAAC;CACD"}
+{"version":3,"file":"Tween.js","sourceRoot":"","sources":["../../src/core/Tween.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,0EAA0E;AAC1E,MAAM,CAAC,MAAM,MAAM,GAGf;IACH,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAChB,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC;IACxB,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAC/B,aAAa,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACzE,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAC7B,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;IACrC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;CAC9E,CAAC;AAUF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,OAAO;IAApB;QACS,WAAM,GAAkB,EAAE,CAAC;IA2CpC,CAAC;IAzCA;;;;OAIG;IACH,KAAK,CAAC,QAAgB,EAAE,KAA0B,EAAE,IAAI,GAAW,MAAM,CAAC,MAAM;QAC/E,IAAI,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,CAAC,CAAC,CAAC;YACT,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC;QACD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,EAAU;QAChB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAErC,iFAAiF;QACjF,+BAA+B;QAC/B,KAAK,MAAM,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC;YACpB,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;YACtD,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAE3B,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACZ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;gBAClD,KAAK,CAAC,OAAO,EAAE,CAAC;YACjB,CAAC;QACF,CAAC;IACF,CAAC;IAED,4CAA4C;IAC5C,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IAC/B,CAAC;IAED,8GAA8G;IAC9G,KAAK;QACJ,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IAClB,CAAC;CACD"}

package/dist/core/UndoHistory.d.ts

@@ -7,6 +7,21 @@
  *
  * Distinct from `Recorder`/`Player` (item 42), which replay a whole `Input.onAction` log
  * deterministically for testing, not a bounded, player-facing "undo my last move".
+ *
+ * @example
+ * ```ts
+ * import { UndoHistory } from '@datamoc/mw_games/core';
+ *
+ * interface TurnState { x: number; y: number }
+ *
+ * const history = new UndoHistory<TurnState>({ limit: 20 });
+ * history.push({ x: 0, y: 0 });
+ * history.push({ x: 1, y: 0 });
+ *
+ * if (history.canUndo) {
+ *   const previous = history.undo();
+ * }
+ * ```
  */
 export interface UndoHistoryOptions {
     /** states retained before the oldest is dropped; defaults to 50 */