@skewedaspect/sage 0.10.0-rc.2 → 0.10.0-rc.4

package/dist/entities/nodeEntity.d.ts

@@ -1,5 +1,5 @@
 import { TransformNode, AbstractMesh } from '@babylonjs/core';
-import { GameEntity, Action, BehaviorClass, ComposedOf, DeepReadonly, GameEntityState, GameEntityType, GameSimulationContext, OpsFor, StateFor, ValidTuple } from '@skewedaspect/sage-core';
+import { GameEntity, Action, BehaviorClass, ComposedOf, DeepReadonly, GameEntityState, GameEntityType, OpsFor, StateFor, ValidTuple } from '@skewedaspect/sage-core';
 import { AudioManager } from "../managers/audio.js";
 import { ColliderDebugConfig } from "../managers/colliderDebug.js";
 import { NodeSimulationContext } from "./nodeSimulationContext.js";
@@ -26,7 +26,7 @@ export interface NodeBehaviorHooks {
     onMeshLoaded?(): void;
     onDestroy?(): void;
 }
-export declare abstract class NodeEntity<Behaviors extends readonly BehaviorClass[] = readonly BehaviorClass[]> extends GameEntity {
+export declare abstract class NodeEntity<Behaviors extends readonly BehaviorClass[] = readonly BehaviorClass[]> extends GameEntity<NodeSimulationContext> {
     #private;
     static readonly poolable: boolean;
     static readonly poolSize?: number;
@@ -47,6 +47,6 @@ export declare abstract class NodeEntity<Behaviors extends readonly BehaviorClas
     showCollider(config?: ColliderDebugConfig, color?: string): void;
     hideCollider(name?: string): void;
     protected declareComputedState(suppliedState: object): void;
-    protected constructor(id: string, context: GameSimulationContext, providedState: object, runCreateHooks: boolean, name?: string);
+    protected constructor(id: string, context: NodeSimulationContext, providedState: object, runCreateHooks: boolean, name?: string);
     destroy(): void;
 }

package/dist/entities/nodeSimulation.d.ts

@@ -1,4 +1,4 @@
-import { GameSimulationManager, GameEntityRegistry, GameSimulationOptions, GameSimulationSnapshot, StateBag, ValidEntityRegistry } from '@skewedaspect/sage-core';
+import { GameSimulation, GameEntityRegistry, GameSimulationOptions, GameSimulationSnapshot, StateBag, ValidEntityRegistry } from '@skewedaspect/sage-core';
 import { AbstractMesh, Camera, Ray, Scene } from '@babylonjs/core';
 import { EntityPickFilter, EntityPickResult } from "./entityPicking.js";
 import { NodeEntity } from "./nodeEntity.js";
@@ -6,6 +6,7 @@ import { NodePool } from "./nodePool.js";
 import { MeshLoader, NodeSimulationContext } from "./nodeSimulationContext.js";
 import { AudioManager } from "../managers/audio.js";
 import { ColliderDebugManager } from "../managers/colliderDebug.js";
+import { LoggerInterface } from "../interfaces/logger.js";
 export type NodeEntityRegistry = GameEntityRegistry<NodeSimulationContext>;
 export interface NodeSimulationOptions<Registry extends NodeEntityRegistry = NodeEntityRegistry> extends GameSimulationOptions<Registry> {
     scene: Scene;
@@ -13,14 +14,16 @@ export interface NodeSimulationOptions<Registry extends NodeEntityRegistry = Nod
     pool: NodePool;
     audio?: AudioManager;
     colliders: ColliderDebugManager;
+    logger?: LoggerInterface;
 }
-export declare class NodeSimulation<Registry extends NodeEntityRegistry = NodeEntityRegistry> extends GameSimulationManager<Registry, NodeSimulationContext> implements NodeSimulationContext {
+export declare class NodeSimulation<Registry extends NodeEntityRegistry = NodeEntityRegistry> extends GameSimulation<Registry, NodeSimulationContext> implements NodeSimulationContext {
     #private;
     readonly scene: Scene;
     readonly pool: NodePool;
     readonly loadMesh: MeshLoader;
     readonly audio: AudioManager | undefined;
     readonly colliders: ColliderDebugManager;
+    readonly logger: LoggerInterface;
     constructor(options: NodeSimulationOptions<Registry> & {
         entityClasses: ValidEntityRegistry<Registry>;
     });
@@ -36,7 +39,6 @@ export declare class NodeSimulation<Registry extends NodeEntityRegistry = NodeEn
     pickEntity(x: number, y: number, filter?: EntityPickFilter): EntityPickResult | undefined;
     pickEntityForward(camera: Camera, range: number, filter?: EntityPickFilter): EntityPickResult | undefined;
     getEntityForMesh(mesh: AbstractMesh): NodeEntity | undefined;
-    spawnByName(name: string, state?: StateBag, id?: string): NodeEntity;
     buildFromSnapshot(snapshot: GameSimulationSnapshot): NodeSimulation<Registry>;
     protected buildReplacementSimulation(options: GameSimulationOptions<Registry>): NodeSimulation<Registry>;
 }

package/dist/entities/nodeSimulationContext.d.ts

@@ -1,5 +1,6 @@
 import { AbstractMesh, Scene, TransformNode } from '@babylonjs/core';
-import { GameSimulationContext, StateBag } from '@skewedaspect/sage-core';
+import { GameSimulationView, StateBag } from '@skewedaspect/sage-core';
+import { LoggerInterface } from "../interfaces/logger.js";
 import { AudioManager } from "../managers/audio.js";
 import { ColliderDebugManager } from "../managers/colliderDebug.js";
 import { NodePool } from "./nodePool.js";
@@ -8,10 +9,11 @@ export interface NodeSet {
     mesh: AbstractMesh | undefined;
 }
 export type MeshLoader = (scene: Scene, name: string, state: Readonly<StateBag>) => Promise<AbstractMesh | undefined>;
-export interface NodeSimulationContext extends GameSimulationContext {
+export interface NodeSimulationContext extends GameSimulationView {
     readonly scene: Scene;
     readonly pool: NodePool;
     readonly loadMesh: MeshLoader;
     readonly audio?: AudioManager;
     readonly colliders: ColliderDebugManager;
+    readonly logger: LoggerInterface;
 }

package/dist/entities/standardMeshSource.d.ts

@@ -1,8 +1,8 @@
-import { AbstractMesh, AssetContainer, Mesh } from '@babylonjs/core';
+import { AbstractMesh, AssetContainer, Mesh, Scene } from '@babylonjs/core';
 import { GameEntityType } from '@skewedaspect/sage-core';
 import { MeshLoader } from "./nodeSimulationContext.js";
 export interface MeshAssetSource {
     load(path: string): Promise<AssetContainer | AbstractMesh>;
-    clone(path: string): Mesh;
+    clone(path: string, into: Scene): Mesh;
 }
 export declare function buildStandardMeshSource(entityClasses: Readonly<Record<string, GameEntityType>>, assets: MeshAssetSource): MeshLoader;

package/dist/input/deliverAction.d.ts

@@ -1,4 +1,4 @@
-import { Action, GameSimulationContext } from '@skewedaspect/sage-core';
+import { Action, GameSimulationView } from '@skewedaspect/sage-core';
 import { Binding } from "./binding.js";
-export declare function deliverAction<State>(binding: Binding<State>, state: State, context: GameSimulationContext, senderID: string): void;
-export declare function deliverValueAction(action: Action, value: number, context: GameSimulationContext, senderID: string): void;
+export declare function deliverAction<State>(binding: Binding<State>, state: State, context: GameSimulationView, senderID: string): void;
+export declare function deliverValueAction(action: Action, value: number, context: GameSimulationView, senderID: string): void;

package/dist/managers/asset.d.ts

@@ -1,4 +1,4 @@
-import { AbstractMesh, AssetContainer, InstancedMesh, Mesh } from '@babylonjs/core';
+import { Mesh, AbstractMesh, AssetContainer, InstancedMesh, Scene } from '@babylonjs/core';
 import { EventBus } from '@skewedaspect/sage-core';
 import { SceneEngine } from "../engines/scene.js";
 import { Disposable } from "../interfaces/lifecycle.js";
@@ -32,6 +32,11 @@ export declare class AssetManager implements Disposable {
     private _loadContainer;
     /**
      * Read one container off disk and cache it, counting no references; `_loadContainer` does the counting.
+     *
+     * The scene the read goes into is cached beside the container and lives as long as it does. Babylon's
+     * `AssetContainer` subscribes to its scene's disposal and disposes itself, meshes and all, so disposing
+     * the scene early would leave an emptied container in the cache
+     * (design/engine.md#the-asset-manager).
      */
     private _fetchContainer;
     /**
@@ -52,9 +57,16 @@ export declare class AssetManager implements Disposable {
      */
     instance(path: string): InstancedMesh;
     /**
-     * Clone a cached source mesh into an independent copy. The path must have been loaded first.
+     * Clone a cached source mesh into an independent copy, in the scene it is handed. The path must have been
+     * loaded first.
+     *
+     * `Mesh.clone` keeps the source's scene, and the source lives in the scene this manager read the file
+     * into, so a clone made that way would never draw in the level that asked for it. Building the copy
+     * against the scene it is handed is what puts it in the level's, and `doNotCloneChildren` keeps a mesh
+     * parented under the source from being left behind in the manager's
+     * (design/engine.md#the-asset-manager).
      */
-    clone(path: string): Mesh;
+    clone(path: string, into: Scene): Mesh;
     /**
      * Preload a batch of asset paths, up to `MAX_CONCURRENT_LOADS` at a time, so a batch costs about as
      * long as its slowest asset rather than the sum of them all.

package/dist/managers/input.d.ts

@@ -1,4 +1,4 @@
-import { GameSimulationContext, Unsubscribe } from '@skewedaspect/sage-core';
+import { GameSimulationView, Unsubscribe } from '@skewedaspect/sage-core';
 import { Disposable } from "../interfaces/lifecycle.js";
 import { Binding, BindingDefinition, DeviceType } from "../input/binding.js";
 import { InputCapture } from "../input/inputCapture.js";
@@ -30,6 +30,6 @@ export declare class InputManager implements Disposable {
     bind(definition: BindingDefinition): Binding<unknown>;
     registerCapture(capture: InputCapture): Unsubscribe;
     getBindingsForAction(action: string, deviceType?: DeviceType, context?: string): readonly Binding<unknown>[];
-    routeCapturedInput(context: GameSimulationContext): void;
+    routeCapturedInput(context: GameSimulationView): void;
     dispose(): Promise<void>;
 }

package/dist/sage.d.ts

@@ -29,8 +29,8 @@ export * from "./interfaces/lifecycle.js";
 export * from "./utils/logger.js";
 export * from "./utils/timer.js";
 export * from "./utils/version.js";
-export { Behavior, EventBus, GameEntity, GameSimulationManager, NamedBehavior, StateMachineBehavior, defineStates, dilationLimit, drainPassLimit, operationCallDepthLimit, } from '@skewedaspect/sage-core';
-export type { BehaviorClass, ComposedOf, Computation, DeepReadonly, EventCallback, EventMap, EventSubscription, EventsMatching, GameEntityClass, GameEntityRegistry, GameEntitySnapshot, GameEntityState, GameEntityType, GameEvent, GameSimulationContext, GameSimulationOptions, GameSimulationSnapshot, IDAllocator, NamedState, NarrowedTo, OpsFor, OpsOf, StateBag, StateDefinition, StateFor, StateSliceOf, StateValue, Subscriber, Unsubscribe, ValidEntityRegistry, ValidTuple, } from '@skewedaspect/sage-core';
+export { Behavior, EventBus, GameEntity, GameRandom, GameSimulation, NamedBehavior, StateMachineBehavior, defineStates, dilationLimit, drainPassLimit, operationCallDepthLimit, } from '@skewedaspect/sage-core';
+export type { BehaviorClass, ComposedOf, Computation, DeepReadonly, EventCallback, EventMap, EventSubscription, EventsMatching, GameEntityClass, GameEntityRegistry, GameEntitySnapshot, GameEntityState, GameEntityType, GameEvent, GameSimulationOptions, GameSimulationSnapshot, GameSimulationView, IDAllocator, NamedState, NarrowedTo, OpsFor, OpsOf, RandomSeed, RandomState, SimulationFor, StateBag, StateDefinition, StateFor, StateSliceOf, StateValue, Subscriber, Unsubscribe, ValidEntityRegistry, ValidTuple, } from '@skewedaspect/sage-core';
 export { NodeEntity } from "./entities/nodeEntity.js";
 export type { NodeBehaviorHooks, NodeEntityState, QuaternionState, Vector3State } from "./entities/nodeEntity.js";
 export { NodePool } from "./entities/nodePool.js";