@ignifx/physics-2d 0.9.0 → 0.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ignifx/physics-2d",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "ignifx 2D physics: Rigidbody2D, 2D colliders, CharacterController2D, queries.",
   "keywords": [
     "ignifx",
@@ -45,12 +45,12 @@
     "typedoc-plugin-markdown": "^4.13.0",
     "typescript-native": "npm:typescript@7.0.2",
     "vitest": "^5.0.0",
-    "@ignifx/2d": "0.9.0",
-    "@ignifx/core": "0.9.0"
+    "@ignifx/2d": "0.11.0",
+    "@ignifx/core": "0.11.0"
   },
   "peerDependencies": {
-    "@ignifx/2d": "0.9.0",
-    "@ignifx/core": "0.9.0"
+    "@ignifx/2d": "0.11.0",
+    "@ignifx/core": "0.11.0"
   },
   "peerDependenciesMeta": {
     "@ignifx/2d": {

package/skills/physics-2d/SKILL.md

@@ -3,7 +3,7 @@ name: physics-2d
 description: Adds 2D physics to an ignifx game with @ignifx/physics-2d: Rapier 2D simulation on the fixed loop, Rigidbody2D, box/circle/capsule/polygon/edge/tilemap colliders, physics materials, 2D triggers, CharacterController2D with slopes, autostep, snap-to-ground and one-way platforms, 2D raycasts and shape queries, the collision layer matrix, and render interpolation. Use when adding or editing 2D physics bodies, 2D colliders, platformer movement, 2D triggers, or 2D queries in an ignifx project, or when the user mentions @ignifx/physics-2d, Rigidbody2D, Rapier, or CharacterController2D.
 license: Apache-2.0
 metadata:
-  ignifx-version: "0.9.0"
+  ignifx-version: "0.11.0"
 ---
 
 # @ignifx/physics-2d
@@ -24,10 +24,10 @@ A world uses **either** `physics()` **or** `physics2d()`. Registering both throw
 
 ## Environment
 
-- Engine: ignifx `0.9.0`; this package targets `@ignifx/core` `>=0.0.0 <1.0.0`.
+- Engine: ignifx `0.11.0`; this package targets `@ignifx/core` `>=0.0.0 <1.0.0`.
 - Dependency: `@dimforge/rapier2d-compat` `^0.20.0`. The `-compat` build **inlines** its WebAssembly
   as base64, so nothing has to be served and Node, the browser, and Electron all take the same path.
-- `@ignifx/2d` is an **optional** peer: you need it only for `TilemapCollider2D`'s data type, so a
+- `@ignifx/2d` is an **optional** peer: you need it only for `TilemapCollider2D`'s tilemap, so a
   game that draws its own graphics can use 2D physics on its own.
 - Register it like any extension; nothing happens at import time.
 
@@ -117,14 +117,14 @@ means "weigh the colliders at 1 kg/m²"), `gravityScale`, `linearDamping`, `angu
 Colliders share `offset`, `isTrigger`, `material` (a `.physicsmaterial.json` asset), the
 `inlineMaterial` fallback, `frictionCombine` / `restitutionCombine`, `oneWay`, and `layerOverride`:
 
-| Collider            | Geometry                                                    |
-| ------------------- | ----------------------------------------------------------- |
-| `BoxCollider2D`     | `size` — an axis-aligned rectangle                          |
-| `CircleCollider2D`  | `radius`; the larger scale axis wins                        |
-| `CapsuleCollider2D` | `radius`, `height` (tip to tip), `direction` (`"x" \| "y"`) |
-| `PolygonCollider2D` | `points` → the **convex hull** of the list                  |
-| `EdgeCollider2D`    | `points` → an open chain; infinitely thin                   |
-| `TilemapCollider2D` | `collisionData` from a `Tilemap`                            |
+| Collider            | Geometry                                                      |
+| ------------------- | ------------------------------------------------------------- |
+| `BoxCollider2D`     | `size` — an axis-aligned rectangle                            |
+| `CircleCollider2D`  | `radius`; the larger scale axis wins                          |
+| `CapsuleCollider2D` | `radius`, `height` (tip to tip), `direction` (`"x" \| "y"`)   |
+| `PolygonCollider2D` | `points` → the **convex hull** of the list                    |
+| `EdgeCollider2D`    | `points` → an open chain; infinitely thin                     |
+| `TilemapCollider2D` | the `Tilemap` on the same entity, or assigned `collisionData` |
 
 `CharacterController2D` — `shape` (`"capsule" | "box"`), `radius`, `height`, `offset`, `slopeLimit`
 (degrees), `stepOffset`, `snapToGround`, `skinWidth`, `onOneWayPlatforms`, `pushBodies`,
@@ -132,7 +132,8 @@ Colliders share `offset`, `isTrigger`, `material` (a `.physicsmaterial.json` ass
 `groundNormal`, and `onCollided`.
 
 `app.physics2d` — `gravity`, `raycast`, `raycastAll`, `overlapCircle`, `overlapBox`, `shapeCast`,
-and `rapier` (the unstable escape hatch). Full signatures:
+`colliderOutlines(entity)` (Rapier's drawing of each collider as world-space XY segments, for an
+editor's gizmos), and `rapier` (the unstable escape hatch). Full signatures:
 `skills/ignifx/references/api/physics-2d.md`.
 
 ## Recipes
@@ -218,6 +219,27 @@ if (hit !== null) {
 
 ### Tilemap collision
 
+Put `TilemapCollider2D` on the entity that holds the `Tilemap`, in a scene file or in code. It reads
+that tilemap's `collisionData`, so a level loaded from a scene file collides with no code after
+`loadScene`, and a tile edit (`tilemap.setTile`) reaches physics at the next fixed step.
+
+```ts
+import { Tilemap } from "@ignifx/2d";
+import { TilemapCollider2D } from "@ignifx/physics-2d";
+import type { TilemapAsset } from "@ignifx/2d";
+import type { App } from "@ignifx/core";
+
+export function addLevel(app: App): void {
+  const level = app.world.createEntity("Level");
+  level.addComponent(Tilemap).map = app.assets.load<TilemapAsset>("level.tilemap.json");
+  level.addComponent(TilemapCollider2D);
+}
+```
+
+To use other geometry, such as data built in code or a tilemap on another entity, assign
+`collisionData`. Assigning `null` goes back to the tilemap. The runtime rebuilds the shapes whenever
+the data or its `version` changes.
+
 ```ts run
 import { createApp } from "@ignifx/core";
 import { physics2d, TilemapCollider2D } from "@ignifx/physics-2d";
@@ -249,10 +271,6 @@ collider.collisionData = {
 app.step(1 / 60);
 ```
 
-Assign `tilemap.collisionData` from `@ignifx/2d` instead of building it by hand. The runtime watches
-the data's `version` every fixed step and rebuilds the shapes when it changes, so a tile edit reaches
-physics with no subscription of your own.
-
 ## File formats
 
 `ignifx.physicsmaterial` — the **same** `.physicsmaterial.json` document 3D physics reads
@@ -295,6 +313,11 @@ Component field tables: `skills/ignifx/references/formats/components.md`.
   the authoritative pose. Everything outside the fixed loop — `update`, `lateUpdate`, animation,
   `Camera2DFollow`, rendering — sees the interpolated one, because the display pose is written at the
   top of `Update`. That is what keeps a follow camera locked to the sprite the frame actually draws.
+- **In an edit-mode app (`createApp({ editMode: true })`) bodies exist but nothing simulates.**
+  Bodies are built, rebuilt, and removed as components and tiles change and follow every transform
+  the editor moves, so queries answer from the first frame. No fixed step runs: nothing falls, no
+  collision or trigger callback fires, and no simulated pose is written to a transform.
+  `colliderOutlines(entity)` gives an editor its collider gizmos, tile collision included.
 
 ## Deprecated (current window)