@dryanovski/gamefoo 0.0.1 → 0.2.1

package/dist/core/fonts/internal/font_3x5.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Built-in 3x5 pixel bitmap font.
+ *
+ * Each character is a 3-pixel-wide, 5-pixel-tall glyph stored as an
+ * array of 5 integers. Each integer is a bitmask where bit 2
+ * (MSB) corresponds to the leftmost pixel and bit 0 to the rightmost.
+ *
+ * Ultra-compact, great for HUDs and tiny labels.
+ *
+ * Supported characters: uppercase A–Z, lowercase a–z, digits 0–9,
+ * and common punctuation / special characters.
+ *
+ * @category Fonts
+ * @since 0.2.0
+ * @internal
+ *
+ * @example Reading a glyph
+ * ```ts
+ * import FONT_3x5 from "./font_3x5";
+ *
+ * const letterA = FONT_3x5["A"];
+ * // 2, 5, 7, 5, 5
+ * ```
+ */
+/** Catalogue name used by {@link FontBitmap} to look up this font. */
+export declare const FONT_3x5_NAME = "3x5";
+/**
+ * Glyph width in pixels (excluding spacing).
+ * @defaultValue `3`
+ */
+export declare const FONT_3x5_WIDTH = 3;
+/**
+ * Glyph height in pixels.
+ * @defaultValue `5`
+ */
+export declare const FONT_3x5_HEIGHT = 5;
+/**
+ * Horizontal spacing between glyphs in pixels.
+ * @defaultValue `1`
+ */
+export declare const FONT_3x5_SPACING = 1;
+/**
+ * Complete set of supported characters as a single string.
+ */
+export declare const FONT_3x5_CHARS = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz !?.,:;-+*/\\()[]<>=#%&@^_'\"`~|$";
+/**
+ * Glyph data keyed by character.
+ *
+ * Each value is a 5-element `number[]` where each entry is a 3-bit
+ * row bitmask (bit 2 = leftmost pixel, bit 0 = rightmost pixel).
+ *
+ * @see {@link FontBitmap} — consumes this data for rendering
+ */
+export declare const FONT_3x5: Record<string, number[]>;
+/**
+ * Complete metadata object for the 3x5 font, used by the
+ * {@link FontBitmap} catalogue at module load time.
+ *
+ * @internal
+ */
+export declare const metadata: {
+    /** Catalogue name. */
+    name: string;
+    /** Cell width including spacing (3 + 1 = 4). */
+    width: number;
+    /** Cell height (5). */
+    height: number;
+    /** Inter-glyph spacing (1). */
+    spacing: number;
+    /** Supported character string. */
+    chars: string;
+    /** Glyph bitmask data. */
+    data: Record<string, number[]>;
+};
+export default FONT_3x5;
+//# sourceMappingURL=font_3x5.d.ts.map

package/dist/core/fonts/internal/font_3x5.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"font_3x5.d.ts","sourceRoot":"","sources":["../../../../src/core/fonts/internal/font_3x5.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,sEAAsE;AACtE,eAAO,MAAM,aAAa,QAAQ,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC;;;GAGG;AACH,eAAO,MAAM,eAAe,IAAI,CAAC;AAEjC;;;GAGG;AACH,eAAO,MAAM,gBAAgB,IAAI,CAAC;AAElC;;GAEG;AACH,eAAO,MAAM,cAAc,oGACwE,CAAC;AAEpG;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CA8F7C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ;IACnB,sBAAsB;;IAEtB,gDAAgD;;IAEhD,uBAAuB;;IAEvB,+BAA+B;;IAE/B,kCAAkC;;IAElC,0BAA0B;;CAE3B,CAAC;AAEF,eAAe,QAAQ,CAAC"}

