@ludra/core 0.3.1 → 0.5.0

package/dist/world.js

@@ -1,5 +1,7 @@
 import { resolveComponent, } from "./components.js";
+import { getScript, ScriptError, } from "./script.js";
 import { FIXED_DT } from "./time.js";
+import { EVENT_TYPES } from "./types.js";
 import { validateScene } from "./validate.js";
 export class SceneValidationError extends Error {
     diagnostics;
@@ -19,6 +21,8 @@ const STOMP_BOUNCE = 0.6;
 const STOMP_TOLERANCE = 8;
 /** A platformer this far below the bottom of the world has fallen out of it. */
 const FALL_MARGIN = 100;
+/** Bodies this close count as touching for `touch` hooks, so solids (doors, walls) can be touched too. */
+const TOUCH_MARGIN = 1;
 const EPSILON = 1e-4;
 /**
  * The simulation. It advances only through `step`, one fixed frame at a time,
@@ -38,19 +42,29 @@ export class World {
     /** Set when a player reaches a goal. The simulation stops changing after that. */
     won = false;
     previousInput = new Set();
-    constructor(scene) {
+    scripts;
+    seed;
+    spawnCount = 0;
+    handles = new WeakMap();
+    scriptApi;
+    scriptInput = { held: () => false, pressed: () => false };
+    /** The script hook currently running, for error messages and event attribution. */
+    current;
+    constructor(scene, options = {}) {
         this.width = scene.world?.width ?? 960;
         this.height = scene.world?.height ?? 540;
         this.gravity = scene.world?.gravity ?? DEFAULT_GRAVITY;
         this.background = scene.world?.background ?? "#1d2333";
-        this.entities = scene.entities.map(createEntity);
+        this.seed = scene.world?.seed ?? 1;
+        this.scripts = options.scripts;
+        this.entities = scene.entities.map((def) => this.createEntity(def));
     }
     /** Validates raw scene JSON and builds a world, throwing on errors. */
-    static fromJSON(raw) {
+    static fromJSON(raw, options = {}) {
         const { scene, diagnostics } = validateScene(raw);
         if (!scene)
             throw new SceneValidationError(diagnostics);
-        return new World(scene);
+        return new World(scene, options);
     }
     get time() {
         return this.frame * FIXED_DT;
@@ -66,8 +80,14 @@ export class World {
         if (this.won)
             return;
         this.updatePlatformers(input, pressed);
+        this.updateScripts(input, pressed);
+        if (this.won)
+            return;
         this.updatePatrols();
         this.updateBodies();
+        this.updateTouches();
+        if (this.won)
+            return;
         this.updateCollectibles();
         this.updateHazards();
         this.updateGoals();
@@ -82,6 +102,9 @@ export class World {
                 vy: e.body?.vy ?? 0,
                 grounded: e.body?.grounded ?? false,
             };
+            // A JSON copy, so later frames can't change an earlier snapshot.
+            if (Object.keys(e.state).length > 0)
+                entities[e.id].state = JSON.parse(JSON.stringify(e.state));
         }
         return { frame: this.frame, time: this.time, score: this.score, deaths: this.deaths, won: this.won, entities };
     }
@@ -89,8 +112,243 @@ export class World {
         this.events.push({ ...event, frame: this.frame, time: this.time });
     }
     remove(entity) {
-        this.entities.splice(this.entities.indexOf(entity), 1);
+        const index = this.entities.indexOf(entity);
+        if (index >= 0)
+            this.entities.splice(index, 1);
+        entity.removed = true;
+    }
+    // ---------------------------------------------------------------- scripts
+    createEntity(def) {
+        const entity = createEntity(def);
+        const component = def.components.script;
+        if (component) {
+            const resolved = resolveComponent("script", component);
+            const module = getScript(this.scripts, resolved.src);
+            if (!module) {
+                throw new ScriptError({ src: resolved.src, entity: def.id, hook: "load", frame: this.frame }, "this script is not loaded. Hosts pass loaded modules as new World(scene, { scripts }); the CLI and browser runtime do this for you.");
+            }
+            entity.script = { ...resolved, params: { ...resolved.params }, module, started: false, touching: new Set() };
+        }
+        return entity;
+    }
+    updateScripts(held, pressed) {
+        this.scriptInput = { held: (action) => held.has(action), pressed: (action) => pressed.has(action) };
+        // Iterate over a copy: scripts may spawn or destroy entities.
+        for (const e of [...this.entities]) {
+            if (!e.script || e.removed)
+                continue;
+            if (!e.script.started) {
+                e.script.started = true;
+                this.callHook(e, "start");
+            }
+            if (!e.removed && !this.won)
+                this.callHook(e, "update");
+            if (this.won)
+                return;
+        }
+    }
+    /** Calls `touch` on scripted entities that started overlapping or touching another body this frame. */
+    updateTouches() {
+        for (const e of [...this.entities]) {
+            if (!e.script?.module.touch || !e.body || e.removed)
+                continue;
+            const now = new Set();
+            for (const other of this.entities) {
+                if (other !== e && other.body && overlaps(e, other, TOUCH_MARGIN))
+                    now.add(other.id);
+            }
+            for (const id of now) {
+                const other = this.get(id);
+                if (other && !e.script.touching.has(id) && !e.removed && !this.won)
+                    this.callHook(e, "touch", this.handle(other));
+            }
+            e.script.touching = now;
+        }
+    }
+    callHook(entity, hook, other) {
+        const script = entity.script;
+        const fn = script.module[hook];
+        if (!fn)
+            return;
+        const ctx = { self: this.handle(entity), world: this.api(), input: this.scriptInput, params: script.params, dt: FIXED_DT };
+        this.current = { entity, hook };
+        try {
+            fn.call(script.module, ctx, other);
+        }
+        catch (err) {
+            if (err instanceof ScriptError)
+                throw err;
+            const message = err instanceof Error ? err.message : String(err);
+            throw new ScriptError({ src: script.src, entity: entity.id, hook, frame: this.frame }, message, { cause: err });
+        }
+        finally {
+            this.current = undefined;
+        }
+    }
+    /** An error caused by how a script used the API, reported against the running script. */
+    misuse(message) {
+        const running = this.current;
+        return new ScriptError({ src: running?.entity.script?.src ?? "?", entity: running?.entity.id ?? "?", hook: running?.hook ?? "?", frame: this.frame }, message);
     }
+    /** A stable script-facing view of an entity. */
+    handle(e) {
+        let handle = this.handles.get(e);
+        if (handle)
+            return handle;
+        const world = this;
+        handle = {
+            get id() {
+                return e.id;
+            },
+            get x() {
+                return e.transform.x;
+            },
+            set x(value) {
+                e.transform.x = value;
+            },
+            get y() {
+                return e.transform.y;
+            },
+            set y(value) {
+                e.transform.y = value;
+            },
+            get vx() {
+                return e.body?.vx ?? 0;
+            },
+            set vx(value) {
+                if (e.body)
+                    e.body.vx = value;
+            },
+            get vy() {
+                return e.body?.vy ?? 0;
+            },
+            set vy(value) {
+                if (e.body)
+                    e.body.vy = value;
+            },
+            get grounded() {
+                return e.body?.grounded ?? false;
+            },
+            get width() {
+                return e.body?.width ?? e.sprite?.width ?? 0;
+            },
+            get height() {
+                return e.body?.height ?? e.sprite?.height ?? 0;
+            },
+            get exists() {
+                return !e.removed;
+            },
+            get state() {
+                return e.state;
+            },
+            has(component) {
+                return component === "transform" || (component in e && e[component] !== undefined);
+            },
+            touches(other) {
+                const target = world.get(typeof other === "string" ? other : other.id);
+                return !!target && target !== e && !e.removed && overlaps(e, target, TOUCH_MARGIN);
+            },
+        };
+        this.handles.set(e, handle);
+        return handle;
+    }
+    resolve(target) {
+        return this.get(typeof target === "string" ? target : target.id);
+    }
+    /** The `world` object scripts receive. */
+    api() {
+        if (this.scriptApi)
+            return this.scriptApi;
+        const world = this;
+        this.scriptApi = {
+            get time() {
+                return world.time;
+            },
+            get frame() {
+                return world.frame;
+            },
+            get width() {
+                return world.width;
+            },
+            get height() {
+                return world.height;
+            },
+            get score() {
+                return world.score;
+            },
+            set score(value) {
+                world.score = value;
+            },
+            get: (id) => {
+                const e = world.get(id);
+                return e ? world.handle(e) : undefined;
+            },
+            all: (component) => world.entities.filter((e) => !component || world.handle(e).has(component)).map((e) => world.handle(e)),
+            player: () => {
+                const e = world.entities.find((candidate) => candidate.platformer);
+                return e ? world.handle(e) : undefined;
+            },
+            spawn: (def) => world.spawn(def),
+            destroy: (target) => {
+                const e = world.resolve(target);
+                if (e)
+                    world.remove(e);
+            },
+            kill: (target) => {
+                const e = world.resolve(target);
+                if (!e)
+                    return;
+                if (e.platformer && e.body)
+                    world.kill(e, world.current?.entity.id ?? "script");
+                else
+                    world.remove(e);
+            },
+            win: () => {
+                if (world.won)
+                    return;
+                const by = world.current?.entity;
+                world.won = true;
+                world.emit({ type: "win", entity: by?.id ?? "script", goal: by?.id ?? "script", x: by?.transform.x ?? 0, y: by?.transform.y ?? 0 });
+            },
+            emit: (name, data) => {
+                if (typeof name !== "string" || name === "")
+                    throw world.misuse("world.emit needs a non-empty event name.");
+                if (EVENT_TYPES.includes(name)) {
+                    throw world.misuse(`"${name}" is a built-in event and can't be emitted by scripts. Pick another name, e.g. "${name}-custom".`);
+                }
+                const by = world.current?.entity;
+                world.emit({ type: "custom", name, entity: by?.id ?? "script", data, x: by?.transform.x ?? 0, y: by?.transform.y ?? 0 });
+            },
+            random: () => world.random(),
+        };
+        return this.scriptApi;
+    }
+    spawn(def) {
+        if (typeof def !== "object" || def === null || typeof def.components !== "object") {
+            throw this.misuse('world.spawn needs { components: { ... } }, e.g. { components: { transform: { x: 0, y: 0 } } }.');
+        }
+        const id = def.id ?? `${this.current?.entity.id ?? "spawned"}-${++this.spawnCount}`;
+        if (this.get(id))
+            throw this.misuse(`world.spawn: an entity with id "${id}" already exists. Leave id out to get a unique one.`);
+        const { diagnostics } = validateScene({ entities: [{ id, components: def.components }] });
+        const errors = diagnostics.filter((d) => d.severity === "error" && d.code !== "E_GOAL_UNREACHABLE");
+        if (errors.length > 0) {
+            const details = errors.map((d) => `${d.path.replace("entities[0]", id)}: ${d.message}${d.fix ? ` Fix: ${d.fix}` : ""}`);
+            throw this.misuse(`world.spawn got an invalid entity. ${details.join(" ")}`);
+        }
+        const entity = this.createEntity({ id, components: def.components });
+        this.entities.push(entity);
+        return this.handle(entity);
+    }
+    /** mulberry32, seeded by world.seed. */
+    random() {
+        this.seed = (this.seed + 0x6d2b79f5) | 0;
+        let t = this.seed;
+        t = Math.imul(t ^ (t >>> 15), t | 1);
+        t ^= t + Math.imul(t ^ (t >>> 7), t | 61);
+        return ((t ^ (t >>> 14)) >>> 0) / 4294967296;
+    }
+    // ------------------------------------------------------------ built-ins
     players() {
         return this.entities.filter((e) => e.platformer && e.body);
     }
@@ -111,11 +369,15 @@ export class World {
                 b.standingOn = undefined;
                 p.bufferTimer = 0;
                 p.coyoteTimer = 0;
+                p.jumping = true;
                 this.emit({ type: "jump", entity: e.id, ...feet(e) });
             }
-            else if (p.variableJump && !held.has("jump") && b.vy < -p.jumpSpeed * JUMP_CUT) {
+            else if (p.jumping && p.variableJump && !held.has("jump") && b.vy < -p.jumpSpeed * JUMP_CUT) {
+                // Only the player's own jumps are cut short; launches from pads, stomps or scripts are not.
                 b.vy = -p.jumpSpeed * JUMP_CUT;
             }
+            if (b.vy >= 0)
+                p.jumping = false;
             p.coyoteTimer = Math.max(0, p.coyoteTimer - FIXED_DT);
             p.bufferTimer = Math.max(0, p.bufferTimer - FIXED_DT);
         }
@@ -257,12 +519,13 @@ export class World {
         b.standingOn = undefined;
         p.coyoteTimer = 0;
         p.bufferTimer = 0;
+        p.jumping = false;
     }
 }
 function createEntity(def) {
     const c = def.components;
     const transform = c.transform ? resolveComponent("transform", c.transform) : { x: 0, y: 0 };
-    const entity = { id: def.id, transform };
+    const entity = { id: def.id, state: {}, transform };
     if (c.body)
         entity.body = { ...resolveComponent("body", c.body), grounded: false };
     if (c.sprite)
@@ -272,6 +535,7 @@ function createEntity(def) {
             ...resolveComponent("platformer", c.platformer),
             coyoteTimer: 0,
             bufferTimer: 0,
+            jumping: false,
             spawnX: transform.x,
             spawnY: transform.y,
         };
@@ -308,10 +572,13 @@ function isStomp(player, enemy) {
     const enemyTop = enemy.transform.y - enemy.body.height / 2;
     return previousBottom <= enemyTop + STOMP_TOLERANCE;
 }
-/** Strict overlap: bodies that merely touch (e.g. standing on the ground) do not overlap. */
-export function overlaps(a, b) {
+/**
+ * Strict overlap: bodies that merely touch (e.g. standing on the ground) do not overlap.
+ * A positive `margin` grows both boxes, so touching counts too.
+ */
+export function overlaps(a, b, margin = 0) {
     if (!a.body || !b.body)
         return false;
-    return (Math.abs(a.transform.x - b.transform.x) < (a.body.width + b.body.width) / 2 - EPSILON &&
-        Math.abs(a.transform.y - b.transform.y) < (a.body.height + b.body.height) / 2 - EPSILON);
+    return (Math.abs(a.transform.x - b.transform.x) < (a.body.width + b.body.width) / 2 + margin - EPSILON &&
+        Math.abs(a.transform.y - b.transform.y) < (a.body.height + b.body.height) / 2 + margin - EPSILON);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ludra/core",
-  "version": "0.3.1",
+  "version": "0.5.0",
   "description": "Ludra engine runtime: scene format, validation, deterministic simulation and rendering.",
   "license": "MIT",
   "repository": {

package/src/assertions.ts

@@ -1,8 +1,8 @@
 import { InputScript } from "./input.ts";
 import { defaultDuration, simulate } from "./simulate.ts";
 import { FIXED_DT, parseDuration, secondsToFrames } from "./time.ts";
-import { EVENT_TYPES, type GameEventType, type SceneDef } from "./types.ts";
-import { World, type GameEvent, type WorldSnapshot } from "./world.ts";
+import { EVENT_TYPES, type SceneDef } from "./types.ts";
+import { World, type GameEvent, type WorldOptions, type WorldSnapshot } from "./world.ts";
 
 const OPERATORS = ["<=", ">=", "==", "!=", "<", ">"] as const;
 type Operator = (typeof OPERATORS)[number];
@@ -15,14 +15,18 @@ type WorldField = (typeof WORLD_FIELDS)[number];
 
 type Subject =
   | { kind: "world"; field: WorldField }
-  | { kind: "events"; type: GameEventType }
-  | { kind: "entity"; id: string; field: EntityField };
+  /** Built-in event types, or custom events fired by scripts with world.emit(name). */
+  | { kind: "events"; name: string; builtin: boolean }
+  | { kind: "entity"; id: string; field: EntityField }
+  | { kind: "state"; id: string; key: string };
+
+type Value = number | boolean | string;
 
 export interface Assertion {
   source: string;
   subject: Subject;
   operator: Operator;
-  expected: number | boolean;
+  expected: Value;
   /** Frame to check at, or "end" for the last frame of the run. */
   at: number | "end";
 }
@@ -30,7 +34,7 @@ export interface Assertion {
 export class AssertionSyntaxError extends Error {}
 
 const EXAMPLES =
-  'Examples: "player.x > 400", "player.grounded == true at 1s", "score >= 3", "won == true", "deaths == 0", "events.jump == 1 at end", "coin1.exists == false".';
+  'Examples: "player.x > 400", "player.grounded == true at 1s", "score >= 3", "won == true", "deaths == 0", "events.jump == 1 at end", "coin1.exists == false", "door.state.open == true", "boss.state.phase == \\"angry\\"", "events.shoot >= 3".';
 
 /** Parses `<subject> <op> <value> [at <time|end>]`. */
 export function parseAssertion(source: string): Assertion {
@@ -39,29 +43,32 @@ export function parseAssertion(source: string): Assertion {
   const [, lhs = "", operator, rhs = "", at] = match;
 
   let subject: Subject;
+  const stateMatch = /^(.+)\.state\.([\w-]+)$/.exec(lhs);
   if ((WORLD_FIELDS as readonly string[]).includes(lhs)) {
     subject = { kind: "world", field: lhs as WorldField };
-  } else if (lhs.startsWith("events.")) {
-    const type = lhs.slice("events.".length);
-    if (!(EVENT_TYPES as readonly string[]).includes(type)) {
-      throw new AssertionSyntaxError(`Unknown event "${type}" in "${source}". Events: ${EVENT_TYPES.join(", ")}.`);
-    }
-    subject = { kind: "events", type: type as GameEventType };
+  } else if (lhs.startsWith("events.") && lhs.length > "events.".length) {
+    const name = lhs.slice("events.".length);
+    subject = { kind: "events", name, builtin: (EVENT_TYPES as readonly string[]).includes(name) };
+  } else if (stateMatch) {
+    subject = { kind: "state", id: stateMatch[1]!, key: stateMatch[2]! };
   } else {
     const dot = lhs.lastIndexOf(".");
     const field = lhs.slice(dot + 1);
     if (dot <= 0 || !(ENTITY_FIELDS as readonly string[]).includes(field)) {
       throw new AssertionSyntaxError(
-        `"${lhs}" is not something Ludra can check. Use ${WORLD_FIELDS.join(", ")}, events.<${EVENT_TYPES.join("|")}> or <entityId>.<${ENTITY_FIELDS.join("|")}>.`,
+        `"${lhs}" is not something Ludra can check. Use ${WORLD_FIELDS.join(", ")}, events.<name>, <entityId>.<${ENTITY_FIELDS.join("|")}> or <entityId>.state.<key>.`,
       );
     }
     subject = { kind: "entity", id: lhs.slice(0, dot), field: field as EntityField };
   }
 
-  let expected: number | boolean;
+  let expected: Value;
   if (rhs === "true" || rhs === "false") expected = rhs === "true";
+  else if (/^".*"$/.test(rhs)) expected = rhs.slice(1, -1);
   else if (Number.isFinite(Number(rhs))) expected = Number(rhs);
-  else throw new AssertionSyntaxError(`Expected a number or true/false after "${operator}" in "${source}", got "${rhs}".`);
+  else {
+    throw new AssertionSyntaxError(`Expected a number, true/false or a "quoted string" after "${operator}" in "${source}", got ${rhs}.`);
+  }
 
   let frame: number | "end" = "end";
   if (at !== undefined && at !== "end") {
@@ -78,7 +85,7 @@ export function parseAssertion(source: string): Assertion {
 export interface AssertionResult {
   source: string;
   pass: boolean;
-  actual: number | boolean | undefined;
+  actual: unknown;
   time: number;
   message: string;
 }
@@ -86,7 +93,7 @@ export interface AssertionResult {
 export function evaluateAssertion(assertion: Assertion, snapshot: WorldSnapshot, events: readonly GameEvent[]): AssertionResult {
   const { subject, operator, expected, source } = assertion;
   const time = snapshot.time;
-  let actual: number | boolean | undefined;
+  let actual: unknown;
   let label: string;
 
   switch (subject.kind) {
@@ -94,10 +101,30 @@ export function evaluateAssertion(assertion: Assertion, snapshot: WorldSnapshot,
       actual = snapshot[subject.field];
       label = subject.field;
       break;
-    case "events":
-      actual = events.filter((e) => e.type === subject.type && e.frame <= snapshot.frame).length;
-      label = `events.${subject.type}`;
+    case "events": {
+      const matches = (e: GameEvent) => (subject.builtin ? e.type === subject.name : e.type === "custom" && e.name === subject.name);
+      actual = events.filter((e) => matches(e) && e.frame <= snapshot.frame).length;
+      label = `events.${subject.name}`;
+      break;
+    }
+    case "state": {
+      const entity = snapshot.entities[subject.id];
+      label = `${subject.id}.state.${subject.key}`;
+      if (!entity) {
+        return { source, pass: false, actual: undefined, time, message: `entity "${subject.id}" does not exist at ${time.toFixed(2)}s.` };
+      }
+      actual = entity.state?.[subject.key];
+      if (actual === undefined) {
+        return {
+          source,
+          pass: false,
+          actual,
+          time,
+          message: `${label} is not set at ${time.toFixed(2)}s. Scripts set it with self.state.${subject.key} = ...`,
+        };
+      }
       break;
+    }
     case "entity": {
       const entity = snapshot.entities[subject.id];
       label = `${subject.id}.${subject.field}`;
@@ -116,14 +143,20 @@ export function evaluateAssertion(assertion: Assertion, snapshot: WorldSnapshot,
   }
 
   if (typeof actual !== typeof expected) {
-    return { source, pass: false, actual, time, message: `${label} is a ${typeof actual}, but it is compared with ${JSON.stringify(expected)}.` };
+    return {
+      source,
+      pass: false,
+      actual,
+      time,
+      message: `${label} is ${JSON.stringify(actual)} (a ${typeof actual}), but it is compared with ${JSON.stringify(expected)}.`,
+    };
   }
-  if (typeof actual === "boolean" && operator !== "==" && operator !== "!=") {
-    return { source, pass: false, actual, time, message: `${label} is true/false, so only == and != can be used.` };
+  if (typeof actual !== "number" && operator !== "==" && operator !== "!=") {
+    return { source, pass: false, actual, time, message: `${label} is a ${typeof actual}, so only == and != can be used.` };
   }
 
   const pass = compare(actual as number, operator, expected as number);
-  const shown = typeof actual === "number" ? round(actual) : actual;
+  const shown = typeof actual === "number" ? round(actual) : JSON.stringify(actual);
   return { source, pass, actual, time, message: `${label} = ${shown} at ${time.toFixed(2)}s` };
 }
 
@@ -166,7 +199,7 @@ export interface TestResult {
   error?: string;
 }
 
-export function runTest(scene: SceneDef, test: TestCase): TestResult {
+export function runTest(scene: SceneDef, test: TestCase, options: WorldOptions = {}): TestResult {
   let script: InputScript;
   let assertions: Assertion[];
   let frames: number;
@@ -187,10 +220,16 @@ export function runTest(scene: SceneDef, test: TestCase): TestResult {
 
   const wanted = new Set(assertions.map((a) => (a.at === "end" ? frames : Math.min(a.at, frames))));
   const snapshots = new Map<number, WorldSnapshot>();
-  const world = new World(scene);
-  simulate(world, script, frames, (w) => {
-    if (wanted.has(w.frame)) snapshots.set(w.frame, w.snapshot());
-  });
+  let world: World;
+  try {
+    world = new World(scene, options);
+    simulate(world, script, frames, (w) => {
+      if (wanted.has(w.frame)) snapshots.set(w.frame, w.snapshot());
+    });
+  } catch (err) {
+    // A throwing script fails this test, not the whole run.
+    return { name: test.name, pass: false, duration: frames * FIXED_DT, results: [], error: (err as Error).message };
+  }
 
   const results = assertions.map((a) => {
     const frame = a.at === "end" ? frames : Math.min(a.at, frames);