brick-engine-js 1.0.22 → 1.0.23

package/dist/types/core/module/grid/engines/GridMovementEngine.d.ts

@@ -1,29 +1,113 @@
 import { Cell, Vector, Piece } from '../../../types/Types';
 import { Grid } from '../../../types/modules';
 /**
- * Handles movement and projection logic for the game grid.
+ * Engineering sub-module providing single and multi-cell velocity behaviors.
+ *
+ * Implements the {@link Grid} physical positioning operations. It resolves vector translations
+ * against the static cell board, mapping out exact placement steps or rejecting invalid logic
+ * before game states have a chance to falsely render overlaps.
  */
 export default class GridMovementEngine {
     private grid;
     constructor(grid: Grid);
     /**
-     * Attempts to shift a collection of cells (a piece) in a given direction.
+     * Modifies the piece footprint iterating all target cells mathematically towards a given offset.
+     *
+     * @param {Piece} piece - The original collection of dynamically bound target cells.
+     * @param {Vector} direction - The spatial translation array declaring x/y offset integers.
+     * @returns {Piece} A new piece copy reflecting changes, or the old identical piece if restricted.
      */
-    movePiece(piece: Piece, direction: Vector): Piece | null;
-    movePieceLeft(piece: Piece): Piece | null;
-    movePieceRight(piece: Piece): Piece | null;
-    movePieceUp(piece: Piece): Piece | null;
-    movePieceDown(piece: Piece): Piece | null;
+    movePiece(piece: Piece, direction: Vector): Piece;
     /**
-     * Attempts to shift a single cell in a given direction.
+     * Alias for {@link movePiece} shifting one unit left continuously.
+     *
+     * @param {Piece} piece - The specific piece payload shifting.
+     * @returns {Piece} The new valid piece output.
+     */
+    movePieceLeft(piece: Piece): Piece;
+    /**
+     * Alias for {@link movePiece} shifting one unit right continuously.
+     *
+     * @param {Piece} piece - The specific piece payload shifting.
+     * @returns {Piece} The new valid piece output.
+     */
+    movePieceRight(piece: Piece): Piece;
+    /**
+     * Alias for {@link movePiece} shifting one unit up continuously.
+     *
+     * @param {Piece} piece - The specific piece payload shifting.
+     * @returns {Piece} The new valid piece output.
+     */
+    movePieceUp(piece: Piece): Piece;
+    /**
+     * Alias for {@link movePiece} shifting one unit down continuously.
+     *
+     * @param {Piece} piece - The specific piece payload shifting.
+     * @returns {Piece} The new valid piece output.
+     */
+    movePieceDown(piece: Piece): Piece;
+    /**
+     * Modifies a single cell footprint moving it mathematically towards a given offset.
+     *
+     * @param {Cell} cell - The original single target cell.
+     * @param {Vector} direction - The spatial translation array declaring x/y offset integers.
+     * @returns {Cell} A new cell copy reflecting changes, or the old identical cell if restricted.
+     */
+    moveCell(cell: Cell, direction: Vector): Cell;
+    /**
+     * Alias for {@link moveCell} shifting one unit left continuously.
+     *
+     * @param {Cell} cell - The specific cell shifting.
+     * @returns {Cell} The new valid cell output.
+     */
+    moveCellLeft(cell: Cell): Cell;
+    /**
+     * Alias for {@link moveCell} shifting one unit right continuously.
+     *
+     * @param {Cell} cell - The specific cell shifting.
+     * @returns {Cell} The new valid cell output.
+     */
+    moveCellRight(cell: Cell): Cell;
+    /**
+     * Alias for {@link moveCell} shifting one unit up continuously.
+     *
+     * @param {Cell} cell - The specific cell shifting.
+     * @returns {Cell} The new valid cell output.
+     */
+    moveCellUp(cell: Cell): Cell;
+    /**
+     * Alias for {@link moveCell} shifting one unit down continuously.
+     *
+     * @param {Cell} cell - The specific cell shifting.
+     * @returns {Cell} The new valid cell output.
+     */
+    moveCellDown(cell: Cell): Cell;
+    /**
+     * Implements a while-loop simulation repeatedly pushing a piece down until a collision is recorded.
+     *
+     * @param {Piece} piece - The piece footprint to analyze.
+     * @returns {Piece} A modified piece reflecting the absolute lowest valid coordinate alignment.
      */
-    moveCell(cell: Cell, direction: Vector): Cell | null;
-    moveCellLeft(cell: Cell): Cell | null;
-    moveCellRight(cell: Cell): Cell | null;
-    moveCellUp(cell: Cell): Cell | null;
-    moveCellDown(cell: Cell): Cell | null;
     getDropPath(piece: Piece): Piece;
+    /**
+     * Implements a while-loop simulation repeatedly pushing a piece up until a collision is recorded.
+     *
+     * @param {Piece} piece - The piece footprint to analyze.
+     * @returns {Piece} A modified piece reflecting the absolute highest valid coordinate alignment.
+     */
     getRisePath(piece: Piece): Piece;
+    /**
+     * Implements a while-loop simulation repeatedly pushing a piece left until a collision is recorded.
+     *
+     * @param {Piece} piece - The piece footprint to analyze.
+     * @returns {Piece} A modified piece reflecting the absolute furthest left valid coordinate alignment.
+     */
     getReachPathLeft(piece: Piece): Piece;
+    /**
+     * Implements a while-loop simulation repeatedly pushing a piece right until a collision is recorded.
+     *
+     * @param {Piece} piece - The piece footprint to analyze.
+     * @returns {Piece} A modified piece reflecting the absolute furthest right valid coordinate alignment.
+     */
     getReachPathRight(piece: Piece): Piece;
 }

