like2d 2.11.0 → 2.11.1

package/dist/graphics/image.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../src/graphics/image.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC;;;;;;;;GAQG;AACH,qBAAa,WAAW;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,OAAO,CAAiC;IAChD,OAAO,CAAC,WAAW,CAAgB;IACnC,OAAO,CAAC,QAAQ,CAAS;gBAEb,IAAI,EAAE,MAAM;IAiBxB,OAAO,IAAI,OAAO;IAIlB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,IAAI,IAAI,IAAI,OAAO,CAElB;IAED,UAAU,IAAI,gBAAgB,GAAG,IAAI;CAGtC"}

package/dist/graphics/image.js

@@ -0,0 +1,62 @@
+/**
+ * An image that can be drawn using {@link Graphics.draw}
+ *
+ * Unlike raw HTMLImageElement, there is no need to wait for it to load.
+ * If the image isn't loaded, it simply won't draw it at all.
+ *
+ * If you're planning on loading many large images, simply preload
+ * these image handles beforehand so that they're ready.
+ */
+export class ImageHandle {
+    constructor(path) {
+        Object.defineProperty(this, "path", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "element", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: null
+        });
+        Object.defineProperty(this, "loadPromise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "isLoaded", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        this.path = path;
+        this.loadPromise = new Promise((resolve, reject) => {
+            const img = new Image();
+            img.onload = () => {
+                this.element = img;
+                this.isLoaded = true;
+                resolve();
+            };
+            img.onerror = () => {
+                reject(new Error(`Failed to load image: ${path}`));
+            };
+            img.src = path;
+        });
+    }
+    isReady() {
+        return this.isLoaded;
+    }
+    ready() {
+        return this.loadPromise;
+    }
+    get size() {
+        return [this.element?.width ?? 0, this.element?.height ?? 0];
+    }
+    getElement() {
+        return this.element;
+    }
+}

package/dist/graphics/index.d.ts

@@ -1,8 +1,10 @@
 /**
+ * Where we draw with {@link Graphics} on to the {@link Canvas}.
  * @module graphics
- * @description a reduced-state, Love2D-like wrapper around browser canvas
  */
-export type { Color, DrawMode, ShapeProps, DrawProps, PrintProps, ImageHandle, } from "./graphics";
-export { Graphics } from "./graphics";
-export type { CanvasModeOptions, CanvasSize, Canvas, } from "./canvas";
+export type { Graphics } from "./graphics";
+export type { Canvas } from "./canvas";
+export type { ImageHandle } from './image';
+export type { Color, DrawMode, ShapeProps, DrawProps, PrintProps, } from "./graphics";
+export type { CanvasSize, CanvasModeOptions, } from "./canvas";
 //# sourceMappingURL=index.d.ts.map

package/dist/graphics/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/graphics/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACV,KAAK,EACL,QAAQ,EACR,UAAU,EACV,SAAS,EACT,UAAU,EACV,WAAW,GACZ,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,YAAY,EACV,iBAAiB,EACjB,UAAU,EACV,MAAM,GACP,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/graphics/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,YAAY,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,YAAY,EACV,WAAW,EACZ,MAAM,SAAS,CAAC;AAEjB,YAAY,EACV,KAAK,EACL,QAAQ,EACR,UAAU,EACV,SAAS,EACT,UAAU,GACX,MAAM,YAAY,CAAC;AAEpB,YAAY,EACV,UAAU,EACV,iBAAiB,GAClB,MAAM,UAAU,CAAC"}

package/dist/graphics/index.js

@@ -1,5 +1,5 @@
 /**
+ * Where we draw with {@link Graphics} on to the {@link Canvas}.
  * @module graphics
- * @description a reduced-state, Love2D-like wrapper around browser canvas
  */
-export { Graphics } from "./graphics";
+export {};

package/dist/index.d.ts

@@ -1,10 +1,12 @@
 /**
- * @module like2d
- * @description A cozy web-native 2D game framework.
+ * A cozy web-native 2D game framework.
+ *
  */
 import type { Like } from './like';
