@skewedaspect/sage 0.5.0 → 0.6.0

package/dist/classes/bindings/toggle.d.ts

@@ -1,7 +1,7 @@
-import type { GameEventBus } from '../eventBus.ts';
-import type { Action } from '../../interfaces/action.ts';
-import type { Binding, ToggleBindingDefinition } from '../../interfaces/binding.ts';
-import type { DeviceValueReader, InputState } from '../../interfaces/input.ts';
+import { GameEventBus } from "../eventBus.d.ts";
+import { Action } from "../../interfaces/action.d.ts";
+import { Binding, ToggleBindingDefinition } from "../../interfaces/binding.d.ts";
+import { DeviceValueReader, InputState } from "../../interfaces/input.d.ts";
 /**
  * Options for configuring a toggle binding
  */

package/dist/classes/bindings/trigger.d.ts

@@ -1,7 +1,7 @@
-import type { GameEventBus } from '../eventBus.ts';
-import type { Action } from '../../interfaces/action.ts';
-import type { Binding, TriggerBindingDefinition } from '../../interfaces/binding.ts';
-import type { DeviceValueReader, InputState } from '../../interfaces/input.ts';
+import { GameEventBus } from "../eventBus.d.ts";
+import { Action } from "../../interfaces/action.d.ts";
+import { Binding, TriggerBindingDefinition } from "../../interfaces/binding.d.ts";
+import { DeviceValueReader, InputState } from "../../interfaces/input.d.ts";
 /**
  * All supported edge modes for validation
  */

package/dist/classes/bindings/value.d.ts

@@ -1,7 +1,7 @@
-import type { GameEventBus } from '../eventBus.ts';
-import type { Action } from '../../interfaces/action.ts';
-import type { Binding, ValueBindingDefinition } from '../../interfaces/binding.ts';
-import type { DeviceValueReader, InputState } from '../../interfaces/input.ts';
+import { GameEventBus } from "../eventBus.d.ts";
+import { Action } from "../../interfaces/action.d.ts";
+import { Binding, ValueBindingDefinition } from "../../interfaces/binding.d.ts";
+import { DeviceValueReader, InputState } from "../../interfaces/input.d.ts";
 /**
  * Options for configuring a value binding
  */

package/dist/classes/entity.d.ts

@@ -1,5 +1,5 @@
-import type { GameEntityBehaviorConstructor } from '../interfaces/entity.ts';
-import { type GameEvent, GameEventBus } from './eventBus.ts';
+import { GameEntityBehaviorConstructor } from "../interfaces/entity.d.ts";
+import { GameEvent, GameEventBus } from "./eventBus.d.ts";
 /**
  * Interface representing the context of a game entity.
  * @template EntityState - The type of the state object.

package/dist/classes/eventBus.d.ts

@@ -1,4 +1,4 @@
-import { LoggingUtility } from '../utils/logger.ts';
+import { LoggingUtility } from "../utils/logger.d.ts";
 /**
  * A generic game event type.
  *

package/dist/classes/gameEngine.d.ts

@@ -1,12 +1,16 @@
 import { AbstractEngine, HavokPlugin } from '@babylonjs/core';
-import { GameCanvas } from '../interfaces/game.ts';
-import { SceneEngine } from '../engines/scene.ts';
-import { BindingManager } from '../managers/binding.ts';
-import { GameManager } from '../managers/game.ts';
-import { GameEntityManager } from '../managers/entity.ts';
-import { UserInputManager } from '../managers/input.ts';
-import { GameEventBus } from './eventBus.ts';
-import { LoggingUtility } from '../utils/logger.ts';
+import { GameCanvas } from "../interfaces/game.d.ts";
+import { SceneEngine } from "../engines/scene.d.ts";
+import { BindingManager } from "../managers/binding.d.ts";
+import { GameManager } from "../managers/game.d.ts";
+import { GameEntityManager } from "../managers/entity.d.ts";
+import { UserInputManager } from "../managers/input.d.ts";
+import { GameEventBus } from "./eventBus.d.ts";
+import { LoggingUtility } from "../utils/logger.d.ts";
+/**
+ * Type definition for game lifecycle hook functions
+ */
+export type GameHook = (gameEngine: SkewedAspectGameEngine) => Promise<void>;
 /**
  * Interface representing the engines used in the game.
  */
