@skewedaspect/sage 0.5.1 → 0.6.0

package/dist/classes/gameEngine.d.ts

@@ -7,6 +7,10 @@ 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

@@ -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

@@ -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

@@ -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/engines/scene.d.ts

@@ -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/entity.d.ts

@@ -6,4 +6,8 @@ export interface GameEntityDefinition<State extends object = object> {
     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/managers/binding.d.ts

@@ -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

@@ -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

@@ -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

@@ -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

@@ -33,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.
      */