@rpgjs/client 5.0.0-beta.2 → 5.0.0-beta.20

package/src/Game/ProjectileManager.ts

@@ -0,0 +1,346 @@
+import { computed, signal } from "canvasengine";
+import { Hooks } from "@rpgjs/common";
+import { normalizeRoomMapId } from "../utils/mapId";
+
+export interface ClientProjectileSpawn {
+  id: string;
+  type: string;
+  ownerId?: string;
+  origin: { x: number; y: number };
+  direction: { x: number; y: number };
+  speed: number;
+  range: number;
+  ttl: number;
+  spawnTick: number;
+  delay?: number;
+  index?: number;
+  count?: number;
+  params?: Record<string, unknown>;
+  collisionMask?: number;
+  ignoreOwner?: boolean;
+  predictImpact?: boolean;
+}
+
+export interface ClientProjectileImpact {
+  id: string;
+  targetId?: string;
+  x: number;
+  y: number;
+  distance?: number;
+}
+
+export interface ClientProjectileDestroy {
+  id: string;
+  reason?: string;
+  targetId?: string;
+  x?: number;
+  y?: number;
+  distance?: number;
+}
+
+export interface RenderedProjectileProps extends ClientProjectileSpawn {
+  x: number;
+  y: number;
+  angle: number;
+  distance: number;
+  elapsed: number;
+  progress: number;
+  impact?: ClientProjectileImpact;
+  impactElapsed?: number;
+  impactProgress?: number;
+  destroyed?: boolean;
+}
+
+export interface RenderedProjectile {
+  id: string;
+  type: string;
+  component: any;
+  props: RenderedProjectileProps;
+}
+
+export type ProjectilePredictionResolver = (
+  projectile: ClientProjectileSpawn,
+) => ClientProjectileImpact | null | undefined;
+
+export interface ProjectileSpawnClock {
+  now?: number;
+  currentServerTick?: number;
+  tickDurationMs?: number;
+  mapId?: string;
+}
+
+interface RuntimeProjectile {
+  spawn: ClientProjectileSpawn;
+  component: any;
+  createdAt: number;
+  impact?: ClientProjectileImpact;
+  visualImpact?: ClientProjectileImpact;
+  predictedImpact?: ClientProjectileImpact;
+  impactStartedAt?: number;
+  destroyAt?: number;
+  destroyReason?: string;
+}
+
+export class ProjectileManager {
+  private readonly components = new Map<string, any>();
+  private readonly projectiles = new Map<string, RuntimeProjectile>();
+  private readonly version = signal(0);
+  private readonly impactDurationMs = 350;
+  private mapId?: string;
+
+  constructor(
+    private readonly hooks: Hooks,
+    private readonly predictionResolver?: ProjectilePredictionResolver,
+  ) {}
+
+  current = computed<RenderedProjectile[]>(() => {
+    this.version();
+    const now = Date.now();
+    const rendered: RenderedProjectile[] = [];
+    for (const projectile of this.projectiles.values()) {
+      const props = this.toProps(projectile, now);
+      if (!props) {
+        continue;
+      }
+      rendered.push({
+        id: projectile.spawn.id,
+        type: projectile.spawn.type,
+        component: projectile.component,
+        props,
+      });
+    }
+    return rendered;
+  });
+
+  register(type: string, component: any): any {
+    this.components.set(type, component);
+    return component;
+  }
+
+  get(type: string): any {
+    return this.components.get(type);
+  }
+
+  setMapId(mapId: string | undefined): void {
+    const normalizedMapId = normalizeRoomMapId(mapId);
+    if (this.mapId === normalizedMapId) return;
+    this.mapId = normalizedMapId;
+    this.clear();
+  }
+
+  getMapId(): string | undefined {
+    return this.mapId;
+  }
+
+  spawnBatch(projectiles: ClientProjectileSpawn[], clock: ProjectileSpawnClock = {}): void {
+    if (!this.acceptsMap(clock.mapId)) return;
+    const now = clock.now ?? Date.now();
+    for (const projectile of projectiles) {
+      const component = this.components.get(projectile.type);
+      if (!component) {
+        continue;
+      }
+      const runtime: RuntimeProjectile = {
+        spawn: {
+          ...projectile,
+          delay: projectile.delay ?? 0,
+          index: projectile.index ?? 0,
+          count: projectile.count ?? 1,
+        },
+        component,
+        createdAt: now,
+      };
+      this.setPredictedImpact(runtime);
+      this.projectiles.set(projectile.id, runtime);
+      this.hooks.callHooks("client-projectiles-onSpawn", runtime.spawn).subscribe();
+    }
+    this.touch();
+  }
+
+  impactBatch(impacts: ClientProjectileImpact[], context: { mapId?: string } = {}): void {
+    if (!this.acceptsMap(context.mapId)) return;
+    const now = Date.now();
+    for (const impact of impacts) {
+      const projectile = this.projectiles.get(impact.id);
+      if (!projectile) {
+        continue;
+      }
+      this.setImpact(projectile, impact, now);
+      this.hooks.callHooks("client-projectiles-onImpact", this.toProps(projectile, now)).subscribe();
+    }
+    this.touch();
+  }
+
+  destroyBatch(projectiles: ClientProjectileDestroy[], context: { mapId?: string } = {}): void {
+    if (!this.acceptsMap(context.mapId)) return;
+    const now = Date.now();
+    for (const destroyed of projectiles) {
+      const projectile = this.projectiles.get(destroyed.id);
+      if (!projectile) {
+        continue;
+      }
+      if (destroyed.reason === "hit") {
+        const current = this.toProps(projectile, now);
+        this.setImpact(projectile, {
+          id: destroyed.id,
+          targetId: destroyed.targetId ?? projectile.impact?.targetId,
+          x: destroyed.x ?? projectile.impact?.x ?? current?.x ?? projectile.spawn.origin.x,
+          y: destroyed.y ?? projectile.impact?.y ?? current?.y ?? projectile.spawn.origin.y,
+          distance: destroyed.distance ?? projectile.impact?.distance ?? current?.distance,
+        }, now);
+      }
+      projectile.destroyReason = destroyed.reason;
+      projectile.destroyAt = projectile.destroyAt ?? (
+        projectile.impact && projectile.impactStartedAt !== undefined
+          ? projectile.impactStartedAt + this.impactDurationMs
+          : now
+      );
+      this.hooks.callHooks("client-projectiles-onDestroy", this.toProps(projectile, now)).subscribe();
+    }
+    this.touch();
+  }
+
+  clear(): void {
+    this.projectiles.clear();
+    this.touch();
+  }
+
+  step(): void {
+    const now = Date.now();
+    let changed = false;
+    for (const [id, projectile] of this.projectiles) {
+      const props = this.toProps(projectile, now);
+      if (
+        (!props && !this.isWaitingForDelay(projectile, now)) ||
+        (projectile.destroyAt !== undefined && now >= projectile.destroyAt)
+      ) {
+        this.projectiles.delete(id);
+        changed = true;
+      }
+    }
+    this.touch(changed || this.projectiles.size > 0);
+  }
+
+  private toProps(projectile: RuntimeProjectile, now: number): RenderedProjectileProps | null {
+    const spawn = projectile.spawn;
+    const delayMs = (spawn.delay ?? 0) * 1000;
+    const elapsedMs = now - projectile.createdAt - delayMs;
+    if (elapsedMs < 0) {
+      return null;
+    }
+    const elapsed = elapsedMs / 1000;
+    const ttl = Math.max(0.001, spawn.ttl);
+    const rawDistance = Math.min(spawn.speed * elapsed, spawn.range);
+    const predictedImpact = this.getActivePredictedImpact(projectile, now, rawDistance);
+    const visualImpact = projectile.visualImpact ?? projectile.impact;
+    const distance = visualImpact?.distance ?? predictedImpact?.distance ?? rawDistance;
+    const progress = Math.min(1, distance / spawn.range);
+    const x = visualImpact?.x ?? predictedImpact?.x ?? spawn.origin.x + spawn.direction.x * distance;
+    const y = visualImpact?.y ?? predictedImpact?.y ?? spawn.origin.y + spawn.direction.y * distance;
+    const impactElapsedMs = projectile.impactStartedAt !== undefined
+      ? Math.max(0, now - projectile.impactStartedAt)
+      : undefined;
+    return {
+      ...spawn,
+      x,
+      y,
+      angle: Math.atan2(spawn.direction.y, spawn.direction.x),
+      distance,
+      elapsed,
+      progress,
+      impact: projectile.impact,
+      impactElapsed: impactElapsedMs === undefined ? undefined : impactElapsedMs / 1000,
+      impactProgress: impactElapsedMs === undefined
+        ? undefined
+        : Math.min(1, impactElapsedMs / this.impactDurationMs),
+      destroyed: projectile.destroyAt !== undefined,
+      ttl,
+    };
+  }
+
+  private acceptsMap(mapId: string | undefined): boolean {
+    const normalizedMapId = normalizeRoomMapId(mapId);
+    return !normalizedMapId || !this.mapId || normalizedMapId === this.mapId;
+  }
+
+  private isWaitingForDelay(projectile: RuntimeProjectile, now: number): boolean {
+    const delayMs = (projectile.spawn.delay ?? 0) * 1000;
+    return now - projectile.createdAt - delayMs < 0;
+  }
+
+  private setPredictedImpact(projectile: RuntimeProjectile): void {
+    if (projectile.spawn.predictImpact === false) {
+      return;
+    }
+    const impact = this.predictionResolver?.(projectile.spawn);
+    if (!impact || !Number.isFinite(impact.x) || !Number.isFinite(impact.y)) {
+      return;
+    }
+    const distance = typeof impact.distance === "number" && Number.isFinite(impact.distance)
+      ? impact.distance
+      : Math.hypot(impact.x - projectile.spawn.origin.x, impact.y - projectile.spawn.origin.y);
+    if (!Number.isFinite(distance) || distance < 0 || distance > projectile.spawn.range) {
+      return;
+    }
+    projectile.predictedImpact = {
+      ...impact,
+      distance,
+    };
+  }
+
+  private getActivePredictedImpact(
+    projectile: RuntimeProjectile,
+    now: number,
+    rawDistance: number,
+  ): ClientProjectileImpact | undefined {
+    if (!projectile.predictedImpact || projectile.impact) {
+      return undefined;
+    }
+    const distance = projectile.predictedImpact.distance;
+    if (distance === undefined || rawDistance < distance) {
+      return undefined;
+    }
+    return projectile.predictedImpact;
+  }
+
+  private setImpact(projectile: RuntimeProjectile, impact: ClientProjectileImpact, now: number): void {
+    projectile.visualImpact = this.resolveVisualImpact(projectile, impact, now);
+    projectile.impact = impact;
+    projectile.predictedImpact = undefined;
+    projectile.impactStartedAt = projectile.impactStartedAt ?? now;
+    const impactDestroyAt = projectile.impactStartedAt + this.impactDurationMs;
+    projectile.destroyAt = Math.max(projectile.destroyAt ?? 0, impactDestroyAt);
+  }
+
+  private resolveVisualImpact(
+    projectile: RuntimeProjectile,
+    impact: ClientProjectileImpact,
+    now: number,
+  ): ClientProjectileImpact {
+    const predicted = projectile.predictedImpact;
+    if (!predicted || !this.isSameTarget(predicted, impact)) {
+      return impact;
+    }
+    const distance = predicted.distance;
+    if (distance === undefined) {
+      return impact;
+    }
+    const delayMs = (projectile.spawn.delay ?? 0) * 1000;
+    const elapsedMs = now - projectile.createdAt - delayMs;
+    if (elapsedMs < 0) {
+      return impact;
+    }
+    const rawDistance = Math.min(projectile.spawn.speed * (elapsedMs / 1000), projectile.spawn.range);
+    return rawDistance >= distance ? predicted : impact;
+  }
+
+  private isSameTarget(a: ClientProjectileImpact, b: ClientProjectileImpact): boolean {
+    return a.targetId !== undefined && a.targetId === b.targetId;
+  }
+
+  private touch(force = true): void {
+    if (force) {
+      this.version.update((value) => value + 1);
+    }
+  }
+}

