@forgeax/engine-state 0.0.0-dev.8d955ade1c79

package/src/set-next-state.ts

@@ -0,0 +1,101 @@
+// @forgeax/engine-state -- setNextState / getState / getPreviousState (M2 / m2w4)
+//
+// Free functions that read and write per-token Resource slots. All return
+// Result<T, StateError> (never throw for AI-user call sites per AGENTS.md
+// Error model).
+//
+// Decision anchors:
+// - requirements C-3: setNextState returns Result.err, not throw
+// - requirements C-4: free functions, not world.x methods
+// - requirements F-5/F-6: State / NextState / PreviousState as Resources
+// - plan-strategy D-4: State stores variant index (u32), decoded via token.variants
+
+import type { World } from '@forgeax/engine-ecs';
+import { err, ok, type Result } from '@forgeax/engine-types';
+import type { StateToken, StateTokenVariant } from './define-state';
+import type { StateError } from './errors';
+import { invalidVariant, stateNotRegistered } from './errors';
+import { nextStateResourceKey, previousStateResourceKey, stateResourceKey } from './resources';
+
+interface NextStatePayload {
+  value: number;
+  force: boolean;
+}
+
+/**
+ * Request a state transition for `token` to `variant` at the next frame.
+ *
+ * `variant` is narrowed to the token's variant union: a misspelled variant is
+ * a compile-time error (`StateTokenVariant<T>`), not just a runtime
+ * `invalid-variant` Result.
+ */
+export function setNextState<T extends StateToken>(
+  world: World,
+  token: T,
+  variant: StateTokenVariant<T>,
+): Result<void, StateError> {
+  return _runCheckAndWrite(world, token, variant, false);
+}
+
+/**
+ * Like {@link setNextState} but with `force=true`.
+ */
+export function setNextStateForce<T extends StateToken>(
+  world: World,
+  token: T,
+  variant: StateTokenVariant<T>,
+): Result<void, StateError> {
+  return _runCheckAndWrite(world, token, variant, true);
+}
+
+function _runCheckAndWrite(
+  world: World,
+  token: StateToken,
+  variant: string,
+  force: boolean,
+): Result<void, StateError> {
+  const nsKey = nextStateResourceKey(token);
+  if (!world.hasResource(nsKey)) {
+    return err(stateNotRegistered(token.name));
+  }
+
+  const idx = token.nameToIdx.get(variant as never);
+  if (idx === undefined) {
+    return err(invalidVariant(token.name, variant, token.variants));
+  }
+
+  world.insertResource<NextStatePayload>(nsKey, { value: idx, force });
+  return ok(undefined);
+}
+
+/**
+ * Read the current state value for `token`.
+ */
+export function getState(world: World, token: StateToken): Result<string, StateError> {
+  const key = stateResourceKey(token);
+  if (!world.hasResource(key)) {
+    return err(stateNotRegistered(token.name));
+  }
+  const idx = world.getResource<number>(key);
+  const variant = token.variants[idx];
+  if (variant === undefined) {
+    return err(invalidVariant(token.name, String(idx), token.variants));
+  }
+  return ok(variant);
+}
+
+/**
+ * Read the previous-frame state value for `token`.
+ */
+export function getPreviousState(world: World, token: StateToken): Result<string, StateError> {
+  const key = previousStateResourceKey(token);
+  if (!world.hasResource(key)) {
+    return err(stateNotRegistered(token.name));
+  }
+  const idx = world.getResource<number>(key);
+  const variant = token.variants[idx];
+  if (variant === undefined) {
+    return err(invalidVariant(token.name, String(idx), token.variants));
+  }
+  return ok(variant);
+}

package/src/transition-system.ts

