@rpgjs/tiledmap 5.0.0-alpha.9 → 5.0.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rpgjs/tiledmap",
-  "version": "5.0.0-alpha.9",
+  "version": "5.0.0-beta.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
@@ -22,24 +22,24 @@
   "license": "MIT",
   "description": "RPGJS is a framework for creating RPG/MMORPG games",
   "peerDependencies": {
-    "@canvasengine/presets": "2.0.0-beta.25",
-    "@rpgjs/client": "5.0.0-alpha.9",
-    "@rpgjs/common": "5.0.0-alpha.9",
-    "@rpgjs/server": "5.0.0-alpha.9",
-    "@rpgjs/vite": "5.0.0-alpha.9",
-    "canvasengine": "2.0.0-beta.25"
+    "@canvasengine/presets": "*",
+    "@rpgjs/client": "5.0.0-beta.1",
+    "@rpgjs/common": "5.0.0-beta.1",
+    "@rpgjs/server": "5.0.0-beta.1",
+    "@rpgjs/vite": "5.0.0-beta.1",
+    "canvasengine": "*"
   },
   "publishConfig": {
     "access": "public"
   },
   "devDependencies": {
-    "@canvasengine/compiler": "2.0.0-beta.21",
-    "vite": "^6.2.5",
-    "vite-plugin-dts": "^4.5.3"
+    "@canvasengine/compiler": "^2.0.0-beta.44",
+    "vite": "^7.3.0",
+    "vite-plugin-dts": "^4.5.4"
   },
   "type": "module",
   "dependencies": {
-    "@canvasengine/tiled": "2.0.0-beta.25"
+    "@canvasengine/tiled": "^2.0.0-beta.44"
   },
   "scripts": {
     "dev": "vite build --watch",

package/src/client.ts

@@ -1,6 +1,12 @@
-import { RpgClient, RpgClientEngine } from "@rpgjs/client";
+import { RpgClient } from "@rpgjs/client";
 import { defineModule } from "@rpgjs/common";
+import { prepareTiledPhysicsData } from "./physics";
 
 export default defineModule<RpgClient>({
-    effects: []
-})
+  componentAnimations: [],
+  sceneMap: {
+    onPhysicsInit(map: any, context: { mapData: any }) {
+      prepareTiledPhysicsData(context?.mapData, map);
+    },
+  },
+});

package/src/index.ts

@@ -4,6 +4,7 @@ import { createModule } from "@rpgjs/common";
 import { provideLoadMap } from "@rpgjs/client";
 import { TiledParser } from "@canvasengine/tiled";
 import Tiled from "./tiled.ce";