-export type { Like, TopLevelEventHandler } from './like';
-export type { LikeEvent, EventType, EventMap } from './events';
+export type { Like, TopLevelEventHandler, Callbacks, Callback } from './like';
+export type { LikeEvent, EventType, EventMap, LikeCanvasElement, Dispatcher, LikeCanvasEventMap, LikeKeyboardEvent } from './events';
+export type { Scene } from './scene';
+export type { EngineProps } from './engine';
 /**
  * Create a new Like2D game instance attached to a DOM container.
  *

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,YAAY,EAAE,IAAI,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AACzD,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAE/D;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI,CAGvD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAYH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,YAAY,EAAE,IAAI,EAAE,oBAAoB,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAC9E,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACrI,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,YAAY,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE5C;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI,CAGvD"}

package/dist/index.js

@@ -1,6 +1,13 @@
 /**
- * @module like2d
- * @description A cozy web-native 2D game framework.
+ * A cozy web-native 2D game framework.
+ *
+ */
+/**
+ * Here are the top-level events, modules, and the scene system.
+ *
+ * See {@link createLike} to get started.
+ *
+ * @module like
  */
 import { Engine } from './engine';
 /**

package/dist/input/gamepad-mapping.d.ts

@@ -1,12 +1,9 @@
 /**
- * @module GamepadMapping
- *
  * A database, generated on module load,
  * which uses SDL's database to coerce
  * browser APIs into physical gamepad button
  * mappings.
  *
- *
  * Browser API shortcomings:
  *  - [No standard way of exposing vendor/product, Safari doesn't even do it.](https://github.com/w3c/gamepad/issues/199)
  *  - Vendor and product alone doesn't suffice for GUID -- Different controllers have the same, it's good-enough.
@@ -19,13 +16,14 @@
  */
 import type { Vector2 } from "../math";
 /**
+ * @private
  * ref: https://www.w3.org/TR/gamepad/#dfn-standard-gamepad
  * note: `num` is only the corresponding number on standard mapping above.
  *
  * The point of the mapping system is to apply that _or_ non-standard mappings,
  * Which are exceedingly common.
  */