package/src/Gui/Gui.spec.ts

@@ -0,0 +1,340 @@
+import { describe, expect, test, vi } from "vitest";
+import { Context, injector } from "@signe/di";
+import { signal } from "canvasengine";
+import { PrebuiltGui } from "@rpgjs/common";
+import { WebSocketToken } from "../services/AbstractSocket";
+
+vi.mock("../components/gui", () => {
+  const component = () => null;
+  return {
+    DialogboxComponent: component,
+    ShopComponent: component,
+    SaveLoadComponent: component,
+    MainMenuComponent: component,
+    NotificationComponent: component,
+    TitleScreenComponent: component,
+    GameoverComponent: component,
+  };
+});
+
+const createGui = async () => {
+  const { RpgGui } = await import("./Gui");
+  const context = new Context();
+  const socket = {
+    on: vi.fn(),
+    emit: vi.fn(),
+  };
+  await injector(context, [
+    {
+      provide: WebSocketToken,
+      useValue: socket,
+    },
+  ]);
+  return {
+    gui: new RpgGui(context),
+    socket,
+  };
+};
+
+const CanvasGui = () => null;
+const VueInventory = {
+  name: "inventory",
+  render() {
+    return null;
+  },
+};
+const VueDialog = {
+  name: PrebuiltGui.Dialog,
+  render() {
+    return null;
+  },
+};
+const VueMainMenu = {
+  name: PrebuiltGui.MainMenu,
+  render() {
+    return null;
+  },
+};
+const VueTooltip = {
+  name: "tooltip",
+  rpgAttachToSprite: true,
+  render() {
+    return null;
+  },
+};
+
+describe("RpgGui Vue integration", () => {
+  test("tracks GUI open ids and sends them back when closing", async () => {
+    const { gui, socket } = await createGui();
+    await gui._initialize();
+    const openHandler = socket.on.mock.calls.find(([event]) => event === "gui.open")?.[1];
+
+    openHandler({
+      guiId: PrebuiltGui.Dialog,
+      guiOpenId: "open-1",
+      data: { message: "Hello" },
+    });
+
+    expect(gui.get(PrebuiltGui.Dialog)?.openId).toBe("open-1");
+
+    gui.guiClose(PrebuiltGui.Dialog, 0, gui.get(PrebuiltGui.Dialog)?.openId);
+
+    expect(socket.emit).toHaveBeenCalledWith("gui.exit", {
+      guiId: PrebuiltGui.Dialog,
+      guiOpenId: "open-1",
+      data: 0,
+    });
+  });
+
+  test("does not emit malformed GUI open ids", async () => {
+    const { gui, socket } = await createGui();
+
+    gui.guiClose(PrebuiltGui.Dialog, 0, (() => "open-1") as any);
+
+    expect(socket.emit).toHaveBeenCalledWith("gui.exit", {
+      guiId: PrebuiltGui.Dialog,
+      guiOpenId: undefined,
+      data: 0,
+    });
+  });
+
+  test("ignores stale server close events for previous GUI opens", async () => {
+    const { gui, socket } = await createGui();
+    await gui._initialize();
+    const openHandler = socket.on.mock.calls.find(([event]) => event === "gui.open")?.[1];
+    const exitHandler = socket.on.mock.calls.find(([event]) => event === "gui.exit")?.[1];
+
+    openHandler({
+      guiId: PrebuiltGui.Dialog,
+      guiOpenId: "open-1",
+      data: { message: "First" },
+    });
+    openHandler({
+      guiId: PrebuiltGui.Dialog,
+      guiOpenId: "open-2",
+      data: { message: "Second" },
+    });
+
+    exitHandler({
+      guiId: PrebuiltGui.Dialog,
+      guiOpenId: "open-1",
+    });
+
+    expect(gui.isDisplaying(PrebuiltGui.Dialog)).toBe(true);
+    expect(gui.get(PrebuiltGui.Dialog)?.data()).toEqual({ message: "Second" });
+
+    exitHandler({
+      guiId: PrebuiltGui.Dialog,
+      guiOpenId: "open-2",
+    });
+
+    expect(gui.isDisplaying(PrebuiltGui.Dialog)).toBe(false);
+  });
+
+  test("separates CanvasEngine and Vue GUI registries", async () => {
+    const { gui } = await createGui();
+
+    gui.add({
+      id: "canvas-tooltip",
+      component: CanvasGui,
+      attachToSprite: true,
+    });
+    gui.add({
+      id: "inventory",
+      component: VueInventory,
+    });
+    gui.add(VueTooltip);
+
+    expect(gui.get("canvas-tooltip")?.component).toBe(CanvasGui);
+    expect(gui.get("inventory")?.component).toBe(VueInventory);
+    expect(gui.get("tooltip")?.component).toBe(VueTooltip);
+    expect(gui.getAttachedGuis().map(item => item.name)).toEqual(["canvas-tooltip"]);
+    expect(gui.getAttachedVueGuis().map(item => item.name)).toEqual(["tooltip"]);
+  });
+
+  test("synchronizes Vue GUI display and hide states through the Vue bridge", async () => {
+    const { gui } = await createGui();
+    const bridge = {
+      updateGuiState: vi.fn(),
+      initializeGuiStates: vi.fn(),
+    };
+
+    gui.add({
+      id: "inventory",
+      component: VueInventory,
+    });
+    gui._setVueGuiInstance(bridge);
+
+    expect(bridge.initializeGuiStates).toHaveBeenCalledWith([
+      expect.objectContaining({
+        name: "inventory",
+        display: false,
+        data: {},
+        attachToSprite: false,
+      }),
+    ]);
+
+    gui.display("inventory", { gold: 12 });
+    expect(bridge.updateGuiState).toHaveBeenLastCalledWith(
+      expect.objectContaining({
+        name: "inventory",
+        display: true,
+        data: { gold: 12 },
+        attachToSprite: false,
+      }),
+    );
+
+    gui.hide("inventory");
+    expect(bridge.updateGuiState).toHaveBeenLastCalledWith(
+      expect.objectContaining({
+        name: "inventory",
+        display: false,
+      }),
+    );
+  });
+
+  test("waits for Vue GUI dependencies before display", async () => {
+    const { gui } = await createGui();
+    const bridge = {
+      updateGuiState: vi.fn(),
+      initializeGuiStates: vi.fn(),
+    };
+    const dependency = signal<any>(undefined);
+
+    gui.add({
+      id: "inventory",
+      component: VueInventory,
+      dependencies: () => [dependency],
+    });
+    gui._setVueGuiInstance(bridge);
+    gui.display("inventory", { items: ["potion"] });
+
+    expect(gui.isDisplaying("inventory")).toBe(false);
+    expect(bridge.updateGuiState).not.toHaveBeenCalledWith(
+      expect.objectContaining({
+        display: true,
+      }),
+    );
+
+    dependency.set({ id: "player" });
+
+    expect(gui.isDisplaying("inventory")).toBe(true);
+    expect(bridge.updateGuiState).toHaveBeenLastCalledWith(
+      expect.objectContaining({
+        name: "inventory",
+        display: true,
+        data: { items: ["potion"] },
+      }),
+    );
+  });
+
+  test("allows Vue GUI entries to replace prebuilt CanvasEngine GUIs", async () => {
+    const { gui } = await createGui();
+    const bridge = {
+      updateGuiState: vi.fn(),
+      initializeGuiStates: vi.fn(),
+    };
+
+    gui._setVueGuiInstance(bridge);
+    gui.add({
+      id: PrebuiltGui.Dialog,
+      component: VueDialog,
+    });
+
+    expect(gui.get(PrebuiltGui.Dialog)?.component).toBe(VueDialog);
+    expect(gui.getAll()[PrebuiltGui.Dialog].component).toBe(VueDialog);
+    expect((gui as any).gui()[PrebuiltGui.Dialog]).toBeUndefined();
+    expect(gui.getVueGuis().filter(item => item.name === PrebuiltGui.Dialog)).toHaveLength(1);
+
+    gui.display(PrebuiltGui.Dialog, { text: "Hello" });
+    expect(bridge.updateGuiState).toHaveBeenLastCalledWith(
+      expect.objectContaining({
+        name: PrebuiltGui.Dialog,
+        display: true,
+        data: { text: "Hello" },
+      }),
+    );
+
+    gui.hide(PrebuiltGui.Dialog);
+    expect(bridge.updateGuiState).toHaveBeenLastCalledWith(
+      expect.objectContaining({
+        name: PrebuiltGui.Dialog,
+        display: false,
+      }),
+    );
+  });
+
+  test("allows CanvasEngine GUI entries to replace Vue GUI entries with the same id", async () => {
+    const { gui } = await createGui();
+    const bridge = {
+      updateGuiState: vi.fn(),
+      initializeGuiStates: vi.fn(),
+    };
+
+    gui._setVueGuiInstance(bridge);
+    gui.add({
+      id: PrebuiltGui.Dialog,
+      component: VueDialog,
+    });
+    gui.add({
+      id: PrebuiltGui.Dialog,
+      component: CanvasGui,
+    });
+
+    expect(gui.get(PrebuiltGui.Dialog)?.component).toBe(CanvasGui);
+    expect(gui.getVueGuis().some(item => item.name === PrebuiltGui.Dialog)).toBe(false);
+    expect((gui as any).gui()[PrebuiltGui.Dialog].component).toBe(CanvasGui);
+    expect(bridge.initializeGuiStates).toHaveBeenLastCalledWith([]);
+  });
+
+  test("keeps main menu optimistic reducers when a Vue GUI replaces the prebuilt component", async () => {
+    const { gui, socket } = await createGui();
+    const bridge = {
+      updateGuiState: vi.fn(),
+      initializeGuiStates: vi.fn(),
+    };
+
+    gui.add({
+      id: PrebuiltGui.MainMenu,
+      component: VueMainMenu,
+    });
+    gui._setVueGuiInstance(bridge);
+    gui.display(PrebuiltGui.MainMenu, {
+      items: [
+        {
+          id: "potion",
+          quantity: 2,
+        },
+      ],
+    });
+
+    gui.guiInteraction(PrebuiltGui.MainMenu, "useItem", { id: "potion" });
+
+    expect(gui.get(PrebuiltGui.MainMenu)?.data().items).toEqual([
+      {
+        id: "potion",
+        quantity: 1,
+      },
+    ]);
+    expect(bridge.updateGuiState).toHaveBeenLastCalledWith(
+      expect.objectContaining({
+        name: PrebuiltGui.MainMenu,
+        data: {
+          items: [
+            {
+              id: "potion",
+              quantity: 1,
+            },
+          ],
+        },
+      }),
+    );
+    expect(socket.emit).toHaveBeenCalledWith(
+      "gui.interaction",
+      expect.objectContaining({
+        guiId: PrebuiltGui.MainMenu,
+        name: "useItem",
+      }),
+    );
+  });
+});