@jgengine/core 0.2.0 → 0.3.0

package/dist/game/playableGame.d.ts

@@ -1,3 +1,4 @@
+import type { PositionedPrompt } from "../interaction/proximityPrompt.js";
 import type { GameContext, GameContextContent } from "../runtime/gameContext.js";
 import type { GameDefinition, GameLoop } from "./defineGame.js";
 export interface CameraFollowState {
@@ -58,6 +59,8 @@ export interface PlayableGame<TUi = unknown, TWorldOverlay = unknown> {
     entitySprites?: Record<string, EntitySpriteConfig>;
     /** Optional scroll-selected hotbar index for primary ability (mouse0). */
     hotbarSelection?: () => number;
+    /** Positioned proximity prompts for the interact key + HUD; single source shared with useActivePrompt. */
+    prompts?: (ctx: GameContext) => readonly PositionedPrompt[];
     /** Third-person orbit camera tuning for the dev game player shell. */
     camera?: GameCameraConfig;
 }

package/dist/input/actionBindings.d.ts

@@ -33,6 +33,16 @@ export declare function toActionStateBindingMap<TAction extends string, TCode ex
 export declare function hotbarSlotBindings(count: number, options?: {
     action?: (slot: number) => string;
 }): ActionCodesMap;
+/** 0-based slot index for a hotbar-slot action name (`slot1`, `hotbarSlot1`), or null. */
+export declare function hotbarSlotActionIndex(action: string): number | null;
+export declare function isHotbarSlotAction(action: string): boolean;
+/**
+ * Convention mapping a bound input action to the command it fires: the action's
+ * own name when a command by that name exists, otherwise a `ui.<action>`
+ * fallback. Reserved actions (consumed natively by the shell) and hotbar slots
+ * yield null so the shell can handle them itself.
+ */
+export declare function resolveActionCommand(action: string, has: (command: string) => boolean, reserved: ReadonlySet<string>): string | null;
 export declare function bindingLabel(code: string): string;
 /** Short display label for an action's first bound code, or null when unbound. */
 export declare function actionLabel(map: ActionCodesMap, action: string): string | null;

package/dist/input/actionBindings.js

@@ -67,6 +67,29 @@ export function hotbarSlotBindings(count, options) {
     }
     return map;
 }
+const HOTBAR_SLOT_ACTION = /^(?:hotbar)?slot(\d+)$/i;
+/** 0-based slot index for a hotbar-slot action name (`slot1`, `hotbarSlot1`), or null. */
+export function hotbarSlotActionIndex(action) {
+    const match = HOTBAR_SLOT_ACTION.exec(action);
+    return match === null ? null : Number(match[1]) - 1;
+}
+export function isHotbarSlotAction(action) {
+    return HOTBAR_SLOT_ACTION.test(action);
+}
+/**
+ * Convention mapping a bound input action to the command it fires: the action's
+ * own name when a command by that name exists, otherwise a `ui.<action>`
+ * fallback. Reserved actions (consumed natively by the shell) and hotbar slots
+ * yield null so the shell can handle them itself.
+ */
+export function resolveActionCommand(action, has, reserved) {
+    if (reserved.has(action) || isHotbarSlotAction(action))
+        return null;
+    if (has(action))
+        return action;
+    const uiCommand = `ui.${action}`;
+    return has(uiCommand) ? uiCommand : null;
+}
 const CODE_LABELS = {
     mouse0: "LMB",
     mouse1: "MMB",

package/dist/runtime/gameContext.d.ts

@@ -12,7 +12,8 @@ import { type QuestJournal } from "../game/quest.js";
 import { type Social } from "../game/social.js";
 import { type TradeField, type TradeSystem } from "../game/trade.js";
 import { type Unlocks } from "../game/unlocks.js";
-import { type InventorySet } from "../inventory/inventoryModel.js";
+import { type InventoryLayout, type InventorySet } from "../inventory/inventoryModel.js";
+import type { ProximityPrompt } from "../interaction/proximityPrompt.js";
 import { type ItemUseHandler, type ItemUseInput, type ItemUseRejection, type ItemUseResult } from "../item/use.js";
 import { type WeaponStats } from "../item/weapon.js";
 import { type PoseAllowedStates, type PoseState } from "../movement/poseState.js";
@@ -28,6 +29,7 @@ export interface GameContextItemEntry {
     weapon?: Record<string, unknown>;
     trade?: TradeField;
 }
+export type CatalogEntityRole = "player" | "enemy" | "hostile" | "npc" | "vehicle";
 export interface GameContextEntityEntry {
     stats?: StatCatalog;
     receive?: ReceiveMap;
@@ -35,11 +37,19 @@ export interface GameContextEntityEntry {
     movement?: PoseAllowedStates & {
         walkSpeed?: number;
     };
-    role?: string;
+    role?: CatalogEntityRole;
+}
+export interface GameContextObjectEntry {
+    proximityPrompt?: ProximityPrompt;
+    breakable?: false | {
+        baseBreakTime: number;
+    };
+    slotInventory?: InventoryLayout;
 }
 export interface GameContextContent {
     itemById?(itemId: string): GameContextItemEntry | null | undefined;
     entityById?(catalogId: string): GameContextEntityEntry | null | undefined;
+    objectById?(catalogId: string): GameContextObjectEntry | null | undefined;
 }
 export interface GameContextOptions<TAssetRef extends ModelAssetRef = ModelAssetRef, TMultiplayer = unknown> {
     definition: GameDefinition<TAssetRef, TMultiplayer>;
@@ -50,6 +60,9 @@ export interface GameContextOptions<TAssetRef extends ModelAssetRef = ModelAsset
     };
     now?: () => number;
 }
+export interface SceneObjectContext extends ObjectStore {
+    catalog(instanceId: string): GameContextObjectEntry | null;
+}
 export interface SceneEntityContext {
     spawn(name: string, options?: SpawnOptions): string;
     despawn(instanceId: string): boolean;
@@ -102,7 +115,7 @@ export interface GameContextItemUse {
 }
 export interface GameContext {
     scene: {
-        object: ObjectStore;
+        object: SceneObjectContext;
         entity: SceneEntityContext;
     };
     game: {

package/dist/runtime/gameContext.js

@@ -44,6 +44,10 @@ export function createGameContext(options) {
         const entity = entities.get(instanceId);
         return entity === null ? undefined : content.entityById?.(entity.name);
     }
+    function catalogObject(instanceId) {
+        const object = objects.get(instanceId);
+        return object === null ? undefined : content.objectById?.(object.catalogId);
+    }
     const spatial = createSpatialApi({
         resolvePosition: (instanceId) => entities.get(instanceId)?.position,
         candidates: () => entities.list().map((entity) => entity.id),
@@ -282,9 +286,13 @@ export function createGameContext(options) {
         getStat: weapon.getStat,
         now,
     }), ["fireProjectile", "settleProjectile"], signal.notify);
+    const sceneObjects = {
+        ...objects,
+        catalog: (instanceId) => catalogObject(instanceId) ?? null,
+    };
     const ctx = {
         scene: {
-            object: objects,
+            object: sceneObjects,
             entity: {
                 spawn: spawnEntity,
                 despawn: despawnEntity,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jgengine/core",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Genre-agnostic TypeScript game engine SDK: game runtime, state store, entity scene, combat, movement, inventory, economy, quests, multiplayer primitives.",
   "license": "AGPL-3.0-only",
   "type": "module",