package/dist/core/fonts/internal/font_4x6.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Built-in 4x6 pixel bitmap font.
+ *
+ * Each character is a 4-pixel-wide, 6-pixel-tall glyph stored as an
+ * array of 6 integers. Each integer is a bitmask where bit 3
+ * (MSB) corresponds to the leftmost pixel and bit 0 to the rightmost.
+ *
+ * Small but readable, good for status bars.
+ *
+ * Supported characters: uppercase A–Z, lowercase a–z, digits 0–9,
+ * and common punctuation / special characters.
+ *
+ * @category Fonts
+ * @since 0.2.0
+ * @internal
+ *
+ * @example Reading a glyph
+ * ```ts
+ * import FONT_4x6 from "./font_4x6";
+ *
+ * const letterA = FONT_4x6["A"];
+ * // 6, 9, 9, 15, 9, 9
+ * ```
+ */
+/** Catalogue name used by {@link FontBitmap} to look up this font. */
+export declare const FONT_4x6_NAME = "4x6";
+/**
+ * Glyph width in pixels (excluding spacing).
+ * @defaultValue `4`
+ */
+export declare const FONT_4x6_WIDTH = 4;
+/**
+ * Glyph height in pixels.
+ * @defaultValue `6`
+ */
+export declare const FONT_4x6_HEIGHT = 6;
+/**
+ * Horizontal spacing between glyphs in pixels.
+ * @defaultValue `1`
+ */
+export declare const FONT_4x6_SPACING = 1;
+/**
+ * Complete set of supported characters as a single string.
+ */
+export declare const FONT_4x6_CHARS = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz !?.,:;-+*/\\()[]{}<>=#%&@^_'\"`~|$";
+/**
+ * Glyph data keyed by character.
+ *
+ * Each value is a 6-element `number[]` where each entry is a 4-bit
+ * row bitmask (bit 3 = leftmost pixel, bit 0 = rightmost pixel).
+ *
+ * @see {@link FontBitmap} — consumes this data for rendering
+ */
+export declare const FONT_4x6: Record<string, number[]>;
+/**
+ * Complete metadata object for the 4x6 font, used by the
+ * {@link FontBitmap} catalogue at module load time.
+ *
+ * @internal
+ */
+export declare const metadata: {
+    /** Catalogue name. */
+    name: string;
+    /** Cell width including spacing (4 + 1 = 5). */
+    width: number;
+    /** Cell height (6). */
+    height: number;
+    /** Inter-glyph spacing (1). */
+    spacing: number;
+    /** Supported character string. */
+    chars: string;
+    /** Glyph bitmask data. */
+    data: Record<string, number[]>;
+};
+export default FONT_4x6;
+//# sourceMappingURL=font_4x6.d.ts.map

package/dist/core/fonts/internal/font_4x6.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"font_4x6.d.ts","sourceRoot":"","sources":["../../../../src/core/fonts/internal/font_4x6.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,sEAAsE;AACtE,eAAO,MAAM,aAAa,QAAQ,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC;;;GAGG;AACH,eAAO,MAAM,eAAe,IAAI,CAAC;AAEjC;;;GAGG;AACH,eAAO,MAAM,gBAAgB,IAAI,CAAC;AAElC;;GAEG;AACH,eAAO,MAAM,cAAc,sGAC0E,CAAC;AAEtG;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAgG7C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ;IACnB,sBAAsB;;IAEtB,gDAAgD;;IAEhD,uBAAuB;;IAEvB,+BAA+B;;IAE/B,kCAAkC;;IAElC,0BAA0B;;CAE3B,CAAC;AAEF,eAAe,QAAQ,CAAC"}

package/dist/core/fonts/internal/font_5x5.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Built-in 5x5 pixel bitmap font.
+ *
+ * Each character is a 5-pixel-wide, 5-pixel-tall glyph stored as an
+ * array of five integers. Each integer is a bitmask where bit 4
+ * (MSB) corresponds to the leftmost pixel and bit 0 to the rightmost.
+ *
+ * Supported characters: `A–Z`, `0–9`, and space.
+ *
+ * @category Fonts
+ * @since 0.1.0
+ * @internal
+ *
+ * @example Reading a glyph
+ * ```ts
+ * import FONT_5x5 from "./font_5x5";
+ *
+ * const letterA = FONT_5x5["A"];
+ * // [14, 17, 31, 17, 17]
+ * //
+ * //  .###.   = 0b01110 = 14
+ * //  #...#   = 0b10001 = 17
+ * //  #####   = 0b11111 = 31
+ * //  #...#   = 0b10001 = 17
+ * //  #...#   = 0b10001 = 17
+ * ```
+ */
+/** Catalogue name used by {@link FontBitmap} to look up this font. */
+export declare const FONT_5x5_NAME = "5x5";
+/**
+ * Glyph width in pixels (excluding spacing).
+ * @defaultValue `5`
+ */
+export declare const FONT_5x5_WIDTH = 5;
+/**
+ * Glyph height in pixels.
+ * @defaultValue `5`
+ */
+export declare const FONT_5x5_HEIGHT = 5;
+/**
+ * Horizontal spacing between glyphs in pixels.
+ * @defaultValue `1`
+ */
+export declare const FONT_5x5_SPACING = 1;
+/**
+ * Complete set of supported characters as a single string.
+ */
+export declare const FONT_5x5_CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ 0123456789";
+/**
+ * Glyph data keyed by character.
+ *
+ * Each value is a 5-element `number[]` where each entry is a 5-bit
+ * row bitmask (bit 4 = leftmost pixel, bit 0 = rightmost pixel).
+ *
+ * @see {@link FontBitmap} — consumes this data for rendering
+ */
+export declare const FONT_5x5: Record<string, number[]>;
+/**
+ * Complete metadata object for the 5x5 font, used by the
+ * {@link FontBitmap} catalogue at module load time.
+ *
+ * @internal
+ */
+export declare const metadata: {
+    /** Catalogue name. */
+    name: string;
+    /** Cell width including spacing (5 + 1 = 6). */
+    width: number;
+    /** Cell height (5). */
+    height: number;
+    /** Inter-glyph spacing (1). */
+    spacing: number;
+    /** Supported character string. */
+    chars: string;
+    /** Glyph bitmask data. */
+    data: Record<string, number[]>;
+};
+export default FONT_5x5;
+//# sourceMappingURL=font_5x5.d.ts.map