-declare const buttonMap: readonly [{
+export declare const buttonMap: readonly [{
     readonly like: "BBottom";
     readonly num: number;
     readonly name: "Bottom Face Button";
@@ -101,8 +99,10 @@ export type StickAxisMapping = {
     index: number;
     invert: boolean;
 };
+/** @private Get an empty mapping for a gamepad. Good for binding from scratch. */
 export declare const defaultMapping: (stickCount: number) => GamepadMapping;
 export declare const standardButtonMapping: () => ButtonMapping;
+/** @private */
 export declare const allButtons: Set<string>;
 export declare const fullButtonName: Map<"BBottom" | "BRight" | "BLeft" | "BTop" | "L1" | "R1" | "L2" | "R2" | "MenuLeft" | "MenuRight" | "LeftStick" | "RightStick" | "Up" | "Down" | "Left" | "Right", "Bottom Face Button" | "Right Face Button" | "Left Face Button" | "Top Face Button" | "Left shoulder (front)" | "Right shoulder (front)" | "Left shoulder (rear)" | "Right shoulder (rear)" | "Left Menu Button" | "Right Menu Button" | "Left Stick Button" | "Right Stick Button" | "D-Pad Up" | "D-Pad Down" | "D-Pad Left" | "D-Pad right">;
 export declare const mapStick: (gp: Gamepad, mapping: StickMapping) => Vector2;

package/dist/input/gamepad-mapping.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gamepad-mapping.d.ts","sourceRoot":"","sources":["../../src/input/gamepad-mapping.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEvC;;;;;;GAMG;AACH,QAAA,MAAM,SAAS;;kBACgB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoB3B,CAAC;AAUX,MAAM,MAAM,UAAU,GAClB,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAClC,SAAS,MAAM,EAAE,GACjB,OAAO,MAAM,GAAG,GAChB,OAAO,MAAM,GAAG,CAAC;AAIrB,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,aAAa,CAAC;IACvB,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AACvD,MAAM,MAAM,YAAY,GAAG,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;AAChE,MAAM,MAAM,gBAAgB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC;AAElE,eAAO,MAAM,cAAc,GAAI,YAAY,MAAM,KAAG,cAQlD,CAAC;AAEH,eAAO,MAAM,qBAAqB,QAAO,aAC0B,CAAC;AACpE,eAAO,MAAM,UAAU,aAAqD,CAAC;AAC7E,eAAO,MAAM,cAAc,qfAE1B,CAAC;AAEF,eAAO,MAAM,QAAQ,GAAI,IAAI,OAAO,EAAE,SAAS,YAAY,KAAG,OAK7D,CAAC;AAkBF,KAAK,UAAU,GAAG;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,CAwBtE"}
+{"version":3,"file":"gamepad-mapping.d.ts","sourceRoot":"","sources":["../../src/input/gamepad-mapping.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEvC;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS;;kBACS,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoB3B,CAAC;AAUX,MAAM,MAAM,UAAU,GAClB,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAClC,SAAS,MAAM,EAAE,GACjB,OAAO,MAAM,GAAG,GAChB,OAAO,MAAM,GAAG,CAAC;AAIrB,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,aAAa,CAAC;IACvB,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AACvD,MAAM,MAAM,YAAY,GAAG,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;AAChE,MAAM,MAAM,gBAAgB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC;AAElE,kFAAkF;AAClF,eAAO,MAAM,cAAc,GAAI,YAAY,MAAM,KAAG,cAQlD,CAAC;AAEH,eAAO,MAAM,qBAAqB,QAAO,aAC0B,CAAC;AACpE,eAAe;AACf,eAAO,MAAM,UAAU,aAAqD,CAAC;AAC7E,eAAO,MAAM,cAAc,qfAE1B,CAAC;AAEF,eAAO,MAAM,QAAQ,GAAI,IAAI,OAAO,EAAE,SAAS,YAAY,KAAG,OAK7D,CAAC;AAkBF,KAAK,UAAU,GAAG;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,CAwBtE"}

package/dist/input/gamepad-mapping.js

@@ -1,12 +1,9 @@
 /**
- * @module GamepadMapping
- *
  * A database, generated on module load,
  * which uses SDL's database to coerce
  * browser APIs into physical gamepad button
  * mappings.
  *
- *
  * Browser API shortcomings:
  *  - [No standard way of exposing vendor/product, Safari doesn't even do it.](https://github.com/w3c/gamepad/issues/199)
  *  - Vendor and product alone doesn't suffice for GUID -- Different controllers have the same, it's good-enough.
@@ -18,13 +15,14 @@
  *  - We go with best-match and always fall back on manual mapping.
  */
 /**
+ * @private
  * ref: https://www.w3.org/TR/gamepad/#dfn-standard-gamepad
  * note: `num` is only the corresponding number on standard mapping above.
  *
  * The point of the mapping system is to apply that _or_ non-standard mappings,
  * Which are exceedingly common.
  */
-const buttonMap = [
+export const buttonMap = [
     { like: "BBottom", num: 0, name: "Bottom Face Button" },
     { like: "BRight", num: 1, name: "Right Face Button" },
     { like: "BLeft", num: 2, name: "Left Face Button" },
@@ -49,6 +47,7 @@ const detectedOs = ((s) => [
     ["Win", "Windows"],
     ["Mac", "Mac OS X"],
 ].find(([ss]) => s.includes(ss))?.[1] ?? "Linux")(navigator.userAgent);
+/** @private Get an empty mapping for a gamepad. Good for binding from scratch. */
 export const defaultMapping = (stickCount) => ({
     buttons: {},
     sticks: Array(stickCount)
@@ -59,6 +58,7 @@ export const defaultMapping = (stickCount) => ({
     ]),
 });
 export const standardButtonMapping = () => Object.fromEntries(buttonMap.map(({ like, num }) => [num, like]));
+/** @private */
 export const allButtons = new Set(buttonMap.map(({ like }) => like));
 export const fullButtonName = new Map(buttonMap.map(({ like, name }) => [like, name]));
 export const mapStick = (gp, mapping) => {

package/dist/input/gamepad.d.ts

@@ -12,8 +12,18 @@ export type GamepadTarget = number | "any";
  *
  * If you're planning on supporting gamepads, please include a
  * way to generate {@link GamepadMapping} and set it with {@link Gamepad.setMapping}.
+ * Perhaps trigger it on {@link index.EventMap.gamepadconnected} events.
+ *
+ * If you don't want to make your own, take a look at {@link prefab-scenes.MapGamepad}
+ *
+ * ## When to use gamepad remapping
+ *
+ * For games with heavy and varied gamepad use, mapping buttons is essential.
+ *
+ * But if your game relies on a small set of logical actions like 'accept' or 'jump', don't hesitate to
+ * reach for {@link input} in order to map based on actions instead.
+ *
  *
- * If you don't want to make your own, take a look at `prefab-scenes/mapGamepad`.
  */
 export declare class Gamepad {
     private dispatch;

package/dist/input/gamepad.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gamepad.d.ts","sourceRoot":"","sources":["../../src/input/gamepad.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkC,cAAc,EAAiB,UAAU,EAAmC,MAAM,mBAAmB,CAAC;AAC/I,OAAO,EAAmB,KAAK,gBAAgB,EAAE,MAAM,WAAW,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,gCAAgC;AAChC,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,KAAK,CAAC;AAE3C;;;;;;;;;;GAUG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAA+B;IAC/C,OAAO,CAAC,QAAQ,CAAoC;IACpD,OAAO,CAAC,eAAe,CAAQ;gBAEnB,KAAK,EAAE,WAAW,CAAC,gBAAgB,CAAC;IAmChD,OAAO,CAAC,kBAAkB;IAgC1B;;OAEG;IACH,OAAO,CAAC,MAAM;IAId;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE;IAQpC,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAIxC,OAAO,CAAC,WAAW;IAYnB,yCAAyC;IACzC,MAAM,CACJ,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,UAAU,GAAG,MAAM,GAC1B,OAAO,GAAG,SAAS;IAItB;;;OAGG;IACH,WAAW,CACT,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,UAAU,GAAG,MAAM,GAC1B,OAAO,GAAG,SAAS;IAItB;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAIrD;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,UAAO;IAU9D;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAYtD;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc;IASlD;;;;;;;OAOG;IACH,qBAAqB,CAAC,MAAM,EAAE,OAAO;CAGtC"}
+{"version":3,"file":"gamepad.d.ts","sourceRoot":"","sources":["../../src/input/gamepad.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkC,cAAc,EAAiB,UAAU,EAAmC,MAAM,mBAAmB,CAAC;AAC/I,OAAO,EAAmB,KAAK,gBAAgB,EAAE,MAAM,WAAW,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,gCAAgC;AAChC,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,KAAK,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAA+B;IAC/C,OAAO,CAAC,QAAQ,CAAoC;IACpD,OAAO,CAAC,eAAe,CAAQ;gBAEnB,KAAK,EAAE,WAAW,CAAC,gBAAgB,CAAC;IAmChD,OAAO,CAAC,kBAAkB;IAgC1B;;OAEG;IACH,OAAO,CAAC,MAAM;IAId;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE;IAQpC,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAIxC,OAAO,CAAC,WAAW;IAYnB,yCAAyC;IACzC,MAAM,CACJ,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,UAAU,GAAG,MAAM,GAC1B,OAAO,GAAG,SAAS;IAItB;;;OAGG;IACH,WAAW,CACT,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,UAAU,GAAG,MAAM,GAC1B,OAAO,GAAG,SAAS;IAItB;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAIrD;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,UAAO;IAU9D;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAYtD;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc;IASlD;;;;;;;OAOG;IACH,qBAAqB,CAAC,MAAM,EAAE,OAAO;CAGtC"}

package/dist/input/gamepad.js

@@ -7,8 +7,18 @@ import { defaultMapping, fullButtonName, getSdlMapping, mapStick, standardButton
  *
  * If you're planning on supporting gamepads, please include a
  * way to generate {@link GamepadMapping} and set it with {@link Gamepad.setMapping}.
+ * Perhaps trigger it on {@link index.EventMap.gamepadconnected} events.
+ *
+ * If you don't want to make your own, take a look at {@link prefab-scenes.MapGamepad}
+ *
+ * ## When to use gamepad remapping
+ *
+ * For games with heavy and varied gamepad use, mapping buttons is essential.
+ *
+ * But if your game relies on a small set of logical actions like 'accept' or 'jump', don't hesitate to
+ * reach for {@link input} in order to map based on actions instead.
+ *
  *
- * If you don't want to make your own, take a look at `prefab-scenes/mapGamepad`.
  */
 export class Gamepad {
     constructor(props) {

package/dist/input/index.d.ts

@@ -1,6 +1,14 @@
-export type { Input, InputType, InputBinding, } from "./input";
-export type { GamepadTarget, Gamepad, } from "./gamepad";
-export type { LikeButton, GamepadMapping, StickMapping, StickAxisMapping, } from "./gamepad-mapping";
-export { defaultMapping, allButtons } from "./gamepad-mapping";
-export type { MouseSetMode, Mouse, } from "./mouse";
+/**
+ * Where {@link Keyboard}, {@link Mouse}, {@link Gamepad}, and actions in {@link Input} reside.
+ * @module input
+*/
+export type { Keyboard } from "./keyboard";
+export type { Mouse } from "./mouse";
+export type { Gamepad } from "./gamepad";
+export type { Input } from "./input";
+export type { MouseSetMode, MouseMode, MouseButton, } from "./mouse";
+export type { GamepadTarget, } from "./gamepad";
+export type { LikeButton, GamepadMapping, ButtonMapping, StickMapping, StickAxisMapping, } from "./gamepad-mapping";
+export type { InputType, InputBinding, } from "./input";
+export { defaultMapping, allButtons, buttonMap } from "./gamepad-mapping";
 //# sourceMappingURL=index.d.ts.map

package/dist/input/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/input/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,KAAK,EACL,SAAS,EACT,YAAY,GACb,MAAM,SAAS,CAAC;AAEjB,YAAY,EACV,aAAa,EACb,OAAO,GACR,MAAM,WAAW,CAAA;AAElB,YAAY,EACV,UAAU,EACV,cAAc,EACd,YAAY,EACZ,gBAAgB,GACjB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/D,YAAY,EACV,YAAY,EACZ,KAAK,GACN,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/input/index.ts"],"names":[],"mappings":"AAAA;;;EAGE;AAEF,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,YAAY,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,YAAY,EACV,YAAY,EACZ,SAAS,EACT,WAAW,GACZ,MAAM,SAAS,CAAC;AAEjB,YAAY,EACV,aAAa,GACd,MAAM,WAAW,CAAA;AAElB,YAAY,EACV,UAAU,EACV,cAAc,EACd,aAAa,EACb,YAAY,EACZ,gBAAgB,GACjB,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EACV,SAAS,EACT,YAAY,GACb,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/input/index.js

@@ -1 +1,5 @@
-export { defaultMapping, allButtons } from "./gamepad-mapping";
+/**
+ * Where {@link Keyboard}, {@link Mouse}, {@link Gamepad}, and actions in {@link Input} reside.
+ * @module input
+*/
+export { defaultMapping, allButtons, buttonMap } from "./gamepad-mapping";

package/dist/input/input.d.ts

@@ -1,8 +1,9 @@
 import type { Keyboard } from './keyboard';
-import type { Mouse } from './mouse';
+import type { Mouse, MouseButton } from './mouse';
 import { Gamepad, GamepadTarget } from './gamepad';
 import { LikeButton } from './gamepad-mapping';
-import { MouseButton, Dispatcher } from '../events';
+import { LikeActionEvent } from '../events';
+import { EngineProps } from '../engine';
 export type InputType = InputBinding['type'];
 export type InputBinding = {
     type: 'keyboard';
@@ -15,15 +16,64 @@ export type InputBinding = {
     gamepad: GamepadTarget;
     button: LikeButton;
 };
+/**
+ * Used to map inputs (from keyboard, mouse, or gamepad) into actions.
+ *
+ * {@link setAction} allows for set-and-forget mappings. Good for one-off games.
+ *
+ * Example:
+ * ```js
+ * // bind action jump
+ * like.load() {
+ *   like.input.setAction('jump', ['KeyX', 'Space', 'ButtonBottom'])
+ * }
+ *
+ * like.actionpressed(action) {
+ *   if (action == 'jump') {
+ *     player.tryJumping();
+ *   }
+ * }
+ * ```
+ *
+ * For more sophisticated games, see also:
+ *  - {@link appendToAction}
+ *  - {@link getActionMapping}
+ *
+ * These allow for programmatic binding based on events. For example:
+ * ```js
+ * let currentlyMapping = 'jump';
+ *
+ * // Watch for gamepad and keyboard events
+ * like.keypressed = (code) => {
+ *   if (currentlyMapping) {
+ *     like.input.appendToAction(currentlyMapping, code);
+ *   }
+ * }
+ * like.gamepadpressed = (name) => {
+ *   if (currentlyMapping) {
+ *     like.input.appendToAction(currentlyMapping, name);
+ *   }
+ * }
+ *
+ * // Print some info about the current mapping
+ * like.draw = () => {
+ *   if (currentlyMapping) {
+ *     myGame.statusLine =
+ *       `Mapped ${like.input.getActionMapping(currentlyMapping)} to ${currentlyMapping}`
+ *   }
+ * }
+ *
+ * ```
+*/
 export declare class Input {
-    private dispatch;
     private currState;
     private prevState;
     private actionTable;
     private keyboard;
     private mouse;
     private gamepad;
-    constructor(dispatch: Dispatcher<'actionpressed' | 'actionreleased'>, deps: {
+    private dispatch;
+    constructor(props: EngineProps<LikeActionEvent>, deps: {
         keyboard: Keyboard;
         mouse: Mouse;
         gamepad: Gamepad;
@@ -42,6 +92,7 @@ export declare class Input {
      *    - Numeric: `Digit0`, `Digit1`, ...
      *    - `ArrowLeft`, `ArrowRight`, `ArrowUp`, `ArrowDown`
      *    - `ShiftLeft`, `ShiftRight`
+     *    - `Space`
      *    - `Minus`
      *    - `Equal` (also has a plus sign)
      *    - `BracketLeft` and `BracketRight`
@@ -70,7 +121,7 @@ export declare class Input {
     isDown(action: string): boolean;
     justPressed(action: string): boolean;
     justReleased(action: string): boolean;
-    update(): void;
+    private update;
     private isBindingActive;
 }
 //# sourceMappingURL=input.d.ts.map

package/dist/input/input.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../src/input/input.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAc,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEpD,MAAM,MAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;AAC7C,MAAM,MAAM,YAAY,GACpB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GACtC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,WAAW,CAAA;CAAE,GACtC;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,aAAa,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,CAAC;AAEpE,qBAAa,KAAK;IASd,OAAO,CAAC,QAAQ;IARlB,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,WAAW,CAAsC;IACzD,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,KAAK,CAAQ;IACrB,OAAO,CAAC,OAAO,CAAU;gBAGf,QAAQ,EAAE,UAAU,CAAC,eAAe,GAAG,gBAAgB,CAAC,EAChE,IAAI,EAAE;QACJ,QAAQ,EAAE,QAAQ,CAAC;QACnB,KAAK,EAAE,KAAK,CAAC;QACb,OAAO,EAAE,OAAO,CAAC;KAClB;IAOH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,CAAC,MAAM,GAAG,YAAY,CAAC,EAAO,GAAG,IAAI;IAUvE;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,MAAM;IAM3D;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,EAAE;IAIhD,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAM/B,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAIpC,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAIrC,MAAM;IAgBN,OAAO,CAAC,eAAe;CAaxB"}
+{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../src/input/input.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAc,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAc,eAAe,EAAE,MAAM,WAAW,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,MAAM,MAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;AAC7C,MAAM,MAAM,YAAY,GACpB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GACtC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,WAAW,CAAA;CAAE,GACtC;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,aAAa,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgDE;AACF,qBAAa,KAAK;IAChB,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,WAAW,CAAsC;IACzD,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,KAAK,CAAQ;IACrB,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,QAAQ,CAA6B;gBAG3C,KAAK,EAAE,WAAW,CAAC,eAAe,CAAC,EACnC,IAAI,EAAE;QACJ,QAAQ,EAAE,QAAQ,CAAC;QACnB,KAAK,EAAE,KAAK,CAAC;QACb,OAAO,EAAE,OAAO,CAAC;KAClB;IAYH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,CAAC,MAAM,GAAG,YAAY,CAAC,EAAO,GAAG,IAAI;IAUvE;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,MAAM;IAM3D;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,EAAE;IAIhD,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAM/B,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAIpC,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAIrC,OAAO,CAAC,MAAM;IAgBd,OAAO,CAAC,eAAe;CAaxB"}

package/dist/input/input.js

@@ -1,12 +1,55 @@
 import { allButtons } from './gamepad-mapping';
+/**
+ * Used to map inputs (from keyboard, mouse, or gamepad) into actions.
+ *
+ * {@link setAction} allows for set-and-forget mappings. Good for one-off games.
+ *
+ * Example:
+ * ```js
+ * // bind action jump
+ * like.load() {
+ *   like.input.setAction('jump', ['KeyX', 'Space', 'ButtonBottom'])
+ * }
+ *
+ * like.actionpressed(action) {
+ *   if (action == 'jump') {
+ *     player.tryJumping();
+ *   }
+ * }
+ * ```
+ *
+ * For more sophisticated games, see also:
+ *  - {@link appendToAction}
+ *  - {@link getActionMapping}
+ *
+ * These allow for programmatic binding based on events. For example:
+ * ```js
+ * let currentlyMapping = 'jump';
+ *
+ * // Watch for gamepad and keyboard events
+ * like.keypressed = (code) => {
+ *   if (currentlyMapping) {
+ *     like.input.appendToAction(currentlyMapping, code);
+ *   }
+ * }
+ * like.gamepadpressed = (name) => {
+ *   if (currentlyMapping) {
+ *     like.input.appendToAction(currentlyMapping, name);
+ *   }
+ * }
+ *
+ * // Print some info about the current mapping
+ * like.draw = () => {
+ *   if (currentlyMapping) {
+ *     myGame.statusLine =
+ *       `Mapped ${like.input.getActionMapping(currentlyMapping)} to ${currentlyMapping}`
+ *   }
+ * }
+ *
+ * ```
+*/
 export class Input {
-    constructor(dispatch, deps) {
-        Object.defineProperty(this, "dispatch", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: dispatch
-        });
+    constructor(props, deps) {
         Object.defineProperty(this, "currState", {
             enumerable: true,
             configurable: true,
@@ -43,9 +86,19 @@ export class Input {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "dispatch", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.keyboard = deps.keyboard;
         this.mouse = deps.mouse;
         this.gamepad = deps.gamepad;
+        this.dispatch = props.dispatch;
+        props.canvas.addEventListener("like:update", () => this.update(), {
+            signal: props.abort,
+        });
     }
     /**
      * This is the easiest way to set-and-forget input => action mapping.
@@ -61,6 +114,7 @@ export class Input {
      *    - Numeric: `Digit0`, `Digit1`, ...
      *    - `ArrowLeft`, `ArrowRight`, `ArrowUp`, `ArrowDown`
      *    - `ShiftLeft`, `ShiftRight`
+     *    - `Space`
      *    - `Minus`
      *    - `Equal` (also has a plus sign)
      *    - `BracketLeft` and `BracketRight`

package/dist/input/keyboard.d.ts

@@ -1,15 +1,38 @@
 import { EngineProps } from "../engine";
-type KEvent = 'keypressed' | 'keyreleased';
+import { type LikeKeyboardEvent } from "../events";
+/**
+ * A basic wrapper around keyboard.
+ *
+ * Keyboard uses scancodes by default, which are based on physical key
+ * positions rather than the logical (letter) meaning of the key.
+ *
+ * ## When to use Keyboard
+ *
+ * Using keyboard directly is discouraged, but of course allowed.
+ * Take a look at the actions system in {@link input} for a better solution.
+ *
+ * Also where there's text input such as `enter your name`, use the key code.
+ * This allows the user to use their intended keyboard layout.
+ *
+ * ```
+ * like.keypressed = (_code, key) => {
+ *   name += key;
+ * }
+ * ```
+ *
+ * Even if your game is heavily keyboard-reliant (like nethack), it is best to avoid mapping directly.
+ * Referring to action `drink` instead of code `KeyD` is also more programmer-ergonomic.
+ *
+ */
 export declare class Keyboard {
     private pressedScancodes;
     private canvas;
     private dispatch;
-    constructor(props: EngineProps<KEvent>);
+    constructor(props: EngineProps<LikeKeyboardEvent>);
     private handleKeyDown;
     private handleKeyUp;
     private handleBlur;
     isDown(scancode: string): boolean;
     isAnyDown(...scancodes: string[]): boolean;
 }
-export {};
 //# sourceMappingURL=keyboard.d.ts.map

package/dist/input/keyboard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"keyboard.d.ts","sourceRoot":"","sources":["../../src/input/keyboard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAGxC,KAAK,MAAM,GAAG,YAAY,GAAG,aAAa,CAAC;AAE3C,qBAAa,QAAQ;IACnB,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,MAAM,CAAoB;IAClC,OAAO,CAAC,QAAQ,CAAqB;gBAEzB,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC;IAUtC,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,UAAU;IAIlB,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAIjC,SAAS,CAAC,GAAG,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO;CAG3C"}
+{"version":3,"file":"keyboard.d.ts","sourceRoot":"","sources":["../../src/input/keyboard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAsC,KAAK,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAGvF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,MAAM,CAAoB;IAClC,OAAO,CAAC,QAAQ,CAAgC;gBAEpC,KAAK,EAAE,WAAW,CAAC,iBAAiB,CAAC;IAUjD,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,UAAU;IAIlB,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAIjC,SAAS,CAAC,GAAG,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO;CAG3C"}

package/dist/input/keyboard.js

@@ -1,3 +1,27 @@
+/**
+ * A basic wrapper around keyboard.
+ *
+ * Keyboard uses scancodes by default, which are based on physical key
+ * positions rather than the logical (letter) meaning of the key.
+ *
+ * ## When to use Keyboard
+ *
+ * Using keyboard directly is discouraged, but of course allowed.
+ * Take a look at the actions system in {@link input} for a better solution.
+ *
+ * Also where there's text input such as `enter your name`, use the key code.
+ * This allows the user to use their intended keyboard layout.
+ *
+ * ```
+ * like.keypressed = (_code, key) => {
+ *   name += key;
+ * }
+ * ```
+ *
+ * Even if your game is heavily keyboard-reliant (like nethack), it is best to avoid mapping directly.
+ * Referring to action `drink` instead of code `KeyD` is also more programmer-ergonomic.
+ *
+ */
 export class Keyboard {
     constructor(props) {
         Object.defineProperty(this, "pressedScancodes", {