@zylem/game-lib 0.9.9 → 0.9.11

package/dist/api/game-lib.api.md

@@ -64,6 +64,7 @@ import { length as length_2 } from 'three/tsl';
 import { LevelBuffer } from '@zylem/bridge';
 import { LevelDocument } from '@zylem/bridge';
 import { LevelEntry } from '@zylem/bridge';
+import { LevelNavigation } from '@zylem/bridge';
 import { LevelSyncPayload } from '@zylem/bridge';
 import { Light } from 'three';
 import { Line2 } from 'three/addons/lines/webgpu/Line2.js';
@@ -75,6 +76,12 @@ import { min } from 'three/tsl';
 import * as mitt from 'mitt';
 import { mix } from 'three/tsl';
 import { mod } from 'three/tsl';
+import { NavigationAsset } from '@zylem/bridge';
+import { NavigationEdit } from '@zylem/bridge';
+import { NavigationPath } from '@zylem/bridge';
+import { NavigationStatus } from '@zylem/bridge';
+import { NavigationToolPayload } from '@zylem/bridge';
+import { NavMeshHelper } from '@recast-navigation/three';
 import { normalize } from 'three/tsl';
 import { Object3D } from 'three';
 import { positionWorld } from 'three/tsl';
@@ -233,6 +240,11 @@ export const AudioItemSchema: _sinclair_typebox.TObject<{
 // @public (undocumented)
 export type AudioTrack = Static<typeof AudioTrackSchema>;
 
+// Warning: (ae-forgotten-export) The symbol "NavigationBakeInput" needs to be exported by the entry point public.d.ts
+//
+// @public
+export function bakeNavigationData(input: NavigationBakeInput): Promise<Uint8Array>;
+
 // @public
 export function beatsPerBar(signature: TimeSignature): number;
 
@@ -2785,6 +2797,8 @@ export interface GameBridgeHost {
     levelClose?(): void;
     levelPlay?(document: LevelDocument): void;
     levelSync?(payload: LevelSyncPayload): void;
+    // (undocumented)
+    navigation?(): NavigationSession | null;
     pickEntity?(ndc: BridgeNdc): EntitySummaryPayload | null;
     resolveEntity(uuid: string): GameEntity<any> | null;
     setStageVariable?(key: string, value: unknown): void;
@@ -3156,6 +3170,8 @@ export type GameEntityOptions = {
     color?: Color;
     size?: Vec3Input;
     position?: Vec3Input;
+    rotation?: Vec3Input;
+    scale?: Vec3Input;
     hideUntilPositioned?: boolean;
     visible?: boolean;
     editorOwned?: boolean;
@@ -4250,6 +4266,46 @@ export interface MultidirectionalSpaceShooterInput extends Shooter2DAimFireInput
     moveY: number;
 }
 
+// @public
+export class NavigationMesh {
+    // (undocumented)
+    createHelper(): NavMeshHelper;
+    // (undocumented)
+    dispose(): void;
+    // (undocumented)
+    findPath(start: BridgeVec3, end: BridgeVec3, halfExtents?: BridgeVec3): NavigationPath;
+    // (undocumented)
+    static load(bytes: Uint8Array): Promise<NavigationMesh>;
+}
+
+// @public
+export class NavigationSession {
+    // Warning: (ae-forgotten-export) The symbol "NavigationSessionHost" needs to be exported by the entry point public.d.ts
+    constructor(host: NavigationSessionHost);
+    // (undocumented)
+    bake(requestId?: string): Promise<NavigationAsset | null>;
+    // (undocumented)
+    clear(): void;
+    // (undocumented)
+    dispose(): void;
+    // (undocumented)
+    findPath(start: BridgeVec3, end: BridgeVec3): NavigationPath;
+    load(asset: NavigationAsset): Promise<void>;
+    pointerDown(ray: {
+        origin: Vector3;
+        direction: Vector3;
+    }): boolean;
+    // (undocumented)
+    query(start: BridgeVec3, end: BridgeVec3, requestId?: string): NavigationPath;
+    // (undocumented)
+    setPreview(visible: boolean): void;
+    // (undocumented)
+    setTool(tool: NavigationToolPayload): void;
+    // (undocumented)
+    get status(): NavigationStatus;
+    sync(document: LevelDocument): void;
+}
+
 export { normalize }
 
 // @public (undocumented)
@@ -9347,15 +9403,15 @@ export class ZylemZone extends GameEntity<ZylemZoneOptions> implements Collision
 // /Users/timothycool/Projects/zylem-projects/simulation/packages/behaviors/dist/particle-emitter.d.ts:60:9 - (ae-forgotten-export) The symbol "voidMagic" needs to be exported by the entry point public.d.ts
 // /Users/timothycool/Projects/zylem-projects/simulation/packages/behaviors/dist/particle-emitter.d.ts:61:9 - (ae-forgotten-export) The symbol "psychic" needs to be exported by the entry point public.d.ts
 // /Users/timothycool/Projects/zylem-projects/simulation/packages/behaviors/dist/payload-WEzfgjSL.d.ts:48:5 - (ae-forgotten-export) The symbol "PlainWorkerFragmentPayload" needs to be exported by the entry point public.d.ts
-// dist/entity-CY75JJSw.d.ts:399:5 - (ae-forgotten-export) The symbol "RenderCategory_2" needs to be exported by the entry point public.d.ts
-// dist/entity-CY75JJSw.d.ts:400:5 - (ae-forgotten-export) The symbol "RuntimeEntityOptions" needs to be exported by the entry point public.d.ts
-// dist/entity-CY75JJSw.d.ts:401:5 - (ae-forgotten-export) The symbol "CollisionOptions" needs to be exported by the entry point public.d.ts
-// dist/entity-CY75JJSw.d.ts:410:9 - (ae-forgotten-export) The symbol "IBuilder" needs to be exported by the entry point public.d.ts
-// dist/entity-CY75JJSw.d.ts:410:9 - (ae-forgotten-export) The symbol "EntityMeshBuilder" needs to be exported by the entry point public.d.ts
-// dist/entity-CY75JJSw.d.ts:411:9 - (ae-forgotten-export) The symbol "EntityCollisionBuilder" needs to be exported by the entry point public.d.ts
-// dist/entity-CY75JJSw.d.ts:412:9 - (ae-forgotten-export) The symbol "MaterialBuilder" needs to be exported by the entry point public.d.ts
-// dist/game-uQd7k6-m.d.ts:258:5 - (ae-forgotten-export) The symbol "StageInterface" needs to be exported by the entry point public.d.ts
-// dist/stage-Dez16Gxm.d.ts:1194:5 - (ae-forgotten-export) The symbol "StageAssetLoaderConfig" needs to be exported by the entry point public.d.ts
+// dist/entity-B8VygThO.d.ts:406:5 - (ae-forgotten-export) The symbol "RenderCategory_2" needs to be exported by the entry point public.d.ts
+// dist/entity-B8VygThO.d.ts:407:5 - (ae-forgotten-export) The symbol "RuntimeEntityOptions" needs to be exported by the entry point public.d.ts
+// dist/entity-B8VygThO.d.ts:408:5 - (ae-forgotten-export) The symbol "CollisionOptions" needs to be exported by the entry point public.d.ts
+// dist/entity-B8VygThO.d.ts:417:9 - (ae-forgotten-export) The symbol "IBuilder" needs to be exported by the entry point public.d.ts
+// dist/entity-B8VygThO.d.ts:417:9 - (ae-forgotten-export) The symbol "EntityMeshBuilder" needs to be exported by the entry point public.d.ts
+// dist/entity-B8VygThO.d.ts:418:9 - (ae-forgotten-export) The symbol "EntityCollisionBuilder" needs to be exported by the entry point public.d.ts
+// dist/entity-B8VygThO.d.ts:419:9 - (ae-forgotten-export) The symbol "MaterialBuilder" needs to be exported by the entry point public.d.ts
+// dist/game-BqKsvmSH.d.ts:258:5 - (ae-forgotten-export) The symbol "StageInterface" needs to be exported by the entry point public.d.ts
+// dist/stage-DT8QQbGk.d.ts:1197:5 - (ae-forgotten-export) The symbol "StageAssetLoaderConfig" needs to be exported by the entry point public.d.ts
 
 // (No @packageDocumentation comment for this package)
 

package/dist/api/game-lib.d.ts

@@ -58,6 +58,7 @@ import { length as length_2 } from 'three/tsl';
 import { LevelBuffer } from '@zylem/bridge';
 import { LevelDocument } from '@zylem/bridge';
 import { LevelEntry } from '@zylem/bridge';
+import { LevelNavigation } from '@zylem/bridge';
 import { LevelSyncPayload } from '@zylem/bridge';
 import { Light } from 'three';
 import { Line2 } from 'three/addons/lines/webgpu/Line2.js';
@@ -69,6 +70,12 @@ import { min } from 'three/tsl';
 import * as mitt from 'mitt';
 import { mix } from 'three/tsl';
 import { mod } from 'three/tsl';
+import { NavigationAsset } from '@zylem/bridge';
+import { NavigationEdit } from '@zylem/bridge';
+import { NavigationPath } from '@zylem/bridge';
+import { NavigationStatus } from '@zylem/bridge';
+import { NavigationToolPayload } from '@zylem/bridge';
+import { NavMeshHelper } from '@recast-navigation/three';
 import { normalize } from 'three/tsl';
 import { Object3D } from 'three';
 import { positionWorld } from 'three/tsl';
@@ -481,6 +488,9 @@ declare const AudioTrackSchema: _sinclair_typebox.TObject<{
     }>>;
 }>;
 
+/** Pure geometry input, suitable for a worker. Returned bytes own their memory. */
+export declare function bakeNavigationData(input: NavigationBakeInput): Promise<Uint8Array>;
+
 /**
  * BehaviorDescriptor
  *
@@ -1505,6 +1515,8 @@ export declare class CameraManager implements EditorCameraHost {
     private _screenSpacePanIds;
     /** Side, top, and isometric views that have already been placed on the gameplay camera. */
     private _framedEditorViews;
+    /** True after the free camera has copied the gameplay pose once. */
+    private _freePoseCaptured;
     /** World boxes of stage entities, read when an orthographic view is first shown. */
     private _entityBounds;
     /** Game camera to restore when the editor releases the main view. */
@@ -3406,6 +3418,12 @@ declare interface DebugState {
      * the Select tool is not armed, and keeps the hover highlight painted.
      */
     pickMode: boolean;
+    /**
+     * A Map Navigation tool (path test, obstacle, traversal link) is armed.
+     * Those tools live on the stage's navigation session, outside `tool`, and
+     * still need the canvas listeners and the game's own pointer input parked.
+     */
+    navigationTool: boolean;
     flags: Set<string>;
 }
 
@@ -5456,6 +5474,7 @@ export declare class GameBridge {
  * live stage state without the bridge importing game internals.
  */
 export declare interface GameBridgeHost {
+    navigation?(): NavigationSession | null;
     /** Resolve a live entity by UUID from the current stage. */
     resolveEntity(uuid: string): GameEntity<any> | null;
     /** Write a stage variable (editor `stage:variable:set`). */
@@ -6130,6 +6149,13 @@ export declare type GameEntityOptions = {
     color?: Color;
     size?: Vec3Input;
     position?: Vec3Input;
+    /** Spawn orientation as Euler angles in radians, applied in XYZ order. */
+    rotation?: Vec3Input;
+    /**
+     * Spawn scale. Colliders are scaled with the render object. An actor
+     * sizes its model from this instead.
+     */
+    scale?: Vec3Input;
     /**
      * Spawn visibility behavior:
      * - `undefined` (default): hidden while `spawnEntity` runs, revealed once
@@ -8220,6 +8246,75 @@ export declare interface MultidirectionalSpaceShooterInput extends Shooter2DAimF
 
 declare function nature(options?: Omit<ParticleMagicModifierOptions, 'alignment'>): ParticleMagicModifierOptions;
 
+declare interface NavigationBakeInput {
+    positions: Float32Array;
+    indices: Uint32Array;
+    navigation: LevelNavigation;
+}
+
+/** Owns Detour resources. A path supplies waypoints; movement and link traversal belong to gameplay. */
+export declare class NavigationMesh {
+    private mesh;
+    private query;
+    private disposed;
+    private constructor();
+    static load(bytes: Uint8Array): Promise<NavigationMesh>;
+    createHelper(): NavMeshHelper;
+    findPath(start: BridgeVec3, end: BridgeVec3, halfExtents?: BridgeVec3): NavigationPath;
+    dispose(): void;
+}
+
+/** Per-stage navigation, lazily loading Recast only on bake or asset load. */
+export declare class NavigationSession {
+    private host;
+    private document;
+    private sourceHash;
+    private generation;
+    private cancelWork;
+    private mesh;
+    private helper;
+    private overlay;
+    private annotations;
+    private route;
+    private visible;
+    private tool;
+    private firstPoint;
+    private state;
+    constructor(host: NavigationSessionHost);
+    get status(): NavigationStatus;
+    private publish;
+    private cancel;
+    private releaseMesh;
+    /** Selection and visibility syncs preserve the current bake. */
+    sync(document: LevelDocument): void;
+    setPreview(visible: boolean): void;
+    setTool(tool: NavigationToolPayload): void;
+    /** Import a saved asset without running the generator. */
+    load(asset: NavigationAsset): Promise<void>;
+    private generate;
+    bake(requestId?: string): Promise<NavigationAsset | null>;
+    findPath(start: BridgeVec3, end: BridgeVec3): NavigationPath;
+    query(start: BridgeVec3, end: BridgeVec3, requestId?: string): NavigationPath;
+    private line;
+    private drawAnnotations;
+    /** Two clicks on the level surface test a path, draw an obstacle, or create a link. */
+    pointerDown(ray: {
+        origin: Vector3;
+        direction: Vector3;
+    }): boolean;
+    clear(): void;
+    dispose(): void;
+}
+
+declare interface NavigationSessionHost {
+    stageId: string;
+    scene(): Object3D | null;
+    status?(status: NavigationStatus): void;
+    baked?(requestId: string, asset: NavigationAsset): void;
+    path?(result: NavigationPath, requestId?: string): void;
+    edit?(edit: NavigationEdit): void;
+}
+
 declare interface NodeInterface {
     uuid: string;
     name: string;
@@ -8246,17 +8341,6 @@ declare type NodeLike$1 = {
     create: Function;
 };
 
-/**
- * The user-facing stage handle and its fluent authoring API.
- *
- * `Stage` is the durable, author-time wrapper game code holds onto: it stores
- * options, pending entities, and lifecycle/loading callbacks, then constructs
- * and drives a fresh internal `ZylemStage` on each `load()`. Exists to give a
- * stable, ergonomic surface (`add`, `onSetup/onUpdate/onDestroy`, camera, input,
- * and event helpers) that survives stage reloads, while `ZylemStage` owns the
- * disposable per-load runtime. `createStage(...)` is the entry point.
- */
-
 declare type NodeLike = {
     create: Function;
 };
@@ -13614,6 +13698,8 @@ declare interface SquadWorker {
 
 declare class Stage {
     wrappedStage: ZylemStage | null;
+    /** Navigation for the loaded stage. Null before load or after teardown. */
+    get navigation(): NavigationSession | null;
     options: StageOptionItem[];
     private _pendingEntities;
     private setupCallbacks;
@@ -14196,6 +14282,8 @@ declare class StageEntityDelegate {
      */
     spawnEntity(child: BaseNode): Promise<void>;
     handleLateModelReady(entity: GameEntity<any>): void;
+    /** Apply the `rotation` and `scale` options before the body is spawned. */
+    private applySpawnTransform;
     /**
      * Register an entity for bundle or instanced rendering when opted in via
      * `category: 'environment'` or `category: 'pack'`.
@@ -18892,6 +18980,7 @@ declare type ZylemSpriteOptions = GameEntityOptions & {
  */
 declare class ZylemStage extends LifeCycleBase<ZylemStage> {
     type: string;
+    readonly navigation: NavigationSession;
     state: StageState;
     gravity: Vector3 | Vec3Components;
     world: ZylemWorld | null;