package/dist/core/fonts/internal/font_5x5.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"font_5x5.d.ts","sourceRoot":"","sources":["../../../../src/core/fonts/internal/font_5x5.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,sEAAsE;AACtE,eAAO,MAAM,aAAa,QAAQ,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC;;;GAGG;AACH,eAAO,MAAM,eAAe,IAAI,CAAC;AAEjC;;;GAGG;AACH,eAAO,MAAM,gBAAgB,IAAI,CAAC;AAElC;;GAEG;AACH,eAAO,MAAM,cAAc,0CAA0C,CAAC;AAEtE;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAmD7C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ;IACnB,sBAAsB;;IAEtB,gDAAgD;;IAEhD,uBAAuB;;IAEvB,+BAA+B;;IAE/B,kCAAkC;;IAElC,0BAA0B;;CAE3B,CAAC;AAEF,eAAe,QAAQ,CAAC"}

package/dist/core/fonts/internal/font_6x8.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Built-in 6x8 pixel bitmap font.
+ *
+ * Each character is a 6-pixel-wide, 8-pixel-tall glyph stored as an
+ * array of 8 integers. Each integer is a bitmask where bit 5
+ * (MSB) corresponds to the leftmost pixel and bit 0 to the rightmost.
+ *
+ * Classic arcade and console aesthetic.
+ *
+ * Supported characters: uppercase A–Z, lowercase a–z, digits 0–9,
+ * and common punctuation / special characters.
+ *
+ * @category Fonts
+ * @since 0.2.0
+ * @internal
+ *
+ * @example Reading a glyph
+ * ```ts
+ * import FONT_6x8 from "./font_6x8";
+ *
+ * const letterA = FONT_6x8["A"];
+ * // 12, 18, 33, 33, 63, 33, 33, 0
+ * ```
+ */
+/** Catalogue name used by {@link FontBitmap} to look up this font. */
+export declare const FONT_6x8_NAME = "6x8";
+/**
+ * Glyph width in pixels (excluding spacing).
+ * @defaultValue `6`
+ */
+export declare const FONT_6x8_WIDTH = 6;
+/**
+ * Glyph height in pixels.
+ * @defaultValue `8`
+ */
+export declare const FONT_6x8_HEIGHT = 8;
+/**
+ * Horizontal spacing between glyphs in pixels.
+ * @defaultValue `1`
+ */
+export declare const FONT_6x8_SPACING = 1;
+/**
+ * Complete set of supported characters as a single string.
+ */
+export declare const FONT_6x8_CHARS = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz !?.,:;-+*/\\()[]{}<>=#%&@^_'\"`~|$";
+/**
+ * Glyph data keyed by character.
+ *
+ * Each value is a 8-element `number[]` where each entry is a 6-bit
+ * row bitmask (bit 5 = leftmost pixel, bit 0 = rightmost pixel).
+ *
+ * @see {@link FontBitmap} — consumes this data for rendering
+ */
+export declare const FONT_6x8: Record<string, number[]>;
+/**
+ * Complete metadata object for the 6x8 font, used by the
+ * {@link FontBitmap} catalogue at module load time.
+ *
+ * @internal
+ */
+export declare const metadata: {
+    /** Catalogue name. */
+    name: string;
+    /** Cell width including spacing (6 + 1 = 7). */
+    width: number;
+    /** Cell height (8). */
+    height: number;
+    /** Inter-glyph spacing (1). */
+    spacing: number;
+    /** Supported character string. */
+    chars: string;
+    /** Glyph bitmask data. */
+    data: Record<string, number[]>;
+};
+export default FONT_6x8;
+//# sourceMappingURL=font_6x8.d.ts.map

