@jgengine/react 0.9.0 → 0.11.0

package/dist/gameViewport.js

@@ -0,0 +1,356 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+/**
+ * Shared mobile-composition runtime. `GameViewportProvider` allocates the live
+ * game viewport once — tracking `visualViewport`, safe-area insets, orientation
+ * and layout mode — and hosts a registry every UI subsystem publishes its
+ * occupied rectangle to. HUD panels, touch-control zones, and system chrome all
+ * register here so the engine can detect forbidden overlaps instead of each
+ * subsystem independently claiming an edge.
+ */
+import { createContext, useContext, useEffect, useMemo, useRef, useState, useSyncExternalStore, } from "react";
+import { computeGameplayRect, detectLayoutCollisions, formatLayoutCollisions, resolveLayoutMode, orientationOf, } from "@jgengine/core/ui/gameLayout";
+import { useDisplayProfile } from "./display.js";
+function sameRect(a, b) {
+    return a.left === b.left && a.top === b.top && a.right === b.right && a.bottom === b.bottom;
+}
+function sameRegion(a, b) {
+    return (a.kind === b.kind &&
+        a.collisionPolicy === b.collisionPolicy &&
+        a.priority === b.priority &&
+        a.collisionGroup === b.collisionGroup &&
+        a.element === b.element &&
+        (a.allowOverlapWith ?? []).join("+") === (b.allowOverlapWith ?? []).join("+") &&
+        sameRect(a.rect, b.rect));
+}
+const EMPTY_REGIONS = [];
+function createRegionRegistry() {
+    const records = new Map();
+    const listeners = new Set();
+    let snapshot = EMPTY_REGIONS;
+    let frame = 0;
+    const flush = () => {
+        frame = 0;
+        for (const listener of [...listeners])
+            listener();
+    };
+    const emit = () => {
+        snapshot = [...records.values()];
+        if (typeof requestAnimationFrame !== "function") {
+            for (const listener of [...listeners])
+                listener();
+            return;
+        }
+        if (frame !== 0)
+            return;
+        frame = requestAnimationFrame(flush);
+    };
+    return {
+        set(region) {
+            const prev = records.get(region.id);
+            if (prev !== undefined && sameRegion(prev, region))
+                return;
+            records.set(region.id, region);
+            emit();
+        },
+        remove(id) {
+            if (records.delete(id))
+                emit();
+        },
+        list: () => snapshot,
+        subscribe(listener) {
+            listeners.add(listener);
+            return () => {
+                listeners.delete(listener);
+            };
+        },
+    };
+}
+const RegionRegistryContext = createContext(null);
+const GameLayoutContext = createContext(null);
+const INPUT_HINT_STYLE_ID = "jg-input-hints";
+const INPUT_HINT_CSS = "@media (pointer: coarse){[data-jg-kbd-hint]{display:none!important}}";
+/** Install the backstop rule that hides keyboard/mouse hints on touch, once per document. */
+function ensureInputHintStylesheet() {
+    if (typeof document === "undefined")
+        return;
+    if (document.getElementById(INPUT_HINT_STYLE_ID) !== null)
+        return;
+    const style = document.createElement("style");
+    style.id = INPUT_HINT_STYLE_ID;
+    style.textContent = INPUT_HINT_CSS;
+    document.head.appendChild(style);
+}
+const SERVER_METRICS = {
+    layout: { left: 0, top: 0, right: 0, bottom: 0 },
+    visual: { left: 0, top: 0, right: 0, bottom: 0 },
+};
+function readViewportMetrics() {
+    if (typeof window === "undefined")
+        return SERVER_METRICS;
+    const layoutWidth = window.innerWidth;
+    const layoutHeight = window.innerHeight;
+    const vv = window.visualViewport;
+    const visual = vv
+        ? {
+            left: vv.offsetLeft,
+            top: vv.offsetTop,
+            right: vv.offsetLeft + vv.width,
+            bottom: vv.offsetTop + vv.height,
+        }
+        : { left: 0, top: 0, right: layoutWidth, bottom: layoutHeight };
+    return { layout: { left: 0, top: 0, right: layoutWidth, bottom: layoutHeight }, visual };
+}
+let cachedMetrics = SERVER_METRICS;
+function metricsSnapshot() {
+    const next = readViewportMetrics();
+    if (!sameRect(next.layout, cachedMetrics.layout) || !sameRect(next.visual, cachedMetrics.visual)) {
+        cachedMetrics = next;
+    }
+    return cachedMetrics;
+}
+function subscribeViewport(onChange) {
+    if (typeof window === "undefined")
+        return () => undefined;
+    window.addEventListener("resize", onChange);
+    window.addEventListener("orientationchange", onChange);
+    const vv = window.visualViewport;
+    vv?.addEventListener("resize", onChange);
+    vv?.addEventListener("scroll", onChange);
+    return () => {
+        window.removeEventListener("resize", onChange);
+        window.removeEventListener("orientationchange", onChange);
+        vv?.removeEventListener("resize", onChange);
+        vv?.removeEventListener("scroll", onChange);
+    };
+}
+/** Live visible viewport, tracking `window.visualViewport` (mobile browser chrome, pinch-zoom) with a layout-viewport fallback. */
+export function useViewportMetrics() {
+    return useSyncExternalStore(subscribeViewport, metricsSnapshot, () => SERVER_METRICS);
+}
+function measureSafeArea(probe) {
+    if (probe === null || typeof getComputedStyle !== "function")
+        return { top: 0, right: 0, bottom: 0, left: 0 };
+    const style = getComputedStyle(probe);
+    const px = (value) => {
+        const n = Number.parseFloat(value);
+        return Number.isFinite(n) ? n : 0;
+    };
+    return {
+        top: px(style.paddingTop),
+        right: px(style.paddingRight),
+        bottom: px(style.paddingBottom),
+        left: px(style.paddingLeft),
+    };
+}
+const SAFE_AREA_PROBE_STYLE = {
+    position: "fixed",
+    top: 0,
+    left: 0,
+    width: 0,
+    height: 0,
+    visibility: "hidden",
+    pointerEvents: "none",
+    paddingTop: "env(safe-area-inset-top, 0px)",
+    paddingRight: "env(safe-area-inset-right, 0px)",
+    paddingBottom: "env(safe-area-inset-bottom, 0px)",
+    paddingLeft: "env(safe-area-inset-left, 0px)",
+};
+/**
+ * Provides the shared game viewport layout to everything it wraps. Mount it
+ * once around the whole game presentation (world, HUD, controls, system UI) so
+ * every subsystem reads one coordinated geometry and registers its rect for
+ * collision detection. Publishes live `--jg-viewport-*` / `--jg-visual-viewport-*`
+ * / `--jg-safe-*` CSS variables on its root.
+ */
+export function GameViewportProvider({ platforms, className, style, children, }) {
+    const registry = useMemo(createRegionRegistry, []);
+    const metrics = useViewportMetrics();
+    const { coarsePointer } = useDisplayProfile();
+    const probeRef = useRef(null);
+    const [safeArea, setSafeArea] = useState({ top: 0, right: 0, bottom: 0, left: 0 });
+    const rootRef = useRef(null);
+    useEffect(() => {
+        ensureInputHintStylesheet();
+    }, []);
+    useEffect(() => {
+        const update = () => {
+            const next = measureSafeArea(probeRef.current);
+            setSafeArea((prev) => prev.top === next.top && prev.right === next.right && prev.bottom === next.bottom && prev.left === next.left
+                ? prev
+                : next);
+        };
+        update();
+        if (typeof window === "undefined")
+            return;
+        window.addEventListener("resize", update);
+        window.addEventListener("orientationchange", update);
+        return () => {
+            window.removeEventListener("resize", update);
+            window.removeEventListener("orientationchange", update);
+        };
+    }, [metrics]);
+    const regions = useSyncExternalStore(registry.subscribe, registry.list, () => EMPTY_REGIONS);
+    const mobileSupported = platforms?.includes("mobile") ?? true;
+    const visual = metrics.visual;
+    const vw = Math.max(0, visual.right - visual.left);
+    const vh = Math.max(0, visual.bottom - visual.top);
+    const layout = useMemo(() => {
+        const orientation = vw > 0 || vh > 0 ? orientationOf(vw, vh) : orientationOf(metrics.layout.right, metrics.layout.bottom);
+        const mode = resolveLayoutMode({
+            width: vw > 0 ? vw : metrics.layout.right,
+            height: vh > 0 ? vh : metrics.layout.bottom,
+            coarsePointer,
+            mobileSupported,
+        });
+        const reserved = regions
+            .filter((region) => region.kind === "control" || region.kind === "system")
+            .map((region) => region.rect);
+        const gameplayRect = computeGameplayRect(metrics.layout, safeArea, reserved);
+        return {
+            viewport: metrics.layout,
+            visualViewport: visual,
+            safeArea,
+            mode,
+            orientation,
+            regions,
+            controlZones: reserved,
+            gameplayRect,
+        };
+    }, [regions, metrics.layout, visual, vw, vh, coarsePointer, mobileSupported, safeArea]);
+    const collisions = useMemo(() => detectLayoutCollisions(regions), [regions]);
+    const forbidden = useMemo(() => collisions.filter((c) => c.severity === "forbid"), [collisions]);
+    useEffect(() => {
+        const root = rootRef.current;
+        if (root === null)
+            return;
+        if (forbidden.length === 0) {
+            root.removeAttribute("data-jg-layout-collision");
+            return;
+        }
+        const report = JSON.stringify(forbidden);
+        root.setAttribute("data-jg-layout-collision", report);
+        console.warn(`[jgengine] ${formatLayoutCollisions(forbidden)}\n  mode=${layout.mode} viewport=${Math.round(vw)}x${Math.round(vh)} safe=${safeArea.top}/${safeArea.right}/${safeArea.bottom}/${safeArea.left}`);
+    }, [forbidden, layout.mode, vw, vh, safeArea]);
+    useEffect(() => {
+        const ids = new Set();
+        for (const collision of forbidden) {
+            ids.add(collision.a);
+            ids.add(collision.b);
+        }
+        const marked = [];
+        for (const region of regions) {
+            if (region.element != null && ids.has(region.id)) {
+                region.element.setAttribute("data-jg-collision", "");
+                marked.push(region.element);
+            }
+        }
+        return () => {
+            for (const element of marked)
+                element.removeAttribute("data-jg-collision");
+        };
+    }, [forbidden, regions]);
+    const rootStyle = {
+        position: "relative",
+        width: "100%",
+        height: "100%",
+        "--jg-viewport-width": `${metrics.layout.right}px`,
+        "--jg-viewport-height": `${metrics.layout.bottom}px`,
+        "--jg-visual-viewport-width": `${Math.round(vw)}px`,
+        "--jg-visual-viewport-height": `${Math.round(vh)}px`,
+        "--jg-visual-viewport-offset-top": `${Math.round(visual.top)}px`,
+        "--jg-visual-viewport-offset-left": `${Math.round(visual.left)}px`,
+        "--jg-safe-top": `${safeArea.top}px`,
+        "--jg-safe-right": `${safeArea.right}px`,
+        "--jg-safe-bottom": `${safeArea.bottom}px`,
+        "--jg-safe-left": `${safeArea.left}px`,
+        ...style,
+    };
+    return (_jsx(RegionRegistryContext.Provider, { value: registry, children: _jsx(GameLayoutContext.Provider, { value: layout, children: _jsxs("div", { ref: rootRef, "data-jg-viewport": "", "data-jg-layout-mode": layout.mode, "data-jg-orientation": layout.orientation, className: className, style: rootStyle, children: [_jsx("div", { ref: probeRef, "aria-hidden": true, style: SAFE_AREA_PROBE_STYLE }), children] }) }) }));
+}
+/** The live shared viewport layout. Returns a neutral default outside a `GameViewportProvider` so it never throws in previews. */
+export function useGameViewportLayout() {
+    const layout = useContext(GameLayoutContext);
+    const metrics = useViewportMetrics();
+    return (layout ?? {
+        viewport: metrics.layout,
+        visualViewport: metrics.visual,
+        safeArea: { top: 0, right: 0, bottom: 0, left: 0 },
+        mode: resolveLayoutMode({ width: metrics.layout.right, height: metrics.layout.bottom, coarsePointer: false }),
+        orientation: orientationOf(metrics.layout.right, metrics.layout.bottom),
+        regions: [],
+        controlZones: [],
+        gameplayRect: metrics.layout,
+    });
+}
+/** The resolved explicit composition mode (`desktop-wide` … `mobile-portrait`). */
+export function useGameLayoutMode() {
+    return useGameViewportLayout().mode;
+}
+/** The live device orientation. */
+export function useGameOrientation() {
+    return useGameViewportLayout().orientation;
+}
+/** Rectangles reserved by touch controls and system UI — HUD placement should avoid these. */
+export function useReservedControlZones() {
+    return useGameViewportLayout().controlZones;
+}
+/** Live forbidden/warned region collisions (empty outside a provider). */
+export function useLayoutCollisions() {
+    const layout = useContext(GameLayoutContext);
+    return useMemo(() => (layout === null ? [] : detectLayoutCollisions(layout.regions)), [layout]);
+}
+function specKey(spec) {
+    return [
+        spec.id,
+        spec.kind,
+        spec.collisionPolicy,
+        spec.priority ?? "",
+        spec.collisionGroup ?? "",
+        (spec.allowOverlapWith ?? []).join("+"),
+    ].join("|");
+}
+/**
+ * Register the element behind `ref` as a layout region and keep its measured
+ * rectangle live (ResizeObserver + viewport changes). No-op outside a
+ * `GameViewportProvider`, so a component using it still works in isolation.
+ */
+export function useRegisterLayoutRegion(spec, ref, enabled = true) {
+    const registry = useContext(RegionRegistryContext);
+    const specRef = useRef(spec);
+    specRef.current = spec;
+    const key = specKey(spec);
+    useEffect(() => {
+        const element = ref.current;
+        if (registry === null || element === null || !enabled) {
+            registry?.remove(specRef.current.id);
+            return;
+        }
+        const measure = () => {
+            const rect = element.getBoundingClientRect();
+            registry.set({
+                ...specRef.current,
+                element,
+                rect: { left: rect.left, top: rect.top, right: rect.right, bottom: rect.bottom },
+            });
+        };
+        measure();
+        const observer = typeof ResizeObserver === "undefined" ? null : new ResizeObserver(measure);
+        observer?.observe(element);
+        if (typeof window !== "undefined") {
+            window.addEventListener("resize", measure);
+            window.addEventListener("orientationchange", measure);
+            window.visualViewport?.addEventListener("resize", measure);
+            window.visualViewport?.addEventListener("scroll", measure);
+        }
+        return () => {
+            observer?.disconnect();
+            if (typeof window !== "undefined") {
+                window.removeEventListener("resize", measure);
+                window.removeEventListener("orientationchange", measure);
+                window.visualViewport?.removeEventListener("resize", measure);
+                window.visualViewport?.removeEventListener("scroll", measure);
+            }
+            registry.remove(specRef.current.id);
+        };
+    }, [registry, ref, key, enabled]);
+}