@@ -0,0 +1,153 @@
+// @forgeax/engine-state -- transitionStatesSystem (M3 / m3w4)
+//
+// 8-step per-token transition logic executed every frame by the
+// 'transitionStates' system registered in registerStatesPlugin.
+//
+// Per token:
+//   1. Read NextState Resource; if undefined -> continue (zero-cost skip)
+//   2. Read State Resource; if prev===next && !force -> clear NextState, continue (same-state no-op)
+//   3. Write PreviousState = prev, flip State = next
+//   4. Collect exit-scoped entities -> world.despawn each
+//   5. OnExit placeholder (M4)
+//   6. Collect enter-scoped entities -> world.despawn each
+//   7. OnEnter placeholder (M4)
+//   8. Clear NextState = undefined
+//
+// Decision anchors:
+// - plan-strategy sec 3.2: 8-step flowchart + OnEnter/OnExit dispatch between flip and despawn
+// - plan-strategy D-2: unified world.despawn via linkedSpawn cascade
+// - plan-strategy D-5: fn[] registry + transition body dispatch, zero ECS change
+// - research F-6: row iteration + world.despawn is sufficient
+// - requirements sec 7: despawn tolerance (entity already dead = no error)
+
+import type { Component, EntityHandle, World } from '@forgeax/engine-ecs';
+import { worldDespawnScene } from '@forgeax/engine-scene';
+import { getRegisteredTokens } from './define-state';
+import { getCallbacks, OnEnter, OnExit } from './on-enter-on-exit';
+import { nextStateResourceKey, previousStateResourceKey, stateResourceKey } from './resources';
+import { SCOPED_MODE_VALUE } from './scoped-component';
+
+interface NextStatePayload {
+  value: number;
+  force: boolean;
+}
+
+/**
+ * Collect entities whose ScopedTo component matches a given mode and value,
+ * then despawn all of them. Single despawn fault (already-dead entity) does
+ * not abort the batch — despawn tolerance per requirements sec 7.
+ *
+ * A scoped entity that is a SceneInstance root is torn down with `despawnScene`
+ * (cascade over its instantiated members), NOT plain `world.despawn`. Plain
+ * despawn does not cascade through `ChildOf` (which ships `linkedSpawn=false`),
+ * so a scoped scene root would orphan every member entity it instantiated. On a
+ * state replay (e.g. Title->Play->Title->Play) those orphans linger, their index
+ * slots are reused at a new generation, and a surviving member's stale
+ * `ChildOf -> (oldRoot, oldGen)` makes `propagateTransforms` throw
+ * `hierarchy-broken` every frame. Cascading via `despawnScene` removes the whole
+ * instantiated subtree so nothing is left pointing at the dead root.
+ */
+function scopeDespawn(world: World, scopedComponent: Component, mode: number, value: number): void {
+  const query = world.query({ read: [scopedComponent] }).unwrap();
+  const despawns: EntityHandle[] = [];
+  for (const row of query) {
+    const scoped = row.get(scopedComponent);
+    if (scoped.mode === mode && scoped.value === value) despawns.push(row.entity);
+  }
+  // SceneInstance is resolved by name through the global registry so the state
+  // package stays free of a runtime dependency (layering: state -> ecs only).
+  const sceneInstance = world.components.resolve('SceneInstance');
+  // Tear down SceneInstance roots FIRST, via despawnScene (cascade over their
+  // instantiated members). This must precede the plain despawns: a scoped scene
+  // root is often ChildOf a scoped non-scene entity (e.g. a character rig parented
+  // under a KCC body), and despawning that parent first invalidates the root
+  // handle before we can cascade it -- leaving the scene's members orphaned with a
+  // stale ChildOf -> dead-root ref. Doing the cascades up front guarantees each
+  // SceneInstance subtree is fully removed while its root is still live.
+  if (sceneInstance !== undefined) {
+    for (const e of despawns) {
+      if (world.get(e, sceneInstance).ok) worldDespawnScene(world, e);
+    }
+  }
+  for (const e of despawns) {
+    // Scene roots already torn down above are now dead -> world.despawn is a
+    // tolerated no-op (requirements sec 7); every other scoped entity despawns here.
+    world.despawn(e);
+  }
+}
+
+export function transitionStatesSystem(world: World): void {
+  for (const token of getRegisteredTokens().values()) {
+    const nsKey = nextStateResourceKey(token);
+
+    // (0) Skip tokens with no Resources yet. getRegisteredTokens() returns every
+    // token ever defined, but registerStatesPlugin only inserts Resources for
+    // tokens known at plugin time. A token defined after the plugin ran has no
+    // NextState Resource; world.getResource would throw ResourceNotFoundError.
+    // hasResource guard mirrors setNextState / getState in this package.
+    if (!world.hasResource(nsKey)) continue;
+    const ns = world.getResource<NextStatePayload | undefined>(nsKey);
+
+    // (1) No pending transition — zero-cost continue
+    if (ns === undefined) continue;
+
+    const sKey = stateResourceKey(token);
+    const prevIdx = world.getResource<number>(sKey);
+    const nextIdx = ns.value;
+    const force = ns.force;
+
+    // (2) Same-state no-op (unless force flag overrides)
+    if (prevIdx === nextIdx && !force) {
+      world.insertResource<NextStatePayload | undefined>(nsKey, undefined);
+      continue;
+    }
+
+    // (3) Write PreviousState = prev, flip State = next
+    const psKey = previousStateResourceKey(token);
+    world.insertResource(psKey, prevIdx);
+    world.insertResource(sKey, nextIdx);
+
+    // Resolve the per-token ScopedTo component from the global ECS registry
+    const scopedComponent = world.components.resolve(`__scopedTo__${token.name}`);
+    if (scopedComponent) {
+      // (4) Despawn exit-scoped entities (value=prev)
+      scopeDespawn(world, scopedComponent, SCOPED_MODE_VALUE.exit, prevIdx);
+
+      // (5) OnExit dispatch: fire registered callbacks for prev variant.
+      // Errors bubble to the transitionStatesSystem call stack per req §7.
+      const prevVariant = token.variants[prevIdx];
+      if (prevVariant !== undefined) {
+        const exitLabel = OnExit(token, prevVariant);
+        for (const fn of getCallbacks(exitLabel)) {
+          fn(world);
+        }
+      }
+
+      // (6) Despawn enter-scoped entities (value=next)
+      scopeDespawn(world, scopedComponent, SCOPED_MODE_VALUE.enter, nextIdx);
+
+      // (7) OnEnter dispatch: fire registered callbacks for next variant.
+      // Errors bubble to the transitionStatesSystem call stack per req §7.
+      const nextVariant = token.variants[nextIdx];
+      if (nextVariant !== undefined) {
+        const enterLabel = OnEnter(token, nextVariant);
+        for (const fn of getCallbacks(enterLabel)) {
+          fn(world);
+        }
+      }
+    }
+
+    // (8) Clear NextState — but only if OnEnter callbacks did not already
+    // write a new NextState payload (e.g. nested setNextState). If the
+    // payload differs from the original `ns`, leave it for the next frame.
+    const nsAfterCallbacks = world.getResource<NextStatePayload | undefined>(nsKey);
+    if (
+      nsAfterCallbacks !== undefined &&
+      nsAfterCallbacks.value === ns.value &&
+      nsAfterCallbacks.force === ns.force
+    ) {
+      world.insertResource<NextStatePayload | undefined>(nsKey, undefined);
+    }
+    // else: callbacks wrote a new NextState — survive for next frame
+  }
+}