package/dist/core/fonts/internal/font_6x8.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"font_6x8.d.ts","sourceRoot":"","sources":["../../../../src/core/fonts/internal/font_6x8.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,sEAAsE;AACtE,eAAO,MAAM,aAAa,QAAQ,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC;;;GAGG;AACH,eAAO,MAAM,eAAe,IAAI,CAAC;AAEjC;;;GAGG;AACH,eAAO,MAAM,gBAAgB,IAAI,CAAC;AAElC;;GAEG;AACH,eAAO,MAAM,cAAc,sGAC0E,CAAC;AAEtG;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAgG7C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ;IACnB,sBAAsB;;IAEtB,gDAAgD;;IAEhD,uBAAuB;;IAEvB,+BAA+B;;IAE/B,kCAAkC;;IAElC,0BAA0B;;CAE3B,CAAC;AAEF,eAAe,QAAQ,CAAC"}

package/dist/core/fonts/internal/font_8x13.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Built-in 8x13 pixel bitmap font.
+ *
+ * Each character is a 8-pixel-wide, 13-pixel-tall glyph stored as an
+ * array of 13 integers. Each integer is a bitmask where bit 7
+ * (MSB) corresponds to the leftmost pixel and bit 0 to the rightmost.
+ *
+ * Tall, elegant glyphs for dialogue boxes and UI.
+ *
+ * Supported characters: uppercase A–Z, lowercase a–z, digits 0–9,
+ * and common punctuation / special characters.
+ *
+ * @category Fonts
+ * @since 0.2.0
+ * @internal
+ *
+ * @example Reading a glyph
+ * ```ts
+ * import FONT_8x13 from "./font_8x13";
+ *
+ * const letterA = FONT_8x13["A"];
+ * // 0, 0, 24, 36, 66, 66, 126, 66, 66, 66, 0, 0, 0
+ * ```
+ */
+/** Catalogue name used by {@link FontBitmap} to look up this font. */
+export declare const FONT_8x13_NAME = "8x13";
+/**
+ * Glyph width in pixels (excluding spacing).
+ * @defaultValue `8`
+ */
+export declare const FONT_8x13_WIDTH = 8;
+/**
+ * Glyph height in pixels.
+ * @defaultValue `13`
+ */
+export declare const FONT_8x13_HEIGHT = 13;
+/**
+ * Horizontal spacing between glyphs in pixels.
+ * @defaultValue `1`
+ */
+export declare const FONT_8x13_SPACING = 1;
+/**
+ * Complete set of supported characters as a single string.
+ */
+export declare const FONT_8x13_CHARS = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz !?.,:;-+*/\\()[]{}<>=#%&@^_'\"`~|$";
+/**
+ * Glyph data keyed by character.
+ *
+ * Each value is a 13-element `number[]` where each entry is a 8-bit
+ * row bitmask (bit 7 = leftmost pixel, bit 0 = rightmost pixel).
+ *
+ * @see {@link FontBitmap} — consumes this data for rendering
+ */
+export declare const FONT_8x13: Record<string, number[]>;
+/**
+ * Complete metadata object for the 8x13 font, used by the
+ * {@link FontBitmap} catalogue at module load time.
+ *
+ * @internal
+ */
+export declare const metadata: {
+    /** Catalogue name. */
+    name: string;
+    /** Cell width including spacing (8 + 1 = 9). */
+    width: number;
+    /** Cell height (13). */
+    height: number;
+    /** Inter-glyph spacing (1). */
+    spacing: number;
+    /** Supported character string. */
+    chars: string;
+    /** Glyph bitmask data. */
+    data: Record<string, number[]>;
+};
+export default FONT_8x13;
+//# sourceMappingURL=font_8x13.d.ts.map