package/dist/hooks.d.ts

@@ -19,6 +19,8 @@ import type { ClockSnapshot, SimClock } from "@jgengine/core/time/simClock";
 import { type PositionedPrompt } from "@jgengine/core/interaction/proximityPrompt";
 import { type GamePhase } from "@jgengine/core/game/gamePhase";
 export declare function useGameStore<T>(selector: (ctx: GameContext) => T, isEqual?: (previous: T, next: T) => boolean): T;
+/** Subscribe to a single keyed slice of the game store, returning `fallback` until the key is set. */
+export declare function useGameStoreValue<T>(key: string, fallback: T): T;
 export declare function useGame(): {
     commands: GameContext["game"]["commands"];
     events: GameEvents;
@@ -32,8 +34,19 @@ export declare function useGamePhase(): {
     phase: GamePhase;
     setPhase: (phase: GamePhase) => void;
 };
+/** Live run phase that degrades to `"playing"` when rendered outside a `GameProvider` (component showcases, previews), so phase-gated chrome never throws. */
+export declare function useOptionalGamePhase(): GamePhase;
 export declare function useSceneEntities(): readonly SceneEntity[];
 export declare function useSceneObjects(): readonly SceneObject[];
+/**
+ * Membership-only entity id list: the returned array keeps a stable identity across per-frame pose
+ * writes and only changes when an entity spawns, despawns, or the store is hydrated (#625). A marker
+ * mapped from these ids reads its own live pose imperatively (useFrame), so the actor tree no longer
+ * re-reconciles every frame. Prefer this over {@link useSceneEntities} for large scenes.
+ */
+export declare function useSceneEntityIds(): readonly string[];
+/** Membership-only object id list — the object counterpart of {@link useSceneEntityIds}; stable across move/rotate/setVisual, changes only on place/remove. */
+export declare function useSceneObjectIds(): readonly string[];
 export declare function useWorldItems(): readonly WorldItemRecord[];
 /** Nearest ground item within `radius` of the local player — drives a pickup prompt/highlight. */
 export declare function useNearestWorldItem(radius: number): WorldItemRecord | null;
@@ -88,18 +101,27 @@ export declare function useGameClock(): ClockSnapshot & {
 };
 export declare function useActivePrompt<T extends PositionedPrompt>(prompts?: readonly T[]): T | null;
 export declare function abilityKitNeedsHeartbeat(kit: AbilityKit, resourceAvailable?: number): boolean;
+/** True when `meter`'s value/fraction/tier/ready diverge from `previous` — the re-render check `useEventMeter` polls on its heartbeat. */
 export declare function eventMeterNeedsHeartbeat(meter: EventMeter, previous: EventMeterView | null): boolean;
 export interface AbilitySlotBindingOptions {
     intervalMs?: number;
 }
 export declare function useAbilitySlots(kit: AbilityKit, resourceAvailable?: number, options?: AbilitySlotBindingOptions): AbilitySlotSnapshot[];
 export declare function useAbilitySlot(kit: AbilityKit, slotId: string, resourceAvailable?: number, options?: AbilitySlotBindingOptions): AbilitySlotSnapshot | null;
+/** A rendered snapshot of an {@link EventMeter}: current value, fill fraction, active tier, and ready-to-consume flag. */
 export interface EventMeterView {
     value: number;
     fraction: number;
     tier: string | null;
     ready: boolean;
 }
+/**
+ * Bind a `createEventMeter` (`@jgengine/core/stats/eventMeter`) heat/streak gauge to a component — the react-render
+ * half of the ult/adrenaline and streak/combo meters (`event-meter` capability) that lets a HUD gauge re-render
+ * on tick without the game hand-rolling a `useEffect`/`setInterval` heartbeat around `meter.value()`.
+ *
+ * @capability event-meter-hud render a core event/heat meter's live value, fraction, tier, and ready state in a HUD gauge
+ */
 export declare function useEventMeter(meter: EventMeter, options?: AbilitySlotBindingOptions): EventMeterView;
 type HeldKeyEventTarget = Pick<Window, "addEventListener" | "removeEventListener">;
 export declare function createHeldKeyTracker(target: HeldKeyEventTarget): {

package/dist/hooks.js

@@ -3,7 +3,8 @@ import { AxisChannel } from "@jgengine/core/input/axisInput";
 import { browseSessions, } from "@jgengine/core/multiplayer/matchmaking";
 import { resolveActivePrompt, } from "@jgengine/core/interaction/proximityPrompt";
 import { gamePhase, setGamePhase } from "@jgengine/core/game/gamePhase";
-import { useGameContext } from "./provider.js";
+import { useGameContext, useOptionalGameContext } from "./provider.js";
+const noopSubscribe = () => () => undefined;
 import { createSelectCache, readSelectSnapshot } from "./selectSnapshot.js";
 export function useGameStore(selector, isEqual = Object.is) {
     const ctx = useGameContext();
@@ -15,6 +16,10 @@ export function useGameStore(selector, isEqual = Object.is) {
     const getSnapshot = useCallback(() => readSelectSnapshot(cacheRef.current, ctx.version(), () => selectorRef.current(ctx), (previous, next) => isEqualRef.current(previous, next)), [ctx]);
     return useSyncExternalStore(ctx.subscribe, getSnapshot, getSnapshot);
 }
+/** Subscribe to a single keyed slice of the game store, returning `fallback` until the key is set. */
+export function useGameStoreValue(key, fallback) {
+    return useGameStore((ctx) => ctx.game.store.get(key) ?? fallback);
+}
 export function useGame() {
     const ctx = useGameContext();
     return useMemo(() => ({ commands: ctx.game.commands, events: ctx.game.events }), [ctx]);
@@ -30,12 +35,35 @@ export function useGamePhase() {
     const setPhase = useCallback((next) => setGamePhase(ctx, next), [ctx]);
     return { phase, setPhase };
 }
+/** Live run phase that degrades to `"playing"` when rendered outside a `GameProvider` (component showcases, previews), so phase-gated chrome never throws. */
+export function useOptionalGamePhase() {
+    const ctx = useOptionalGameContext();
+    const getSnapshot = useCallback(() => (ctx === null ? "playing" : gamePhase(ctx)), [ctx]);
+    return useSyncExternalStore(ctx?.subscribe ?? noopSubscribe, getSnapshot, getSnapshot);
+}
 export function useSceneEntities() {
     return useGameStore((ctx) => ctx.scene.entity.list());
 }
 export function useSceneObjects() {
     return useGameStore((ctx) => ctx.scene.object.list());
 }
+/**
+ * Membership-only entity id list: the returned array keeps a stable identity across per-frame pose
+ * writes and only changes when an entity spawns, despawns, or the store is hydrated (#625). A marker
+ * mapped from these ids reads its own live pose imperatively (useFrame), so the actor tree no longer
+ * re-reconciles every frame. Prefer this over {@link useSceneEntities} for large scenes.
+ */
+export function useSceneEntityIds() {
+    const ctx = useGameContext();
+    const entity = ctx.scene.entity;
+    return useSyncExternalStore(entity.subscribeMembership, entity.ids, entity.ids);
+}
+/** Membership-only object id list — the object counterpart of {@link useSceneEntityIds}; stable across move/rotate/setVisual, changes only on place/remove. */
+export function useSceneObjectIds() {
+    const ctx = useGameContext();
+    const object = ctx.scene.object;
+    return useSyncExternalStore(object.subscribeMembership, object.ids, object.ids);
+}
 export function useWorldItems() {
     return useGameStore((ctx) => ctx.scene.worldItem.list());
 }
@@ -64,30 +92,38 @@ export function useCurrency(currencyId) {
 export function useFeed({ action, limit }) {
     return useGameStore((ctx) => ctx.game.feed.recent(action, limit === undefined ? undefined : { limit }));
 }
+const EMPTY_QUESTS = [];
 export function useQuestJournal() {
-    return useGameStore((ctx) => ctx.game.quest.list(ctx.player.userId));
-}
+    return useGameStore((ctx) => ctx.game.quest?.list(ctx.player.userId) ?? EMPTY_QUESTS);
+}
+const EMPTY_FRIENDS = [];
+const EMPTY_PARTY = [];
+const EMPTY_WORLD_INVITES = [];
+const EMPTY_CHAT = [];
+const EMPTY_FRIEND_REQUESTS = [];
+const EMPTY_PARTY_INVITES = [];
+const OFFLINE_PRESENCE = { online: false };
 export function useFriends() {
-    return useGameStore((ctx) => ctx.game.social.friends.list(ctx.player.userId));
+    return useGameStore((ctx) => ctx.game.social?.friends.list(ctx.player.userId) ?? EMPTY_FRIENDS);
 }
 export function useParty() {
-    return useGameStore((ctx) => ctx.game.social.party.list(ctx.player.userId));
+    return useGameStore((ctx) => ctx.game.social?.party.list(ctx.player.userId) ?? EMPTY_PARTY);
 }
 export function usePresence(userId) {
-    return useGameStore((ctx) => ctx.game.social.presence.get(userId));
+    return useGameStore((ctx) => ctx.game.social?.presence.get(userId) ?? OFFLINE_PRESENCE);
 }
 export function useWorldInvites() {
-    return useGameStore((ctx) => ctx.game.social.worldInvites.listFor(ctx.player.userId));
+    return useGameStore((ctx) => ctx.game.social?.worldInvites.listFor(ctx.player.userId) ?? EMPTY_WORLD_INVITES);
 }
 export function useChat(channelId, options) {
     const limit = options?.limit ?? 50;
-    return useGameStore((ctx) => ctx.game.chat.history(channelId, { limit, viewerUserId: ctx.player.userId }));
+    return useGameStore((ctx) => ctx.game.chat?.history(channelId, { limit, viewerUserId: ctx.player.userId }) ?? EMPTY_CHAT);
 }
 export function useFriendRequests() {
-    return useGameStore((ctx) => ctx.game.social.friends.requestsFor(ctx.player.userId));
+    return useGameStore((ctx) => ctx.game.social?.friends.requestsFor(ctx.player.userId) ?? EMPTY_FRIEND_REQUESTS);
 }
 export function usePartyInvites() {
-    return useGameStore((ctx) => ctx.game.social.party.invitesFor(ctx.player.userId));
+    return useGameStore((ctx) => ctx.game.social?.party.invitesFor(ctx.player.userId) ?? EMPTY_PARTY_INVITES);
 }
 /**
  * Polls a host-supplied session fetcher (e.g. createWsBackend().browse) and
@@ -134,11 +170,13 @@ export function useWorldBrowser(options) {
     return useMemo(() => ({ listings, loading, error, refresh: () => setRefreshTick((tick) => tick + 1) }), [listings, loading, error]);
 }
 export function useRoster(userId) {
-    return useGameStore((ctx) => ctx.game.roster.list(userId ?? ctx.player.userId));
+    return useGameStore((ctx) => ctx.game.roster?.list(userId ?? ctx.player.userId) ?? EMPTY_ROSTER);
 }
+const EMPTY_ROSTER = [];
 export function useLeaderboard(stat, options) {
-    return useGameStore((ctx) => ctx.game.leaderboard.getTop(stat, options));
+    return useGameStore((ctx) => ctx.game.leaderboard?.getTop(stat, options) ?? EMPTY_LEADERBOARD);
 }
+const EMPTY_LEADERBOARD = [];
 export function useLocalPlayerDead(healthStatId = "health") {
     return useGameStore((ctx) => {
         const player = localPlayerEntity(ctx);
@@ -175,6 +213,7 @@ export function abilityKitNeedsHeartbeat(kit, resourceAvailable) {
     }
     return false;
 }
+/** True when `meter`'s value/fraction/tier/ready diverge from `previous` — the re-render check `useEventMeter` polls on its heartbeat. */
 export function eventMeterNeedsHeartbeat(meter, previous) {
     const next = {
         value: meter.value(),
@@ -211,6 +250,13 @@ export function useAbilitySlot(kit, slotId, resourceAvailable, options) {
     useEngineHeartbeat(options?.intervalMs ?? 80, () => abilityKitNeedsHeartbeat(kit, resourceAvailable));
     return kit.state(slotId, resourceAvailable);
 }
+/**
+ * Bind a `createEventMeter` (`@jgengine/core/stats/eventMeter`) heat/streak gauge to a component — the react-render
+ * half of the ult/adrenaline and streak/combo meters (`event-meter` capability) that lets a HUD gauge re-render
+ * on tick without the game hand-rolling a `useEffect`/`setInterval` heartbeat around `meter.value()`.
+ *
+ * @capability event-meter-hud render a core event/heat meter's live value, fraction, tier, and ready state in a HUD gauge
+ */
 export function useEventMeter(meter, options) {
     const previous = useRef(null);
     useEngineHeartbeat(options?.intervalMs ?? 80, () => {

package/dist/hud.d.ts

@@ -0,0 +1,87 @@
+import { type CSSProperties, type ReactNode } from "react";
+/** Named color ramps for {@link StatBar} tones. `fn` maps fill fraction (0..1) → gradient stops. */
+declare const TONES: Record<string, (t: number) => [string, string]>;
+/** A stat tone — picks the bar's color ramp. */
+export type StatTone = keyof typeof TONES;
+/**
+ * A polished stat bar (health/mana/stamina/shield/xp) — a rounded, glassy meter with a tone-colored
+ * fill and an optional value readout. Reads `statId` off `entityId` (defaults to the local player).
+ * Renders nothing until the stat exists.
+ */
+export declare function StatBar({ statId, entityId, tone, label, showValue, width, icon, style, className, }: {
+    statId?: string;
+    entityId?: string;
+    tone?: StatTone;
+    label?: string;
+    showValue?: boolean;
+    width?: number;
+    icon?: ReactNode;
+    style?: CSSProperties;
+    className?: string;
+}): import("react").JSX.Element | null;
+/**
+ * A numbered hotbar bound to an inventory — glassy slots, an active-slot highlight, item id + count,
+ * and a keycap per slot. Place it and pass the `inventoryId`; `activeSlot` highlights the equipped one.
+ */
+export declare function Hotbar({ inventoryId, activeSlot, keys, slotSize, style, className, }: {
+    inventoryId: string;
+    activeSlot?: number;
+    keys?: readonly string[];
+    slotSize?: number;
+    style?: CSSProperties;
+    className?: string;
+}): import("react").JSX.Element;
+/**
+ * A speedometer for an entity (defaults to the local player) — an SVG arc gauge + a digital readout.
+ * `scale` converts world units/second to your display unit (3.6 → km/h, 2.237 → mph); `max` sets the
+ * gauge's top of scale.
+ */
+export declare function Speedometer({ entityId, scale, unit, max, size, style, className, }: {
+    entityId?: string;
+    scale?: number;
+    unit?: string;
+    max?: number;
+    size?: number;
+    style?: CSSProperties;
+    className?: string;
+}): import("react").JSX.Element;
+/**
+ * A time-of-day clock reading the sim calendar — `Day N · HH:MM`, 24h or 12h. `controls` adds
+ * pause + the game's speed multipliers as clickable pills (the "fast-forward" bar), off by default so
+ * a game opts into letting the player scrub time.
+ */
+export declare function Clock({ format, showDay, controls, style, className, }: {
+    format?: "24h" | "12h";
+    showDay?: boolean;
+    controls?: boolean;
+    style?: CSSProperties;
+    className?: string;
+}): import("react").JSX.Element;
+/**
+ * A wave / round banner — a bold centered pill for "WAVE 3" style callouts, with an optional subtitle
+ * (enemies remaining, timer). Pure display: pass the current `wave` and whatever subtitle you track.
+ */
+export declare function WaveBanner({ wave, label, subtitle, style, className, }: {
+    wave: number | string;
+    label?: string;
+    subtitle?: ReactNode;
+    style?: CSSProperties;
+    className?: string;
+}): import("react").JSX.Element;
+/** A currency counter — an icon (emoji/char, default a coin) plus the live amount for `currencyId`. */
+export declare function Coins({ currencyId, icon, style, className, }: {
+    currencyId: string;
+    icon?: ReactNode;
+    style?: CSSProperties;
+    className?: string;
+}): import("react").JSX.Element;
+/** A minimal center crosshair reticle — four ticks around a gap. Purely presentational. */
+export declare function Crosshair({ size, gap, thickness, color, style, className, }: {
+    size?: number;
+    gap?: number;
+    thickness?: number;
+    color?: string;
+    style?: CSSProperties;
+    className?: string;
+}): import("react").JSX.Element;
+export {};