@dryanovski/gamefoo 0.0.1 → 0.2.1

package/dist/debug/monitor.d.ts

@@ -0,0 +1,12 @@
+export default class Monitor {
+    private fps;
+    private timer;
+    private frameCount;
+    private memory;
+    private frames;
+    x: number;
+    y: number;
+    update(delta: number): void;
+    render(ctx: CanvasRenderingContext2D): void;
+}
+//# sourceMappingURL=monitor.d.ts.map

package/dist/debug/monitor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"monitor.d.ts","sourceRoot":"","sources":["../../src/debug/monitor.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B,OAAO,CAAC,GAAG,CAAa;IACxB,OAAO,CAAC,KAAK,CAAa;IAC1B,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,MAAM,CAAa;IAE3B,OAAO,CAAC,MAAM,CAAiB;IAExB,CAAC,EAAE,MAAM,CAAK;IACd,CAAC,EAAE,MAAM,CAAK;IAErB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAqB3B,MAAM,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;CAuB5C"}

package/dist/decorators/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./log";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/decorators/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC"}

package/dist/decorators/log.d.ts

@@ -0,0 +1,33 @@
+/**
+ * A method decorator that logs the method name, arguments, and return value.
+ *
+ * Uses the legacy (experimental) decorator protocol for compatibility with
+ * Bun's browser bundler.
+ *
+ * @category Decorators
+ * @since 0.2.0
+ *
+ * @param target    - The prototype of the class (instance method) or the constructor (static method).
+ * @param propertyKey - The name of the decorated method.
+ * @param descriptor  - The property descriptor for the method.
+ *
+ * @returns The modified property descriptor with logging behaviour.
+ *
+ * @example
+ * ```typescript
+ * class Example {
+ *  @log
+ *  myMethod(arg1: string, arg2: number) {
+ *   return `${arg1} - ${arg2}`;
+ *  }
+ * }
+ *
+ * const example = new Example();
+ * example.myMethod('test', 42);
+ *  Output:
+ *  ▶ myMethod(["test", 42])
+ *  ◀ myMethod → "test - 42"
+ * ```
+ */
+export declare function log(target: object, propertyKey: string | symbol, descriptor: PropertyDescriptor): PropertyDescriptor;
+//# sourceMappingURL=log.d.ts.map

package/dist/decorators/log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../src/decorators/log.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,kBAAkB,GAAG,kBAAkB,CAapH"}

package/dist/entities/dynamic_entity.d.ts

@@ -1,11 +1,93 @@
 import type { Vector2 } from "../types";
 import Entity from "./entity";
+/**
+ * Abstract entity with built-in velocity and speed, suitable for any
+ * game object that moves (players, NPCs, projectiles, etc.).
+ *
+ * `DynamicEntity` extends {@link Entity} with a {@link Vector2}
+ * velocity and a scalar speed, plus getter/setter pairs for each.
+ * Subclasses are responsible for applying the velocity to position
+ * inside their {@link Entity.update | update} implementation.
+ *
+ * @category Entities
+ * @since 0.1.0
+ *
+ * @example Subclassing
+ * ```ts
+ * import { DynamicEntity } from "gamefoo";
+ *
+ * class Bullet extends DynamicEntity {
+ *   constructor(x: number, y: number) {
+ *     super("bullet", x, y, 4, 4);
+ *     this.setSpeed(600);
+ *     this.setVelocity({ x: 1, y: 0 });
+ *   }
+ *
+ *   update(dt: number) {
+ *     this.x += this.velocity.x * this.speed * dt;
+ *     this.y += this.velocity.y * this.speed * dt;
+ *   }
+ *
+ *   render(ctx: CanvasRenderingContext2D) {
+ *     ctx.fillStyle = "#ff0";
+ *     ctx.fillRect(this.x, this.y, 4, 4);
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link Entity} — parent class (identity, transform, behaviours)
+ * @see {@link Player} — concrete dynamic entity for the player
+ */
 export default abstract class DynamicEntity extends Entity {
+    /**
+     * Directional velocity vector.
+     *
+     * Represents the normalised (or raw) direction of movement. Multiply
+     * by {@link DynamicEntity.speed | speed} and `deltaTime` to get the
+     * per-frame displacement.
+     *
+     * @defaultValue `{ x: 0, y: 0 }`
+     */
     protected velocity: Vector2;
+    /**
+     * Scalar movement speed in pixels per second.
+     *
+     * @defaultValue `0`
+     */
     protected speed: number;
+    /**
+     * Replaces the current velocity vector.
+     *
+     * @param velocity - The new velocity.
+     *
+     * @example
+     * ```ts
+     * entity.setVelocity({ x: -1, y: 0 }); // moving left
+     * ```
+     */
     setVelocity(velocity: Vector2): void;
+    /**
+     * Returns a **copy** of the current velocity vector.
+     *
+     * @returns A new {@link Vector2}.
+     */
     getVelocity(): Vector2;
+    /**
+     * Sets the scalar movement speed.
+     *
+     * @param speed - Speed in pixels per second.
+     *
+     * @example
+     * ```ts
+     * entity.setSpeed(200);
+     * ```
+     */
     setSpeed(speed: number): void;
+    /**
+     * Returns the current movement speed.
+     *
+     * @returns Speed in pixels per second.
+     */
     getSpeed(): number;
 }
 //# sourceMappingURL=dynamic_entity.d.ts.map