package/dist/core/fonts/internal/font_8x13.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"font_8x13.d.ts","sourceRoot":"","sources":["../../../../src/core/fonts/internal/font_8x13.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,sEAAsE;AACtE,eAAO,MAAM,cAAc,SAAS,CAAC;AAErC;;;GAGG;AACH,eAAO,MAAM,eAAe,IAAI,CAAC;AAEjC;;;GAGG;AACH,eAAO,MAAM,gBAAgB,KAAK,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,eAAe,sGACyE,CAAC;AAEtG;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAgG9C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ;IACnB,sBAAsB;;IAEtB,gDAAgD;;IAEhD,wBAAwB;;IAExB,+BAA+B;;IAE/B,kCAAkC;;IAElC,0BAA0B;;CAE3B,CAAC;AAEF,eAAe,SAAS,CAAC"}

package/dist/core/fonts/internal/font_8x8.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Built-in 8x8 pixel bitmap font.
+ *
+ * Each character is a 8-pixel-wide, 8-pixel-tall glyph stored as an
+ * array of 8 integers. Each integer is a bitmask where bit 7
+ * (MSB) corresponds to the leftmost pixel and bit 0 to the rightmost.
+ *
+ * Chunky square glyphs, ideal at 2× or 4× scale.
+ *
+ * Supported characters: uppercase A–Z, lowercase a–z, digits 0–9,
+ * and common punctuation / special characters.
+ *
+ * @category Fonts
+ * @since 0.2.0
+ * @internal
+ *
+ * @example Reading a glyph
+ * ```ts
+ * import FONT_8x8 from "./font_8x8";
+ *
+ * const letterA = FONT_8x8["A"];
+ * // 24, 36, 66, 66, 126, 66, 66, 0
+ * ```
+ */
+/** Catalogue name used by {@link FontBitmap} to look up this font. */
+export declare const FONT_8x8_NAME = "8x8";
+/**
+ * Glyph width in pixels (excluding spacing).
+ * @defaultValue `8`
+ */
+export declare const FONT_8x8_WIDTH = 8;
+/**
+ * Glyph height in pixels.
+ * @defaultValue `8`
+ */
+export declare const FONT_8x8_HEIGHT = 8;
+/**
+ * Horizontal spacing between glyphs in pixels.
+ * @defaultValue `1`
+ */
+export declare const FONT_8x8_SPACING = 1;
+/**
+ * Complete set of supported characters as a single string.
+ */
+export declare const FONT_8x8_CHARS = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz !?.,:;-+*/\\()[]{}<>=#%&@^_'\"`~|$";
+/**
+ * Glyph data keyed by character.
+ *
+ * Each value is a 8-element `number[]` where each entry is a 8-bit
+ * row bitmask (bit 7 = leftmost pixel, bit 0 = rightmost pixel).
+ *
+ * @see {@link FontBitmap} — consumes this data for rendering
+ */
+export declare const FONT_8x8: Record<string, number[]>;
+/**
+ * Complete metadata object for the 8x8 font, used by the
+ * {@link FontBitmap} catalogue at module load time.
+ *
+ * @internal
+ */
+export declare const metadata: {
+    /** Catalogue name. */
+    name: string;
+    /** Cell width including spacing (8 + 1 = 9). */
+    width: number;
+    /** Cell height (8). */
+    height: number;
+    /** Inter-glyph spacing (1). */
+    spacing: number;
+    /** Supported character string. */
+    chars: string;
+    /** Glyph bitmask data. */
+    data: Record<string, number[]>;
+};
+export default FONT_8x8;
+//# sourceMappingURL=font_8x8.d.ts.map

package/dist/core/fonts/internal/font_8x8.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"font_8x8.d.ts","sourceRoot":"","sources":["../../../../src/core/fonts/internal/font_8x8.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,sEAAsE;AACtE,eAAO,MAAM,aAAa,QAAQ,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC;;;GAGG;AACH,eAAO,MAAM,eAAe,IAAI,CAAC;AAEjC;;;GAGG;AACH,eAAO,MAAM,gBAAgB,IAAI,CAAC;AAElC;;GAEG;AACH,eAAO,MAAM,cAAc,sGAC0E,CAAC;AAEtG;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAgG7C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ;IACnB,sBAAsB;;IAEtB,gDAAgD;;IAEhD,uBAAuB;;IAEvB,+BAA+B;;IAE/B,kCAAkC;;IAElC,0BAA0B;;CAE3B,CAAC;AAEF,eAAe,QAAQ,CAAC"}

package/dist/core/game_object_register.d.ts

@@ -1,11 +1,111 @@
 import type { GameObject } from "../types";