package/dist/types/core/module/grid/engines/GridRegionEngine.d.ts

@@ -2,25 +2,44 @@ import { Color } from '../../../types/enums';
 import { Cell, Coordinate, Piece } from '../../../types/Types';
 import { Grid } from '../../../types/modules';
 /**
- * Handles region-based operations (areas, stamps, and occupancy) on the grid.
+ * Engineering sub-module strictly handling multi-cell batch operations and bounding interactions.
+ *
+ * Implements the {@link Grid} region processing logic. It aggregates simple cell iterations
+ * into unified area bounds to execute high-level game instructions, such as bulk stamping
+ * piece shapes or checking broad space availabilities.
  */
 export default class GridRegionEngine {
     private grid;
     constructor(grid: Grid);
     /**
-     * Checks if any of the provided coordinates are already occupied or out of bounds.
+     * Extends basic coordinate validation across a multiple-point piece footprint.
+     *
+     * @param {Coordinate[]} coordinates - The list of point mappings defining the desired area.
+     * @returns {boolean} A boolean true if any single piece chunk strikes a grid-wall or populated floor.
      */
     isAreaOccupied(coordinates: Coordinate[]): boolean;
     /**
-     * Fills a rectangular region defined by two corners with a specific value and color.
+     * Implements a generic box-shape overwrite mechanism across given 2D diagonal endpoints.
+     *
+     * @param {Coordinate} start - The initial boundary corner dictating iteration limits.
+     * @param {Coordinate} end - The terminating boundary corner closing the drawn box.
+     * @param {number} value - The numeric status assigning logical engine density.
+     * @param {Color} color - The specific UI token mapping the region aesthetic details.
+     * @returns {void} Returns nothing.
      */
     fillArea(start: Coordinate, end: Coordinate, value: number, color: Color): void;
     /**
-     * Updates multiple coordinates simultaneously with their specific values and colors.
+     * Converts a transient piece's logical blocks fully into permanently anchored static grid spaces.
+     *
+     * @param {Piece} piece - The collection of logically associated cells ready for injection.
+     * @returns {void} Returns nothing.
      */
     stampPiece(piece: Piece): void;
     /**
-     * Updates a single coordinate with a specific value and color from a Cell.
+     * Translates a single transient logical brick strictly into the grid's memory buffer.
+     *
+     * @param {Cell} cell - The complex type combining grid location, metadata value, and color payload.
+     * @returns {void} Returns nothing.
      */
     stampCell(cell: Cell): void;
 }