@@ -34,6 +38,9 @@ export declare class SkewedAspectGameEngine {
     eventBus: GameEventBus;
     logger: LoggingUtility;
     private _log;
+    private _beforeStartHook;
+    private _onStartHook;
+    private _onTeardownHook;
     /**
      * Creates an instance of SkewedAspectGameEngine.
      * @param canvas - The game canvas.
@@ -45,6 +52,24 @@ export declare class SkewedAspectGameEngine {
      * @param managers - The managers used in the game.
      */
     constructor(canvas: GameCanvas, renderEngine: AbstractEngine, physics: HavokPlugin, eventBus: GameEventBus, logger: LoggingUtility, engines: Engines, managers: Managers);
+    /**
+     * Register a function to be called before the game engine starts
+     * @param hook - Async function to be called before start
+     * @throws Error if a hook is already registered
+     */
+    onBeforeStart(hook: GameHook): void;
+    /**
+     * Register a function to be called after the game engine starts
+     * @param hook - Async function to be called after start
+     * @throws Error if a hook is already registered
+     */
+    onStart(hook: GameHook): void;
+    /**
+     * Register a function to be called when the game engine stops
+     * @param hook - Async function to be called during teardown
+     * @throws Error if a hook is already registered
+     */
+    onTeardown(hook: GameHook): void;
     /**
      * Starts the game engine.
      */

package/dist/classes/input/gamepad.d.ts

@@ -1,4 +1,4 @@
-import type { GamepadDevice, GamepadInputState } from '../../interfaces/input.ts';
+import { GamepadDevice, GamepadInputState } from "../../interfaces/input.d.ts";
 /**
  * Callback type for gamepad device connection events
  */
@@ -64,9 +64,9 @@ export declare class GamepadInputPlugin {
      */
     pollGamepads(): void;
     /**
-     * Destroy the gamepad resource access and clean up event listeners
+     * Tears down the gamepad resource access and cleans up event listeners
      */
-    destroy(): void;
+    $teardown(): Promise<void>;
     /**
      * Set up gamepad event listeners
      */

package/dist/classes/input/keyboard.d.ts

@@ -1,4 +1,4 @@
-import type { KeyboardDevice, KeyboardInputState } from '../../interfaces/input.ts';
+import { KeyboardDevice, KeyboardInputState } from "../../interfaces/input.d.ts";
 /**
  * Callback type for keyboard device connection events
  */
@@ -40,9 +40,9 @@ export declare class KeyboardInputPlugin {
      */
     getDevice(): KeyboardDevice;
     /**
-     * Destroy the keyboard resource access and clean up event listeners
+     * Tears down the keyboard resource access and cleans up event listeners
      */
-    destroy(): void;
+    $teardown(): Promise<void>;
     /**
      * Set up keyboard event listeners
      */

package/dist/classes/input/mouse.d.ts

@@ -1,4 +1,4 @@
-import type { MouseDevice, MouseInputState } from '../../interfaces/input.ts';
+import { MouseDevice, MouseInputState } from "../../interfaces/input.d.ts";
 /**
  * Callback type for mouse device connection events
  */
@@ -46,9 +46,9 @@ export declare class MouseInputPlugin {
      */
     getDevice(): MouseDevice;
     /**
-     * Destroy the mouse resource access and clean up event listeners
+     * Tears down the mouse resource access and cleans up event listeners
      */
-    destroy(): void;
+    $teardown(): Promise<void>;
     /**
      * Set up mouse event listeners
      */

package/dist/classes/input/readers/gamepad.d.ts

@@ -1,4 +1,4 @@
-import type { DeviceValueReader, GamepadValueReaderDefinition, InputState } from '../../../interfaces/input.ts';
+import { DeviceValueReader, GamepadValueReaderDefinition, InputState } from "../../../interfaces/input.d.ts";
 /**
  * Types of gamepad input sources
  */

package/dist/classes/input/readers/keyboard.d.ts

@@ -1,4 +1,4 @@
-import type { DeviceValueReader, InputState, KeyboardValueReaderDefinition } from '../../../interfaces/input.ts';
+import { DeviceValueReader, InputState, KeyboardValueReaderDefinition } from "../../../interfaces/input.d.ts";
 /**
  * Types of keyboard input sources
  */

package/dist/classes/input/readers/mouse.d.ts

@@ -1,4 +1,4 @@
-import type { DeviceValueReader, InputState, MouseValueReaderDefinition } from '../../../interfaces/input.ts';
+import { DeviceValueReader, InputState, MouseValueReaderDefinition } from "../../../interfaces/input.d.ts";
 /**
  * Types of mouse input sources
  */

package/dist/classes/loggers/consoleBackend.d.ts

@@ -1,4 +1,4 @@
-import type { LoggingBackend } from '../../interfaces/logger.ts';
+import { LoggingBackend } from "../../interfaces/logger.d.ts";
 /**
  * A logging backend that logs to the console.
  */

package/dist/classes/loggers/nullBackend.d.ts

@@ -1,4 +1,4 @@
-import type { LoggingBackend } from '../../interfaces/logger.ts';
+import { LoggingBackend } from "../../interfaces/logger.d.ts";
 /**
  * A logging backend that does nothing (discards all logs).
  * Useful for production environments or when you want to completely disable logging.

package/dist/engines/scene.d.ts

@@ -1,6 +1,6 @@
 import { AbstractEngine, HavokPlugin, Scene } from '@babylonjs/core';
-import type { GameCanvas } from '../interfaces/game.ts';
-import { type LoggingUtility } from '../utils/logger.ts';
+import { GameCanvas } from "../interfaces/game.d.ts";
+import { LoggingUtility } from "../utils/logger.d.ts";
 export declare class SceneEngine {
     private _engine;
     private _physics;
@@ -8,4 +8,8 @@ export declare class SceneEngine {
     constructor(engine: AbstractEngine, physics: HavokPlugin, logger?: LoggingUtility);
     private _buildDemoScene;
     loadScene(canvas: GameCanvas): Promise<Scene>;
+    /**
+     * Tears down the scene engine and cleans up any resources
+     */
+    $teardown(): Promise<void>;
 }

package/dist/interfaces/binding.d.ts

@@ -1,6 +1,6 @@
-import type { GameEventBus } from '../classes/eventBus.ts';
-import type { DeviceValueReader, DeviceValueReaderDefinition, InputState } from './input.ts';
-import type { Action } from './action.ts';
+import { GameEventBus } from "../classes/eventBus.d.ts";
+import { DeviceValueReader, DeviceValueReaderDefinition, InputState } from "./input.d.ts";
+import { Action } from "./action.d.ts";
 /**
  * Types of bindings supported by the system
  */
@@ -93,17 +93,10 @@ export interface ValueBindingDefinition extends BindingDefinitionBase {
         deadzone?: number;
     };
 }
-/**
- * Generic binding definition (for any other binding types)
- */
-export interface GenericBindingDefinition extends BindingDefinitionBase {
-    type: Exclude<BindingType, 'trigger' | 'toggle' | 'value'>;
-    options?: Record<string, any>;
-}
 /**
  * Union type of all binding definitions
  */
-export type BindingDefinition = TriggerBindingDefinition | ToggleBindingDefinition | ValueBindingDefinition | GenericBindingDefinition;
+export type BindingDefinition = TriggerBindingDefinition | ToggleBindingDefinition | ValueBindingDefinition;
 /**
  * Base interface for all input bindings
  */

package/dist/interfaces/entity.d.ts

@@ -1,9 +1,13 @@
-import { GameEntityBehavior } from '../classes/entity.ts';
-import { Action } from './action.ts';
+import { GameEntityBehavior } from "../classes/entity.d.ts";
+import { Action } from "./action.d.ts";
 export type GameEntityBehaviorConstructor<RequiredState extends object = object> = new () => GameEntityBehavior<RequiredState>;
-export interface GameEntityDefinition {
+export interface GameEntityDefinition<State extends object = object> {
     type: string;
-    defaultState: Record<string, any>;
-    behaviors: GameEntityBehaviorConstructor[];
     actions?: Action[];
+    defaultState: State;
+    behaviors: GameEntityBehaviorConstructor[];
+    onBeforeCreate?: (state: State) => Promise<State | undefined> | State | undefined;
+    onCreate?: (state: State) => Promise<State | undefined> | State | undefined;
+    onBeforeDestroy?: (state: State) => Promise<State | undefined> | State | undefined;
+    onDestroy?: (state: State) => Promise<void> | void;
 }

package/dist/interfaces/game.d.ts

@@ -1,6 +1,6 @@
 import { EngineOptions, NullEngineOptions, WebGPUEngineOptions } from '@babylonjs/core';
-import type { LogLevel } from './logger.ts';
-import { BindingDefinition } from './binding.ts';
+import { LogLevel } from "./logger.d.ts";
+import { BindingDefinition } from "./binding.d.ts";
 export type GameCanvas = HTMLCanvasElement | OffscreenCanvas | null;
 /** Specifies which rendering engine to force using */
 export type EngineType = 'webgl' | 'webgpu' | 'auto';

package/dist/managers/binding.d.ts

@@ -1,8 +1,8 @@
-import { GameEventBus } from '../classes/eventBus.ts';
-import { type Binding, type BindingDefinition, type Context } from '../interfaces/binding.ts';
-import type { InputDevice, InputState } from '../interfaces/input.ts';
-import type { Action } from '../interfaces/action.ts';
-import { LoggingUtility } from '../utils/logger.ts';
+import { GameEventBus } from "../classes/eventBus.d.ts";
+import { Binding, BindingDefinition, Context } from "../interfaces/binding.d.ts";
+import { InputDevice, InputState } from "../interfaces/input.d.ts";
+import { Action } from "../interfaces/action.d.ts";
+import { LoggingUtility } from "../utils/logger.d.ts";
 /**
  * Configuration object structure for binding manager
  */
@@ -182,4 +182,8 @@ export declare class BindingManager {
      * @param config - The configuration to import
      */
     importConfiguration(config: BindingConfiguration): void;
+    /**
+     * Tears down the binding manager and cleans up any resources
+     */
+    $teardown(): Promise<void>;
 }

package/dist/managers/entity.d.ts

@@ -1,8 +1,8 @@
-import { GameEntity } from '../classes/entity.ts';
-import { GameEventBus } from '../classes/eventBus.ts';
-import type { GameEntityDefinition } from '../interfaces/entity.ts';
-import type { BindingManager } from '../managers/binding.ts';
-import { LoggingUtility } from '../utils/logger.ts';
+import { GameEntity } from "../classes/entity.d.ts";
+import { GameEventBus } from "../classes/eventBus.d.ts";
+import { GameEntityDefinition } from "../interfaces/entity.d.ts";
+import { BindingManager } from "../managers/binding.d.ts";
+import { LoggingUtility } from "../utils/logger.d.ts";
 export declare class GameEntityManager {
     /** The event bus for the entity manager. */
     private eventBus;
@@ -27,12 +27,12 @@ export declare class GameEntityManager {
      * @param newAction - The action being registered
      * @returns true if the actions are compatible, false if they have conflicting options
      */
-    private areActionsCompatible;
+    private _areActionsCompatible;
     /**
      * Registers actions defined in the entity definition with the binding manager
      * @param entityDef - The entity definition containing actions to register
      */
-    private registerEntityActions;
+    private _registerEntityActions;
     $frameUpdate(dt: number): void;
     /**
      * Registers a new entity definition.
@@ -45,12 +45,12 @@ export declare class GameEntityManager {
      * @param initialState - The initial state of the entity.
      * @returns The created entity.
      */
-    createEntity<State extends object = object>(type: string, initialState?: Partial<State>): GameEntity<State>;
+    createEntity<State extends object = object>(type: string, initialState?: Partial<State>): Promise<GameEntity<State>>;
     /**
      * Destroys the entity with the given ID.
      * @param entityID - The ID of the entity to destroy.
      */
-    destroyEntity(entityID: string): void;
+    destroyEntity(entityID: string): Promise<void>;
     /**
      * Gets the entity with the given ID.
      * @param entityID - The ID of the entity to get.
@@ -67,4 +67,9 @@ export declare class GameEntityManager {
      * @param entityID - The ID of the entity to remove.
      */
     removeEntity(entityID: string): void;
+    /**
+     * Tears down all entities and releases resources
+     * @returns A promise that resolves when all entities have been destroyed
+     */
+    $teardown(): Promise<void>;
 }

package/dist/managers/game.d.ts

@@ -1,9 +1,9 @@
 import { AbstractEngine } from '@babylonjs/core';
-import { GameCanvas } from '../interfaces/game.ts';
-import { GameEntityManager } from './entity.ts';
-import { UserInputManager } from './input.ts';
-import { SceneEngine } from '../engines/scene.ts';
-import { LoggingUtility } from '../utils/logger.ts';
+import { GameCanvas } from "../interfaces/game.d.ts";
+import { GameEntityManager } from "./entity.d.ts";
+import { UserInputManager } from "./input.d.ts";
+import { SceneEngine } from "../engines/scene.d.ts";
+import { LoggingUtility } from "../utils/logger.d.ts";
 export declare class GameManager {
     private _engine;
     private _entityManager;
@@ -11,10 +11,16 @@ export declare class GameManager {
     private _sceneEngine;
     private _currentScene;
     private _log;
+    private _boundResizeHandler;
     started: boolean;
     constructor(engine: AbstractEngine, sceneEngine: SceneEngine, entityManager: GameEntityManager, inputManager: UserInputManager, logger?: LoggingUtility);
     private _renderLoop;
     private _resizeHandler;
     start(canvas: GameCanvas): Promise<void>;
     stop(): Promise<void>;
+    /**
+     * Tears down any resources held by the GameManager
+     * This handles unregistering event listeners and any other cleanup
+     */
+    $teardown(): Promise<void>;
 }

package/dist/managers/input.d.ts

@@ -1,6 +1,6 @@
-import type { InputDevice } from '../interfaces/input.ts';
-import { GameEventBus } from '../classes/eventBus.ts';
-import { LoggingUtility } from '../utils/logger.ts';
+import { InputDevice } from "../interfaces/input.d.ts";
+import { GameEventBus } from "../classes/eventBus.d.ts";
+import { LoggingUtility } from "../utils/logger.d.ts";
 /**
  * Manager for handling user input from various devices (keyboard, mouse, gamepad)
  */
@@ -32,9 +32,9 @@ export declare class UserInputManager {
      */
     private _publishInputChanged;
     /**
-     * Destroy the input manager and clean up event listeners
+     * Tears down the input manager and clean up event listeners
      */
-    $destroy(): void;
+    $teardown(): Promise<void>;
     /**
      * Get all input devices
      *

package/dist/managers/level.d.ts

@@ -1,6 +1,5 @@
 import { Engine, Scene } from '@babylonjs/core';
-import '@babylonjs/loaders';
-import { GameEntityManager } from './entity.ts';
+import { GameEntityManager } from "./entity.d.ts";
 export interface LevelLoadOptions {
     rootUrl: string;
     filename: string;
@@ -34,6 +33,10 @@ export declare class LevelManager {
      * Disposes the current scene and container (if any), freeing up memory.
      */
     disposeCurrentScene(): void;
+    /**
+     * Tears down the level manager and cleans up any resources
+     */
+    $teardown(): Promise<void>;
     /**
      * Returns the current active scene, if one is loaded.
      */

package/dist/sage.d.ts

@@ -1,22 +1,24 @@
-import { GameCanvas, RenderEngineOptions, SageOptions } from './interfaces/game.ts';
-import { SkewedAspectGameEngine } from './classes/gameEngine.ts';
-import { GameEventBus } from './classes/eventBus.ts';
+import { GameCanvas, RenderEngineOptions, SageOptions } from "./interfaces/game.d.ts";
+import { SkewedAspectGameEngine } from "./classes/gameEngine.d.ts";
+import { GameEventBus } from "./classes/eventBus.d.ts";
+import { GameEntityDefinition } from "./interfaces/entity.d.ts";
 /**
  * Creates an instance of SkewedAspectGameEngine.
  * @param canvas - The game canvas.
+ * @param entities - The game entities.
  * @param options - The game engine options including rendering options and log level.
  * @returns A promise that resolves to an instance of SkewedAspectGameEngine.
  */
-export declare function createGameEngine(canvas: GameCanvas, options?: SageOptions): Promise<SkewedAspectGameEngine>;
+export declare function createGameEngine(canvas: GameCanvas, entities: GameEntityDefinition[], options?: SageOptions): Promise<SkewedAspectGameEngine>;
 export type { GameCanvas, RenderEngineOptions, SageOptions };
-export * from './interfaces/action.ts';
-export * from './interfaces/binding.ts';
-export * from './interfaces/entity.ts';
-export * from './interfaces/game.ts';
-export * from './interfaces/input.ts';
-export * from './interfaces/logger.ts';
+export * from "./interfaces/action.d.ts";
+export * from "./interfaces/binding.d.ts";
+export * from "./interfaces/entity.d.ts";
+export * from "./interfaces/game.d.ts";
+export * from "./interfaces/input.d.ts";
+export * from "./interfaces/logger.d.ts";
 export { GameEventBus, SkewedAspectGameEngine };
-export * from './classes/eventBus.ts';
-export * from './classes/entity.ts';
-export * from './utils/logger.ts';
-export * from './utils/version.ts';
+export * from "./classes/eventBus.d.ts";
+export * from "./classes/entity.d.ts";
+export * from "./utils/logger.d.ts";
+export * from "./utils/version.d.ts";