package/dist/entities/dynamic_entity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dynamic_entity.d.ts","sourceRoot":"","sources":["../../entities/dynamic_entity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,MAAM,MAAM,UAAU,CAAC;AAE9B,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,aAAc,SAAQ,MAAM;IACxD,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAkB;IAC7C,SAAS,CAAC,KAAK,EAAE,MAAM,CAAK;IAE5B,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;IAIpC,WAAW,IAAI,OAAO;IAItB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI7B,QAAQ,IAAI,MAAM;CAGnB"}
+{"version":3,"file":"dynamic_entity.d.ts","sourceRoot":"","sources":["../../src/entities/dynamic_entity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,MAAM,MAAM,UAAU,CAAC;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,aAAc,SAAQ,MAAM;IACxD;;;;;;;;OAQG;IACH,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAkB;IAE7C;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,CAAK;IAE5B;;;;;;;;;OASG;IACH,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;IAIpC;;;;OAIG;IACH,WAAW,IAAI,OAAO;IAItB;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI7B;;;;OAIG;IACH,QAAQ,IAAI,MAAM;CAGnB"}

package/dist/entities/entity.d.ts

@@ -1,33 +1,238 @@
 import type { Behaviour } from "../core/behaviour";
-import type { Vector2 } from "../types";
+import type { Demension, Vector2 } from "../types";
+/**
+ * Abstract base class for every game entity in the GameFoo engine.
+ *
+ * `Entity` provides:
+ *
+ * - **Identity** — a unique string {@link Entity.id | id}.
+ * - **Transform** — a 2-D {@link Entity.position | position} and
+ *   {@link Entity.size | size} with convenient `x`/`y` accessors.
+ * - **Behaviour system** — attach, detach, query, and bulk-update
+ *   {@link Behaviour} instances that compose an entity's logic.
+ *
+ * Subclasses must implement {@link Entity.update} and
+ * {@link Entity.render}.
+ *
+ * @category Entities
+ * @since 0.1.0
+ *
+ * @example Subclassing
+ * ```ts
+ * import { Entity } from "gamefoo";
+ *
+ * class Wall extends Entity {
+ *   constructor(x: number, y: number, w: number, h: number) {
+ *     super("wall", x, y, w, h);
+ *   }
+ *
+ *   update(_dt: number) {}
+ *
+ *   render(ctx: CanvasRenderingContext2D) {
+ *     ctx.fillStyle = "#888";
+ *     ctx.fillRect(this.x, this.y, this.size.width, this.size.height);
+ *   }
+ * }
+ * ```
+ *
+ * @example Attaching behaviours
+ * ```ts
+ * const entity = new Wall(0, 0, 100, 20);
+ * entity.attachBehaviour(new Collidable(entity, world, { ... }));
+ *
+ * if (entity.hasBehaviour("collidable")) {
+ *   console.log("Wall has collision!");
+ * }
+ * ```
+ *
+ * @see {@link DynamicEntity} — extends Entity with velocity / speed
+ * @see {@link Player}        — concrete player entity
+ * @see {@link Behaviour}     — composable logic units
+ */
 export default abstract class Entity {
+    /**
+     * Unique identifier for this entity.
+     *
+     * Used as the key in {@link GameObjectRegister} and for
+     * collision-callback identification.
+     */
     id: string;
-    protected position: Vector2;
-    protected size: {
-        width: number;
-        height: number;
-    };
+    /**
+     * World-space position of the entity's origin (top-left corner).
+     */
+    protected readonly position: Vector2;
+    /**
+     * Bounding dimensions of the entity in pixels.
+     */
+    protected readonly size: Demension;
+    /**
+     * Internal map from behaviour key (lowercased type) to
+     * {@link Behaviour} instance.
+     */
     private behaviorMap;
+    /**
+     * Priority-sorted cache of behaviours. Invalidated (`null`) whenever
+     * a behaviour is attached or detached.
+     */
     private _sortedBehaviors;
+    /**
+     * Horizontal position of the entity (shorthand for
+     * `position.x`).
+     */
     get x(): number;
+    /** Sets the horizontal position. */
     set x(value: number);
+    /**
+     * Vertical position of the entity (shorthand for
+     * `position.y`).
+     */
     get y(): number;
+    /** Sets the vertical position. */
     set y(value: number);
-    constructor(id: string, x: number, y: number, width: number, height: number);
+    /**
+     * Creates a new entity.
+     *
+     * @param id     - Unique string identifier.
+     * @param x      - Initial X position in pixels.
+     * @param y      - Initial Y position in pixels.
+     * @param width  - Width of the entity's bounding box in pixels.
+     * @param height - Height of the entity's bounding box in pixels.
+     *
+     * @example
+     * ```ts
+     * class Crate extends Entity {
+     *   constructor(x: number, y: number) {
+     *     super("crate", x, y, 32, 32);
+     *   }
+     *   // ...
+     * }
+     * ```
+     */
+    constructor(id: string, x: number, y: number, width?: number, height?: number);
+    /**
+     * Advances the entity's state by one frame.
+     *
+     * @param deltaTime - Seconds elapsed since the previous frame.
+     */
     abstract update(deltaTime: number): void;
+    /**
+     * Draws the entity to the canvas.
+     *
+     * @param ctx - The 2-D rendering context.
+     */
     abstract render(ctx: CanvasRenderingContext2D): void;
+    /**
+     * Returns a **copy** of the entity's current position.
+     *
+     * @returns A new {@link Vector2} with the entity's `x` and `y`.
+     */
     getPosition(): Vector2;
-    getSize(): {
-        width: number;
-        height: number;
-    };
+    /**
+     * Returns a **copy** of the entity's bounding dimensions.
+     *
+     * @returns An object with `width` and `height`.
+     */
+    getSize(): Demension;
+    /**
+     * Set size of the entity
+     *
+     * @since 0.2.0
+     *
+     * @return void
+     */
+    setSize(width: number, height: number): void;
+    /**
+     * Retrieves a behaviour by its key (case-insensitive).
+     *
+     * @typeParam T - The expected concrete behaviour type.
+     * @param key - The behaviour's {@link Behaviour.type | type} string.
+     * @returns The behaviour cast to `T`, or `undefined` if not found.
+     *
+     * @example
+     * ```ts
+     * const ctrl = entity.getBehaviour<Control>("control");
+     * if (ctrl) ctrl.enabled = false;
+     * ```
+     */
     getBehaviour<T extends Behaviour>(key: string): T | undefined;
+    /**
+     * Returns all attached behaviours that are instances of the given
+     * class.
+     *
+     * @typeParam T - The behaviour subclass to filter by.
+     * @param type - The constructor function to test with `instanceof`.
+     * @returns An array of matching behaviours.
+     *
+     * @example
+     * ```ts
+     * const renderers = entity.getBehavioursByType(SpriteRender);
+     * ```
+     */
     getBehavioursByType<T extends Behaviour>(type: new (...args: any[]) => T): T[];
+    /**
+     * Checks whether a behaviour with the given key is attached.
+     *
+     * @param key - The behaviour's {@link Behaviour.type | type} string
+     *   (case-insensitive).
+     * @returns `true` if the behaviour exists on this entity.
+     */
     hasBehaviour(key: string): boolean;
+    /**
+     * Attaches a behaviour to this entity.
+     *
+     * If the behaviour defines an {@link Behaviour.onAttach | onAttach}
+     * hook, it is called immediately.  The sorted-behaviour cache is
+     * invalidated.
+     *
+     * @typeParam T - The behaviour type being attached.
+     * @param behavior - The behaviour instance to add.
+     * @returns The same behaviour instance (for chaining).
+     *
+     * @example
+     * ```ts
+     * const hk = entity.attachBehaviour(new HealthKit(entity, 100));
+     * hk.takeDamage(10);
+     * ```
+     */
     attachBehaviour<T extends Behaviour>(behavior: T): T;
+    /**
+     * Detaches a behaviour by its key and calls
+     * {@link Behaviour.onDetach | onDetach} if defined.
+     *
+     * @param key - The behaviour's {@link Behaviour.type | type} string
+     *   (case-insensitive).
+     *
+     * @example
+     * ```ts
+     * entity.detachBehaviour("collidable");
+     * ```
+     */
     detachBehaviour(key: string): void;
+    /**
+     * Returns all attached behaviours sorted by
+     * {@link Behaviour.priority} (ascending).  The result is cached and
+     * only re-computed when behaviours are added or removed.
+     *
+     * @internal
+     */
     private get behaviors();
+    /**
+     * Calls {@link Behaviour.update | update(deltaTime)} on every
+     * enabled behaviour, in priority order.
+     *
+     * Typically called from a subclass's `update` implementation.
+     *
+     * @param deltaTime - Seconds elapsed since the previous frame.
+     */
     protected updateBehaviours(deltaTime: number): void;
+    /**
+     * Calls {@link Behaviour.render | render(ctx)} on every enabled
+     * behaviour that defines a render method, in priority order.
+     *
+     * Typically called from a subclass's `render` implementation.
+     *
+     * @param ctx - The canvas 2-D rendering context.
+     */
     protected renderBehaviours(ctx: CanvasRenderingContext2D): void;
 }
 //# sourceMappingURL=entity.d.ts.map

package/dist/entities/entity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../entities/entity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAExC,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,MAAM;IAC3B,EAAE,EAAE,MAAM,CAAM;IACvB,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAkB;IAC7C,SAAS,CAAC,IAAI;;;MAA2B;IAEzC,OAAO,CAAC,WAAW,CAAqC;IACxD,OAAO,CAAC,gBAAgB,CAA4B;IAEpD,IAAI,CAAC,IAAI,MAAM,CAEd;IAED,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAElB;IAED,IAAI,CAAC,IAAI,MAAM,CAEd;IAED,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAElB;gBAEW,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAM3E,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IACxC,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;IAEpD,WAAW,IAAI,OAAO;IAItB,OAAO,IAAI;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;IAI5C,YAAY,CAAC,CAAC,SAAS,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAI7D,mBAAmB,CAAC,CAAC,SAAS,SAAS,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE;IAI9E,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIlC,eAAe,CAAC,CAAC,SAAS,SAAS,EAAE,QAAQ,EAAE,CAAC,GAAG,CAAC;IAUpD,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAWlC,OAAO,KAAK,SAAS,GAOpB;IAED,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAQnD,SAAS,CAAC,gBAAgB,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;CAOhE"}
+{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../src/entities/entity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,MAAM;IAClC;;;;;OAKG;IACI,EAAE,EAAE,MAAM,CAAM;IAEvB;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAkB;IAEtD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAA2B;IAE7D;;;OAGG;IACH,OAAO,CAAC,WAAW,CAAqC;IAExD;;;OAGG;IACH,OAAO,CAAC,gBAAgB,CAA4B;IAEpD;;;OAGG;IACH,IAAI,CAAC,IAAI,MAAM,CAEd;IAED,oCAAoC;IACpC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAElB;IAED;;;OAGG;IACH,IAAI,CAAC,IAAI,MAAM,CAEd;IAED,kCAAkC;IAClC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAElB;IAED;;;;;;;;;;;;;;;;;;OAkBG;gBACS,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;IAS7E;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAExC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;IAEpD;;;;OAIG;IACH,WAAW,IAAI,OAAO;IAItB;;;;OAIG;IACH,OAAO,IAAI,SAAS;IAIpB;;;;;;OAMG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAK5C;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,CAAC,SAAS,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAI7D;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,CAAC,SAAS,SAAS,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE;IAI9E;;;;;;OAMG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIlC;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,CAAC,SAAS,SAAS,EAAE,QAAQ,EAAE,CAAC,GAAG,CAAC;IAUpD;;;;;;;;;;;OAWG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAWlC;;;;;;OAMG;IACH,OAAO,KAAK,SAAS,GAKpB;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAQnD;;;;;;;OAOG;IACH,SAAS,CAAC,gBAAgB,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;CAOhE"}

package/dist/entities/player.d.ts

@@ -1,10 +1,86 @@
 import type { Control } from "../core/behaviours/control";
 import type { HealthKit } from "../core/behaviours/healtkit";
 import DynamicEntity from "./dynamic_entity";
+/**
+ * Default player entity with convenience accessors for common
+ * behaviours.
+ *
+ * `Player` extends {@link DynamicEntity} and automatically delegates
+ * its {@link Player.update | update} and {@link Player.render | render}
+ * calls to all attached {@link Behaviour | behaviours}. It also
+ * provides typed getters for the {@link Control} and
+ * {@link HealthKit} behaviours so game code can access them without
+ * manual casting.
+ *
+ * Subclass `Player` to customise rendering, add game-specific logic,
+ * or bind additional behaviours.
+ *
+ * @category Entities
+ * @since 0.1.0
+ *
+ * @example Basic usage
+ * ```ts
+ * import { Player, Control, HealthKit, Input } from "gamefoo";
+ *
+ * const player = new Player("hero", 400, 300, 50, 50);
+ *
+ * player.attachBehaviour(new Control(player, new Input()));
+ * player.attachBehaviour(new HealthKit(player, 100));
+ *
+ * player.control?.enabled;           // true
+ * player.healthkit?.getHealth();      // 100
+ * ```
+ *
+ * @example Subclassing for custom rendering
+ * ```ts
+ * class Knight extends Player {
+ *   constructor(x: number, y: number) {
+ *     super("knight", x, y, 48, 48);
+ *   }
+ *
+ *   override render(ctx: CanvasRenderingContext2D) {
+ *     ctx.fillStyle = "#c0c0c0";
+ *     ctx.fillRect(this.x, this.y, 48, 48);
+ *     this.renderBehaviours(ctx);
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link DynamicEntity} — parent class (velocity, speed)
+ * @see {@link Control}       — keyboard movement behaviour
+ * @see {@link HealthKit}     — health-tracking behaviour
+ */
 export default class Player extends DynamicEntity {
+    /**
+     * Convenience getter for the attached {@link Control} behaviour.
+     *
+     * @returns The `Control` instance, or `undefined` if not attached.
+     */
     get control(): Control | undefined;
+    /**
+     * Convenience getter for the attached {@link HealthKit} behaviour.
+     *
+     * @returns The `HealthKit` instance, or `undefined` if not attached.
+     */
     get healthkit(): HealthKit | undefined;
+    /**
+     * Advances all attached behaviours.
+     *
+     * @inheritDoc
+     * @param deltaTime - Seconds elapsed since the previous frame.
+     */
     update(deltaTime: number): void;
+    /**
+     * Draws a default blue rectangle and then renders all attached
+     * behaviours (e.g. sprite overlays, health bars).
+     *
+     * Override this in a subclass for custom visuals.
+     *
+     * TODO: write a better default player object
+     *
+     * @inheritDoc
+     * @param ctx - The canvas 2-D rendering context.
+     */
     render(ctx: CanvasRenderingContext2D): void;
 }
 //# sourceMappingURL=player.d.ts.map

package/dist/entities/player.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"player.d.ts","sourceRoot":"","sources":["../../entities/player.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAE7C,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,aAAa;IAC/C,IAAI,OAAO,IAAI,OAAO,GAAG,SAAS,CAEjC;IAED,IAAI,SAAS,IAAI,SAAS,GAAG,SAAS,CAErC;IAED,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAI/B,MAAM,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;CAK5C"}
+{"version":3,"file":"player.d.ts","sourceRoot":"","sources":["../../src/entities/player.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,aAAa;IAC/C;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,GAAG,SAAS,CAEjC;IAED;;;;OAIG;IACH,IAAI,SAAS,IAAI,SAAS,GAAG,SAAS,CAErC;IAED;;;;;OAKG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAI/B;;;;;;;;;;OAUG;IACH,MAAM,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;CAK5C"}

package/dist/entities/text.d.ts

@@ -0,0 +1,52 @@
+import FontBitmap, { type InternalBitmapFontName } from "../core/fonts/font_bitmap";
+import Entity from "./entity";
+/**
+ * Abstract base class for Text and Label alike objects
+ *
+ * `Text` extends {@link Entity} and could also get all behaviors attach to it but
+ * most likely there will be no need for that. Its primary design use case is to
+ * keep track of text objects and interact with them
+ *
+ * @category Entities
+ * @since 0.2.0
+ *
+ * @see {@link Entity} - parent class
+ */
+export default abstract class Text extends Entity {
+    /** Bitmap font name to load internally */
+    protected fontName: string;
+    /** BitmapFont instance used to manipulate the font */
+    protected font: FontBitmap;
+    /** Internal state of the text needed to be update */
+    protected text: string;
+    /**
+     * Create new Text object that could be placed and render on the screen
+     *
+     * @param fontName - the FontBitmap valid name to load
+     *
+     * @example
+     * ```ts
+     * const Label = new Text('CustomLabel', '5x5');
+     * ```
+     */
+    constructor(id: string, fontName: InternalBitmapFontName);
+    /**
+     * Set internal state value
+     *
+     * @param text - any content that should be render
+     *
+     * @return void
+     */
+    setText(text: string): void;
+    /**
+     * Get the internal state of the object
+     *
+     * @return string
+     */
+    getText(): string;
+    /**
+     * Render the text to the canvas using the BitmapFont instance
+     */
+    render(ctx: CanvasRenderingContext2D): void;
+}
+//# sourceMappingURL=text.d.ts.map

package/dist/entities/text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../src/entities/text.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,EAAE,EAAE,KAAK,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACpF,OAAO,MAAM,MAAM,UAAU,CAAC;AAE9B;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,IAAK,SAAQ,MAAM;IAC/C,0CAA0C;IAC1C,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE3B,sDAAsD;IACtD,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC;IAE3B,qDAAqD;IACrD,SAAS,CAAC,IAAI,EAAE,MAAM,CAAM;IAE5B;;;;;;;;;OASG;gBACS,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,sBAAsB;IAQxD;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM;IAMpB;;;;OAIG;IACH,OAAO,IAAI,MAAM;IAIjB;;OAEG;IACM,MAAM,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;CAGrD"}

package/dist/index.d.ts

@@ -1,14 +1,42 @@
+/**
+ * GameFoo — a lightweight 2-D canvas game engine.
+ *
+ * This barrel module re-exports every public class, behaviour, utility,
+ * and type so consumers can import from a single entry point:
+ *
+ * ```ts
+ * import { Engine, Player, Input, Collidable } from "gamefoo";
+ * ```
+ *
+ * @category Core
+ * @module gamefoo
+ * @since 0.1.0
+ */
+export { log } from "@decorators";
+export { default as Asset } from "./core/asset";
 export { Behaviour } from "./core/behaviour";
 export { Collidable } from "./core/behaviours/collidable";
 export { Control } from "./core/behaviours/control";
 export { HealthKit } from "./core/behaviours/healtkit";
+export { default as SpriteRender } from "./core/behaviours/sprite_render";
 export { default as Camera } from "./core/camera";
 export { default as Engine } from "./core/engine";
+export { default as FontBitmap } from "./core/fonts/font_bitmap";
+export { default as FontBitmapPrebuild } from "./core/fonts/font_bitmap_prebuild";
 export { default as GameObjectRegister } from "./core/game_object_register";
 export { default as Input } from "./core/input";
+export { default as Sprite } from "./core/sprite";
+export { PerlinNoise } from "./core/utils/perlin_noise";
 export { default as World } from "./core/world";
+export { default as Monitor } from "./debug/monitor";
 export { default as DynamicEntity } from "./entities/dynamic_entity";
 export { default as Entity } from "./entities/entity";
 export { default as Player } from "./entities/player";
-export type { ColliderShape, CollisionInfo, GameObject, Vector2, } from "./types";
+export { default as Text } from "./entities/text";
+export { CameraSystem } from "./subsystems/camera_system";
+export { CollisionSystem } from "./subsystems/collision_system";
+export { MonitorSystem } from "./subsystems/monitor_system";
+export { ObjectSystem } from "./subsystems/object_system";
+export type { SubSystem } from "./subsystems/types";
+export type { ColliderShape, CollisionInfo, Demension, GameObject, Vector2 } from "./types";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAC5E,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EACV,aAAa,EACb,aAAa,EACb,UAAU,EACV,OAAO,GACR,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAGH,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAElC,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAC5E,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,eAAe,CAAC;AAElD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAExD,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAErD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,YAAY,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEpD,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC"}