+import { prepareTiledPhysicsData } from "./physics";
 
 export function provideTiledMap(options: {
   basePath: string;
@@ -35,7 +36,7 @@ export function provideTiledMap(options: {
       }
       parsedMap.tilesets = tilesets;
 
-      const obj = {
+      const obj: any = {
         data: mapData,
         component: Tiled,
         parsedMap,
@@ -45,6 +46,9 @@ export function provideTiledMap(options: {
         },
       };
 
+      // Populate dimensions and static hitboxes before the first loadPhysic() call.
+      prepareTiledPhysicsData(obj, obj);
+
       if (options.onLoadMap) {
         await options.onLoadMap(map);
       }

package/src/physics.spec.ts

@@ -0,0 +1,90 @@
+import { describe, expect, it, vi } from "vitest";
+
+vi.mock("@canvasengine/tiled", () => {
+  class MapClass {
+    width: number;
+    height: number;
+    tilewidth: number;
+    tileheight: number;
+    widthPx: number;
+    heightPx: number;
+    private blockedTiles: Set<string>;
+
+    constructor(parsedMap: any) {
+      this.width = parsedMap.width ?? 0;
+      this.height = parsedMap.height ?? 0;
+      this.tilewidth = parsedMap.tilewidth ?? 32;
+      this.tileheight = parsedMap.tileheight ?? 32;
+      this.widthPx = this.width * this.tilewidth;
+      this.heightPx = this.height * this.tileheight;
+      this.blockedTiles = new Set(parsedMap.blockedTiles ?? []);
+    }
+
+    getTileByPosition(x: number, y: number) {
+      const tileX = Math.floor(x / this.tilewidth);
+      const tileY = Math.floor(y / this.tileheight);
+      return {
+        hasCollision: this.blockedTiles.has(`${tileX},${tileY}`),
+      };
+    }
+  }
+
+  return { MapClass };
+});
+
+import { prepareTiledPhysicsData } from "./physics";
+
+describe("prepareTiledPhysicsData", () => {
+  it("adds tiled collision hitboxes without duplicating them on repeated preparation", () => {
+    const mapData = {
+      parsedMap: {
+        width: 3,
+        height: 2,
+        tilewidth: 16,
+        tileheight: 20,
+        blockedTiles: ["1,0", "2,1"],
+      },
+      hitboxes: [{ id: "custom-hitbox", x: 4, y: 5, width: 6, height: 7 }],
+    };
+    const map: any = {};
+    const expectedHitboxes = [
+      { id: "custom-hitbox", x: 4, y: 5, width: 6, height: 7 },
+      { id: "__tiled_collision__:1,0", x: 16, y: 0, width: 16, height: 20 },
+      { id: "__tiled_collision__:2,1", x: 32, y: 20, width: 16, height: 20 },
+    ];
+
+    prepareTiledPhysicsData(mapData, map);
+
+    expect(mapData.width).toBe(48);
+    expect(mapData.height).toBe(40);
+    expect(mapData.hitboxes).toEqual(expectedHitboxes);
+
+    prepareTiledPhysicsData(mapData, map);
+
+    expect(mapData.hitboxes).toEqual(expectedHitboxes);
+  });
+
+  it("removes stale generated tiled hitboxes when blocked tiles change", () => {
+    const mapData = {
+      parsedMap: {
+        width: 2,
+        height: 1,
+        tilewidth: 32,
+        tileheight: 32,
+        blockedTiles: ["0,0"],
+      },
+      hitboxes: [],
+    };
+    const map: any = {};
+
+    prepareTiledPhysicsData(mapData, map);
+    expect(mapData.hitboxes).toEqual([
+      { id: "__tiled_collision__:0,0", x: 0, y: 0, width: 32, height: 32 },
+    ]);
+
+    mapData.parsedMap.blockedTiles = [];
+    prepareTiledPhysicsData(mapData, map);
+
+    expect(mapData.hitboxes).toEqual([]);
+  });
+});

package/src/physics.ts

@@ -0,0 +1,98 @@
+import { MapClass } from "@canvasengine/tiled";
+
+type AnyMap = {
+  tiled?: MapClass;
+};
+
+type RectHitbox = {
+  id: string;
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+};
+
+const TILED_HITBOX_ID_PREFIX = "__tiled_collision__:";
+
+export function prepareTiledPhysicsData(mapData: any, map: AnyMap): void {
+  if (!mapData?.parsedMap) {
+    return;
+  }
+
+  const tiledMap = new MapClass(mapData.parsedMap);
+  map.tiled = tiledMap;
+
+  const tiledHitboxes = collectBlockedTileHitboxes(tiledMap);
+  mapData.hitboxes = mergeTiledHitboxes(mapData.hitboxes, tiledHitboxes);
+  mapData.width = tiledMap.widthPx;
+  mapData.height = tiledMap.heightPx;
+}
+
+export function applyTiledPointEvents(mapData: any): void {
+  const objects = mapData?.parsedMap?.objects;
+  if (!Array.isArray(objects) || !Array.isArray(mapData?.events)) {
+    return;
+  }
+
+  for (const obj of objects) {
+    if (!obj?.point) {
+      continue;
+    }
+
+    mapData.events = mapData.events
+      .map((eventEntry: any) => {
+        if (eventEntry?.name === obj.name) {
+          return {
+            event: eventEntry,
+            x: obj.x,
+            y: obj.y,
+          };
+        }
+        return eventEntry;
+      })
+      .filter((eventEntry: any) => eventEntry !== null);
+  }
+}
+
+function collectBlockedTileHitboxes(tiledMap: MapClass): RectHitbox[] {
+  const hitboxes: RectHitbox[] = [];
+  const mapWidth = tiledMap.width;
+  const mapHeight = tiledMap.height;
+  const tileWidth = tiledMap.tilewidth;
+  const tileHeight = tiledMap.tileheight;
+
+  for (let y = 0; y < mapHeight; y++) {
+    for (let x = 0; x < mapWidth; x++) {
+      const tileInfo = tiledMap.getTileByPosition(x * tileWidth, y * tileHeight, [0, 0], {
+        populateTiles: true,
+      });
+      if (tileInfo.hasCollision) {
+        hitboxes.push({
+          id: createTiledHitboxId(x, y),
+          x: x * tileWidth,
+          y: y * tileHeight,
+          width: tileWidth,
+          height: tileHeight,
+        });
+      }
+    }
+  }
+
+  return hitboxes;
+}
+
+function mergeTiledHitboxes(existingHitboxes: any, tiledHitboxes: RectHitbox[]): any[] {
+  const preservedHitboxes = Array.isArray(existingHitboxes)
+    ? existingHitboxes.filter((hitbox) => !isGeneratedTiledHitbox(hitbox))
+    : [];
+
+  return [...preservedHitboxes, ...tiledHitboxes];
+}
+
+function isGeneratedTiledHitbox(hitbox: any): boolean {
+  return typeof hitbox?.id === "string" && hitbox.id.startsWith(TILED_HITBOX_ID_PREFIX);
+}
+
+function createTiledHitboxId(x: number, y: number): string {
+  return `${TILED_HITBOX_ID_PREFIX}${x},${y}`;
+}

package/src/server.ts

@@ -1,173 +1,27 @@
 import { RpgMap, RpgServer } from "@rpgjs/server";
 import { MapClass } from "@canvasengine/tiled";
 import { defineModule } from "@rpgjs/common";
+import { applyTiledPointEvents, prepareTiledPhysicsData } from "./physics";
 
-// Extend RpgMap interface to include tiled property
 declare module "@rpgjs/server" {
   interface RpgMap {
     tiled?: MapClass;
   }
 }
 
-/**
- * Interface for an RpgMap extended with Tiled functionality
- *
- * @description This interface combines RpgMap with MapClass to enable
- * the use of Tiled methods on RPG maps
- */
 export interface RpgTiledMap extends RpgMap {
   tiled: MapClass;
 }
 
-/**
- * Tiled Module for RPGJS
- *
- * @description This module extends RPGJS maps with Tiled functionality,
- * allowing TMX map parsing and automatic hitbox creation
- * based on collisions defined in Tiled
- *
- * ## Features
- *
- * - **Automatic parsing**: Parses TMX files from Tiled Map Editor
- * - **Collision detection**: Scans all tiles to detect collisions
- * - **Hitbox creation**: Automatically generates hitboxes for each collision tile
- * - **RpgMap extension**: Adds the `tiled` property to all RpgMap instances
- *
- * ## Usage
- *
- * Once this module is activated, you can use Tiled methods on your maps:
- *
- * @example
- * ```ts
- * // In a map class
- * class MyMap extends RpgMap {
- *     onLoad() {
- *         // Access Tiled functionality
- *         const tiles = this.tiled.getTileByPosition(100, 100);
- *
- *         if (tiles.hasCollision) {
- *             console.log('This position has a collision');
- *         }
- *
- *         // Iterate through all tiles by index
- *         for (let i = 0; i < this.tiled.width * this.tiled.height; i++) {
- *             const tileInfo = this.tiled.getTileByIndex(i);
- *             if (tileInfo.hasCollision) {
- *                 console.log(`Tile ${i} has collision`);
- *             }
- *         }
- *
- *         // Get information about a specific layer
- *         const layer = this.tiled.getLayerByName('Collision');
- *         if (layer) {
- *             console.log('Collision layer found:', layer);
- *         }
- *     }
- * }
- * ```
- */
 export default defineModule<RpgServer>({
   map: {
-    /**
-     * Hook called before map update
-     *
-     * @description Parses Tiled data and creates collision hitboxes
-     * automatically by iterating through all tiles on the map.
-     *
-     * This method:
-     * 1. Parses TMX data with TiledParser
-     * 2. Creates a MapClass instance with parsed data
-     * 3. Attaches the Tiled instance to the RpgMap
-     * 4. Scans all tiles to detect collisions
-     * 5. Automatically creates hitboxes for each collision tile
-     *
-     * @param mapData - Map data containing TMX information
-     * @param map - RpgMap instance to extend
-     * @returns The modified map instance with tiled property
-     *
-     * @example
-     * ```ts
-     * // Created hitboxes will have this structure:
-     * {
-     *     id: 'collision_x_y',           // Unique identifier
-     *     x: x * tileWidth,              // X position in pixels
-     *     y: y * tileHeight,             // Y position in pixels
-     *     width: tileWidth,              // Tile width
-     *     height: tileHeight,            // Tile height
-     *     properties: {
-     *         type: 'collision',         // Hitbox type
-     *         tileX: x,                  // X position in tiles
-     *         tileY: y,                  // Y position in tiles
-     *         tileIndex: tileIndex       // Tile index
-     *     }
-     * }
-     * ```
-     */
     onBeforeUpdate<T = RpgMap>(mapData: any, map: T): T {
-      const tiledMap = new MapClass(mapData.parsedMap);
-
-      // Attach Tiled instance to the map
-      (map as any).tiled = tiledMap;
-
-      // Initialize hitboxes array
-      mapData.hitboxes = mapData.hitboxes || [];
-      mapData.width = tiledMap.widthPx;
-      mapData.height = tiledMap.heightPx;
-
-      // Iterate through all map tiles to detect collisions
-      const mapWidth = tiledMap.width;
-      const mapHeight = tiledMap.height;
-      const tileWidth = tiledMap.tilewidth;
-      const tileHeight = tiledMap.tileheight;
-
-      // Iterate through each tile on the map
-      for (let y = 0; y < mapHeight; y++) {
-        for (let x = 0; x < mapWidth; x++) {
-          // Use getTileByPosition which is simpler and handles pixel coordinates directly
-          const pixelX = x * tileWidth;
-          const pixelY = y * tileHeight;
-          const tileInfo = tiledMap.getTileByPosition(pixelX, pixelY, [0, 0], {
-            populateTiles: true,
-          });
-
-          // If tile has collision, create a hitbox
-          if (tileInfo.hasCollision) {
-            const hitbox = {
-              id: `collision_${x}_${y}`,
-              x: pixelX,
-              y: pixelY,
-              width: tileWidth,
-              height: tileHeight,
-              properties: {
-                type: "collision",
-                tileX: x,
-                tileY: y,
-                tileIndex: tileInfo.tileIndex,
-              },
-            };
-
-            mapData.hitboxes.push(hitbox);
-          }
-        }
-      }
-
-      for (let obj of mapData.parsedMap.objects) {
-        if (obj.point) {
-          mapData.events = mapData.events
-            .map((e) => {
-              if (e.name === obj.name) {
-                return {
-                  event: e,
-                  x: obj.x,
-                  y: obj.y,
-                };
-              }
-              return e;
-            })
-            .filter((e) => e !== null);
-        }
-      }
+      prepareTiledPhysicsData(mapData, map as any);
+      applyTiledPointEvents(mapData);
       return map;
     },
+    onPhysicsInit(map: any, context: { mapData: any }) {
+      prepareTiledPhysicsData(context?.mapData, map);
+    },
   },
 });

package/src/tiled.ce

@@ -5,10 +5,14 @@
 <script>
     import { EventLayerComponent } from "@rpgjs/client";
     import { TiledMap } from "@canvasengine/presets";
-    import { signal } from "canvasengine";
+    import { signal, effect } from "canvasengine";
 
     const { data, params } = defineProps()
 
     const map = signal(data())
     const basePath = signal(params().basePath)
+
+    effect(() => {
+        map.set(data())
+    })
 </script>