package/dist/types/core/module/grid/engines/GridTransformEngine.d.ts

@@ -1,21 +1,37 @@
 import { Coordinate, Axis, Piece } from '../../../types/Types';
 import { Grid } from '../../../types/modules';
 /**
- * Handles geometric transformations for pieces on the grid.
+ * Engineering sub-module handling geometric boundary manipulations and complex piece translations.
+ *
+ * Implements the {@link Grid} transformation behaviors. It acts as an isolated stateless evaluator
+ * providing mathematical projections (like rotation or mirroring) independently from the live game
+ * state, guaranteeing original piece blocks are unsullied if an attempted projection intersects a wall.
  */
 export default class GridTransformEngine {
     private grid;
     constructor(grid: Grid);
     /**
-     * Attempts to rotate a piece 90 degrees around a specific origin.
+     * Attempts to calculate a 90-degree radial offset around a defined center point.
+     *
+     * @param {Piece} piece - The specific layout array of logical cell metrics.
+     * @param {Coordinate} origin - The mathematical center point for the rotational pivot.
+     * @param {boolean} [clockwise=true] - The directional toggle controlling coordinate adjustments.
+     * @returns {Piece} The modified Piece array or the original Piece if collisions occurred.
      */
-    rotatePiece(piece: Piece, origin: Coordinate, clockwise?: boolean): Piece | null;
+    rotatePiece(piece: Piece, origin: Coordinate, clockwise?: boolean): Piece;
     /**
-     * Mirrors a piece across a specific axis relative to its bounding box.
+     * Mirrors a piece mapping its internal locations reversely across a specific median axis.
+     *
+     * @param {Piece} piece - The specific layout array of logical cells to invert.
+     * @param {Axis} axis - The 'x' or 'y' string declaring the geometric flip line.
+     * @returns {Piece} The newly formatted piece instance with updated mirrored values.
      */
     mirrorPiece(piece: Piece, axis: Axis): Piece;
     /**
-     * Calculates the bounding box of a piece.
+     * Iterates all block chunks discovering maximum absolute spatial corners to establish a rect-box boundary.
+     *
+     * @param {Piece} piece - The piece containing scattered cell coordinates.
+     * @returns {{min: Coordinate, max: Coordinate}} An object exposing corner extreme bounds.
      */
     getPieceBounds(piece: Piece): {
         min: Coordinate;

package/dist/types/core/module/renderer/DisplayRenderer.d.ts

@@ -1,43 +1,55 @@
 import { Cell, GameModules, RendererMetrics } from '../../types/Types';
 import { Renderer, State } from '../../types/modules';
 /**
- * Responsible for rendering the main game field (the grid where the game is played).
- * Handles cell rendering, background drawing, and optimizes static elements using an off-screen buffer.
+ * Dedicated visual presentation component isolating grid drawing loops.
+ *
+ * It decouples the performance-intensive grid enumeration from general game loops.
+ * Through pre-compilation (off-screen buffer for background elements) and heavy caching
+ * of explicit geometry boundaries (inner offset, padding, strokes), it minimizes real-time
+ * calculation depth, effectively stabilizing engine framerate limits.
  */
 export default class DisplayRenderer implements Renderer {
     private _rendererMetrics;
     private _cellPreCalculatedGeometry;
     private _staticGraphics;
     /**
-     * Initializes the renderer with the calculated metrics.
-     * Pre-calculates cell geometry for faster rendering.
+     * Implements specific internal matrix caches consuming injected absolute layout metrics.
      *
-     * @param {RendererMetrics} rendererMetrics - The shared renderer metrics.
+     * @param {RendererMetrics} rendererMetrics - The shared pre-compiled dimension dictionaries.
+     * @returns {void} Returns nothing.
      */
     setup(rendererMetrics: RendererMetrics): void;
     /**
-     * Renders the game grid.
-     * Draws the static background first, then iterates over the grid to draw cells.
+     * The continuous execution sequence re-painting the primary logical bounds on-screen.
      *
-     * @param {Cell[][]} grid - The current grid state.
+     * It efficiently pastes the off-screen cached background texture before procedurally computing
+     * transient piece overlay graphics.
+     *
+     * @param {Cell[][]} grid - The 2D target matrix identifying block coordinates.
+     * @param {GameModules} modules - Dynamic context properties passed directly by the Engine.
+     * @returns {void} Returns nothing.
      */
     render(grid: Cell[][], modules: GameModules): void;
     /**
-     * Renders static elements (background and borders) to an off-screen buffer.
-     * This improves performance by avoiding re-drawing static shapes every frame.
+     * Executes the initial setup closure defining fixed off-screen graphics buffer textures.
+     *
+     * @returns {void} Returns nothing.
      */
     private _renderStaticElements;
     /**
-     * Renders a single brick at grid coordinates.
-     * Uses translation matrices to keep drawing logic clean.
+     * Processes individual cell geometric construction dynamically translating matrices to prevent nested complex mathematics.
      *
-     * @param {Cell} cell - The cell data to render.
+     * @param {Cell} cell - The structured data representing logical bounds and status coloring.
+     * @param {State} state - Actively running environment configuration (like color schemes or game over logic).
+     * @returns {void} Returns nothing.
      */
     protected renderCell({ coordinate, color, value }: Cell, state: State): void;
     /**
-     * Iterates through the grid and renders each cell.
+     * Executes the rapid sequence loop covering the active logic matrix.
      *
-     * @param {Cell[][]} grid - The grid to render.
+     * @param {Cell[][]} grid - The logical target state collection.
+     * @param {State} state - Active environment flags modifying visual styling.
+     * @returns {void} Returns nothing.
      */
     protected renderGrid(grid: Cell[][], state: State): void;
 }

package/dist/types/core/module/renderer/GameRenderer.d.ts

@@ -3,9 +3,12 @@ import { Debuggable } from '../../types/Interfaces';
 import { Renderer } from '../../types/modules';
 import { RendererComposite } from '../../types/modules';
 /**
- * Composite renderer that manages multiple sub-renderers.
- * Orchestrates the rendering of the main display and the HUD.
- * Handles the calculation of shared rendering metrics (sizes, positions) to ensure consistency.
+ * Orchestrating composite module acting as the visual context manager.
+ *
+ * Implements the {@link RendererComposite} pattern to aggregate the specific display and HUD
+ * pipeline. It bridges the mathematical constraints (e.g. converting a relative 0.0-1.0
+ * grid position into strict P5 canvas pixels) and ensures layout recalculations happen exactly
+ * once during initialization to avoid expensive bounds-checking inside the main draw loops.
  */
 export default class GameRenderer implements RendererComposite, Debuggable {
     private _renderers;
@@ -13,27 +16,31 @@ export default class GameRenderer implements RendererComposite, Debuggable {
     private _hudRenderer;
     private _rendererMetrics;
     /**
-     * Adds a sub-renderer to the composition.
+     * Injects a sub-renderer routine into the core pipeline queue.
      *
-     * @param {Renderer} renderer - The renderer to add.
+     * @param {Renderer} renderer - The specific layer or boundary drawer.
+     * @returns {void} Returns nothing.
      */
     addRenderer(renderer: Renderer): void;
     /**
-     * Initializes all sub-renderers and calculates layout metrics.
-     * This method must be called before rendering begins.
+     * Instantiates system geometries and pushes strict calculated metrics down the pipeline.
+     * Must be invoked prior to the first rendering frame trigger.
+     *
+     * @returns {void} Returns nothing.
      */
     setup(): void;
     /**
-     * Calculates the layout dimensions for the display and HUD.
-     * Based on screen configuration and relative values.
+     * Pre-compiles absolute geometric values resolving relative design layouts against the physical hardware space.
+     *
+     * @returns {void} Returns nothing.
      */
     private _calculateMetrics;
     /**
-     * Delegating render method.
-     * Calls render on all registered sub-renderers.
+     * Exposes the single dispatch drawing sequence forwarding contexts down the entire renderer queue.
      *
-     * @param {Cell[][]} grid - The main game grid.
-     * @param {GameModules} modules - The game modules collection.
+     * @param {Cell[][]} grid - The logical playfield state matrix.
+     * @param {GameModules} modules - The active state containers injected dynamically.
+     * @returns {void} Returns nothing.
      */
     render(grid: Cell[][], modules: GameModules): void;
     /**

package/dist/types/core/module/renderer/HudRenderer.d.ts

@@ -1,48 +1,56 @@
 import { Renderer } from '../../types/modules';
 import { Cell, GameModules, RendererMetrics } from '../../types/Types';
 /**
- * Responsible for rendering the Heads-Up Display (HUD).
- * Displays game information like Score, High Score, Level, and the Next Piece Preview.
+ * Dedicated visual presentation component isolating Heads-Up Display (HUD) mechanics.
+ *
+ * Implements the {@link Renderer} interface to decouple metadata logic (level, scores, Next Piece
+ * visuals) away from core game physics. By translating absolute space constraints mapped in
+ * `configs.screenLayout`, it creates responsive graphical UI outputs without expensive real-time
+ * geometry processing on each execution tick.
  */
 export default class HudRenderer implements Renderer {
     private _gridOrigin;
     private _cellSize;
     private _hudBorderRect;
     /**
-     * Initializes the HUD with calculated metrics.
-     * Sets up the grid origin and border rectangle for the "next piece" preview area.
+     * Binds strictly defined initial layouts mapping dynamically sized objects over absolute space.
      *
-     * @param {RendererMetrics} rendererMetrics - The shared renderer metrics.
+     * @param {RendererMetrics} rendererMetrics - Pre-calculated scale components established globally.
+     * @returns {void} Returns nothing.
      */
     setup(rendererMetrics: RendererMetrics): void;
     /**
-     * Renders all HUD elements.
+     * Orchestrates the active frame-tick UI compilation logic sequences.
      *
-     * @param {Cell[][]} grid - The main game grid (unused in HUD, but required by interface).
-     * @param {GameModules} modules - The game modules for retrieving state and score.
+     * @param {Cell[][]} grid - A standard mapping hook currently unused by this context explicitly.
+     * @param {GameModules} modules - The active registry exposing GameScore and GameState values.
+     * @returns {void} Returns nothing.
      */
     render(grid: Cell[][], modules: GameModules): void;
     /**
-     * Renders the text-based HUD elements (Score, Level, Status).
+     * Compiles dynamic string payloads over absolute canvas locations tracking user data metrics.
      *
-     * @param {GameModules} modules - The game modules.
+     * @param {GameModules} modules - Global registry resolving access to the Score system.
+     * @returns {void} Returns nothing.
      */
     private _renderHud;
     /**
-     * Renders the preview grid for the next piece.
+     * Maps the static inner-HUD coordinate box defining where piece previews exist natively.
      *
-     * @param {GameModules} modules - The game modules.
+     * @param {GameModules} modules - Engine registry exposing the `GameHudGrid` explicitly.
+     * @returns {void} Returns nothing.
      */
     private _drawHudGrid;
     /**
-     * Helper method to draw a single cell on the HUD.
-     * Identical in logic to DisplayRenderer's cell drawing but localized for HUD.
+     * Optimized internal draw operation processing graphical offsets for the sub-grid layer.
      *
-     * @param {object} params - The drawing parameters.
-     * @param {number} params.w - Width of the cell.
-     * @param {number} params.posX - Absolute X position.
-     * @param {number} params.posY - Absolute Y position.
-     * @param {Color} params.color - Color of the cell.
+     * @param {object} params - Explicit physical boundary configuration dictionary.
+     * @param {number} params.w - The scale cell width footprint constraint.
+     * @param {number} params.h - The scale cell height footprint constraint.
+     * @param {number} params.posX - Translating X absolute starting point coordinate limit.
+     * @param {number} params.posY - Translating Y absolute starting point coordinate limit.
+     * @param {Color} params.color - The specific string enum resolving rendering palette strokes.
+     * @returns {void} Returns nothing.
      */
     private drawCellElement;
 }

package/dist/types/core/module/score/GameScore.d.ts

@@ -2,9 +2,12 @@ import { Debuggable } from '../../types/Interfaces';
 import { Score } from '../../types/modules';
 import { Serializable } from '../../types/Interfaces';
 /**
- * Manages game scoring, levels, and high score tracking.
- * Acts as the authority for the game's `highScore`, persisting it directly to `LocalStorage`.
- * Handles multipliers and supports Session serialization out of the box.
+ * Stateful module dedicated to tracking real-time player performance metrics.
+ *
+ * Implements the {@link Score} and {@link Serializable} interfaces to provide
+ * a centralized authority for maintaining score lines, difficulty levels, and
+ * multiplier bonuses. It uniquely tracks the global `highScore` by saving it
+ * directly to `LocalStorage` under an isolated `gameId` namespace.
  */
 export default class GameScore implements Score, Debuggable, Serializable {
     private _score;
@@ -15,37 +18,44 @@ export default class GameScore implements Score, Debuggable, Serializable {
     private _gameId;
     serialId: string;
     /**
-     * Sets up the game high score.
+     * Initializes the High Score context using a distinct installation prefix.
      *
-     * @param {string} id - The game ID.
+     * @param {string} id - The explicit game UUID or namespace string to prevent record collisions.
+     * @returns {void} Returns nothing.
      */
     setupGameHighScore(id: string): void;
     /**
-     * Increases the score by the given amount, applying the current multiplier.
-     * Automatically checks for high score updates.
+     * Increases the score by the given base amount after calculating active multipliers.
+     * Automatically assesses if the new score surpasses and replaces the persistent High Score.
      *
-     * @param {number} amount - The base amount to increase by.
+     * @param {number} amount - The integer base points to add before multipliers.
+     * @returns {void} Returns nothing.
      */
     increaseScore(amount: number): void;
     /**
-     * Resets the current score to 0.
+     * Zeroes out the active tracking score.
+     *
+     * @returns {void} Returns nothing.
      */
     resetScore(): void;
     /**
-     * Formats the current score as a string with leading zeros.
+     * Exports the raw session score as a physically padded string sequence.
      *
-     * @param {number} [digits=6] - The total number of digits to display.
-     * @returns {string} The formatted score string (e.g., "000150").
+     * @param {number} [digits=6] - The optional total number of sequence places to output (e.g. 6).
+     * @returns {string} The formatted string payload displaying leading zeros (e.g., "000150").
      */
     getFormattedScore(digits?: number): string;
     /**
-     * Increases the game level by a specific amount.
+     * Steps up the active engine difficulty level scaling.
      *
-     * @param {number} amount - The number of levels to add.
+     * @param {number} amount - The integer step of new levels to jump.
+     * @returns {void} Returns nothing.
      */
     increaseLevel(amount: number): void;
     /**
-     * Resets the game level back to 1.
+     * Resets the active difficulty level baseline back to initial 1.
+     *
+     * @returns {void} Returns nothing.
      */
     resetLevel(): void;
     /**
@@ -110,10 +120,11 @@ export default class GameScore implements Score, Debuggable, Serializable {
      */
     serialize(): string;
     /**
-     * Restores score and level progress from a serialized JSON string.
-     * Used by the SessionManager when recovering an active session.
+     * Modifies the running variables based on an injected serialized payload.
+     * Instructed dynamically by the `SessionManager` during initialization recovery.
      *
-     * @param {string} data - The JSON string containing the saved session data.
+     * @param {string} data - The packed string blob enclosing the structured saved session.
+     * @returns {void} Returns nothing.
      */
     deserialize(data: string): void;
 }

package/dist/types/core/module/session/GameSession.d.ts

@@ -1,5 +1,14 @@
 import { Serializable } from '../../types/Interfaces';
 import { Session, State } from '../../types/modules';
+/**
+ * Core module orchestrating state synchronization and transient game data persistence.
+ *
+ * Implements the {@link Session} interface to establish a single secure boundary
+ * between the active engine states and physical local storage limits. It intercepts
+ * the startup engine flows to ensure all registered {@link Serializable} modules
+ * correctly pause initialization safely inside a modal window until a human resolves
+ * the conflict (restoring or clearing).
+ */
 export default class GameSession implements Session {
     _state: State;
     gameId: string;
@@ -9,17 +18,64 @@ export default class GameSession implements Session {
     private _showSessionModal;
     private _resetFn;
     private _serializables;
+    /**
+     * Registers an external module to be actively tracked and persisted during session events.
+     *
+     * @param {Serializable} serializable - The compliant module instance exposing standard serialization capabilities.
+     * @returns {void} Returns nothing.
+     */
     register(serializable: Serializable): void;
+    /**
+     * Extracts and physically persists the current state payload of all registered modules to browser storage.
+     * Silently aborts if the session has not completed the restoration resolution flow or is disabled.
+     *
+     * @returns {void} Returns nothing.
+     */
     saveSession(): void;
+    /**
+     * Irreversibly wipes all transient saved module data mapped under this session's namespace.
+     *
+     * @returns {void} Returns nothing.
+     */
     clearSession(): void;
+    /**
+     * Injects the visual modal resolution closure implemented upstream.
+     *
+     * @param {Function} showModal - The asynchronous UI closure designed to ask the player to reload or reset the session.
+     * @returns {void} Returns nothing.
+     */
     setShowModalFunction(showModal: (onConfirm: () => void, onCancel: () => void) => void): void;
+    /**
+     * Injects the explicit game restoration sequence to execute when a session is aborted.
+     *
+     * @param {Function} resetFn - The recovery routine triggering a clean slate reset.
+     * @returns {void} Returns nothing.
+     */
     setResetFunction(resetFn: () => void): void;
+    /**
+     * Hard-toggles whether the session recovery mechanism evaluates at startup.
+     *
+     * @param {boolean} enabled - True to enforce session monitoring, false to skip entirely.
+     * @returns {void} Returns nothing.
+     */
     setSessionEnabled(enabled: boolean): void;
     isModalOpen(): boolean;
     isSessionResolved(): boolean;
     private _hasSession;
     private _loadSession;
+    /**
+     * Hooks into the global single source of truth state listener.
+     * Triggers the UI recovery workflow explicitly when the engine switches to the PLAYING state.
+     *
+     * @param {State} state - The authoritative lifecycle hub object to observe securely.
+     * @returns {void} Returns nothing.
+     */
     syncState(state: State): void;
+    /**
+     * Aggregates live metadata properties intended strictly for Development Dashboards.
+     *
+     * @returns {Record<string, string | number | boolean>} A shallow payload of the session tracker statuses.
+     */
     getDebugData(): Record<string, string | number | boolean>;
     private _key;
 }