+/**
+ * Central registry that stores and manages all non-player
+ * {@link GameObject | game objects} within the engine.
+ *
+ * Objects are keyed by their `id` property, so each ID must be unique.
+ * The {@link Engine} delegates per-frame `update` and `render` calls to
+ * this register.
+ *
+ * @category Core
+ * @since 0.1.0
+ *
+ * @example Registering and retrieving objects
+ * ```ts
+ * const register = new GameObjectRegister();
+ *
+ * register.register(tree);
+ * register.register(rock);
+ *
+ * const found = register.get("tree"); // Entity | undefined
+ * console.log(register.has("rock"));  // true
+ * ```
+ *
+ * @example Bulk update / render
+ * ```ts
+ * // Called internally by Engine each frame:
+ * register.updateAll(deltaTime);
+ * register.renderAll(ctx);
+ * ```
+ *
+ * @see {@link Engine.attachObjects} — convenience method that delegates here
+ */
 export default class GameObjectRegister {
+    /**
+     * Internal map from entity ID to its {@link GameObject} instance.
+     */
     private objects;
+    private _cache;
+    /**
+     * Adds a game object to the registry.
+     *
+     * If an object with the same `id` already exists it will be
+     * silently overwritten.
+     *
+     * @param object - The game object to register.
+     *
+     * @example
+     * ```ts
+     * register.register(new Crate("crate_1", 200, 150, 32, 32));
+     * ```
+     */
     register(object: GameObject): void;
+    /**
+     * Retrieves a registered object by its unique ID.
+     *
+     * @param id - The ID of the object to find.
+     * @returns The matching {@link GameObject}, or `undefined` if not found.
+     *
+     * @example
+     * ```ts
+     * const crate = register.get("crate_1");
+     * if (crate) crate.x += 10;
+     * ```
+     */
     get(id: string): GameObject | undefined;
+    /**
+     * Checks whether an object with the given ID is registered.
+     *
+     * @param id - The ID to look up.
+     * @returns `true` if the registry contains the object.
+     */
     has(id: string): boolean;
-    getAll(_filter: () => true): GameObject[];
+    /**
+     * Returns all registered objects as an array.
+     *
+     * Make sure to also cache the objects
+     *
+     * @since 0.2.0
+     *
+     * @returns An array of all {@link GameObject} instances in the registry.
+     */
+    toArray(): GameObject[];
+    /**
+     * Returns all registered objects that pass the supplied filter.
+     *
+     * @param filter - (optional) A predicate function. Return `true` to include the
+     *   object in the result.
+     * @returns An array of matching {@link GameObject} instances.
+     *
+     * @example
+     * ```ts
+     * const enemies = register.getAll(() => true);
+     * ```
+     */
+    getAll(filter?: () => true): GameObject[];
+    /**
+     * Calls {@link GameObject.update | update(deltaTime)} on every
+     * registered object.
+     *
+     * @param deltaTime - Seconds elapsed since the previous frame.
+     */
     updateAll(deltaTime: number): void;
+    /**
+     * Calls {@link GameObject.render | render(ctx)} on every registered
+     * object.
+     *
+     * @param ctx - The canvas 2-D rendering context.
+     */
     renderAll(ctx: CanvasRenderingContext2D): void;
 }
 //# sourceMappingURL=game_object_register.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"game_object_register.d.ts","sourceRoot":"","sources":["../../core/game_object_register.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C,MAAM,CAAC,OAAO,OAAO,kBAAkB;IACrC,OAAO,CAAC,OAAO,CAAsC;IAErD,QAAQ,CAAC,MAAM,EAAE,UAAU;IAI3B,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAIvC,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAIxB,MAAM,CAAC,OAAO,EAAE,MAAM,IAAI,GAAG,UAAU,EAAE;IAIzC,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAMlC,SAAS,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;CAK/C"}
+{"version":3,"file":"game_object_register.d.ts","sourceRoot":"","sources":["../../src/core/game_object_register.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAkB;IACrC;;OAEG;IACH,OAAO,CAAC,OAAO,CAAsC;IAErD,OAAO,CAAC,MAAM,CAA6B;IAE3C;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU;IAK3B;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAIvC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAIxB;;;;;;;;OAQG;IACH,OAAO,IAAI,UAAU,EAAE;IAQvB;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,IAAI,GAAG,UAAU,EAAE;IAQzC;;;;;OAKG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAMlC;;;;;OAKG;IACH,SAAS,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;CAK/C"}