brick-engine-js 1.0.22 → 1.0.23

package/dist/types/view/Debugger.d.ts

@@ -1,10 +1,33 @@
 import { Initializable } from '../core/types/Interfaces';
 import { GameModules } from '../core/types/Types';
+/**
+ * Specialized DOM overlay for runtime system inspection outside Canvas contexts.
+ *
+ * Implements the {@link Initializable} lifecycle pattern. Automatically binds
+ * to dynamic engine states injecting strictly formatted HTML strings aggregating
+ * whatever data active developers pipe through `getDebugData`.
+ */
 export default class NewDebugger implements Initializable {
     private _gameModules;
     private _moduleElements;
     constructor(gameModules: GameModules);
+    /**
+     * Generates and mounts the initial technical read-outs strictly if `configs` allow it.
+     *
+     * @returns {void} Returns nothing.
+     */
     setup(): void;
+    /**
+     * Hotswaps the array of objects queried by the debugging module during execution.
+     *
+     * @param {GameModules} gameModules - The new collection overriding current tracking configurations.
+     * @returns {void} Returns nothing.
+     */
     setGameModules(gameModules: GameModules): void;
+    /**
+     * Executes the rapid frame translation pasting mapped numbers and string states into browser Text Nodes.
+     *
+     * @returns {void} Returns nothing.
+     */
     update(): void;
 }

package/dist/types/view/GameView.d.ts

@@ -2,12 +2,11 @@ import p5 from 'p5';
 import { Control } from '../core/types/modules';
 import { GameModules } from '../core/types/Types';
 /**
- * Responsible for rendering the game body and handling control events.
+ * Central UI module bridging logical game states to responsive DOM elements.
  *
- * This class acts as the main view controller, orchestrating the layout,
- * styles, and user interaction (clicks and holds) for the game.
- *
- * @class
+ * It serves as the single source of truth for the HTML structure, mapping physical user clicks
+ * safely down into Engine abstraction events. By orchestrating everything from Canvas instantiation
+ * to system Menus, it ensures strictly isolated interactions between the browser window and core logic.
  */
 export default class GameView {
     private _onOffBtn;
@@ -27,15 +26,15 @@ export default class GameView {
     private _debugger;
     private _sessionModal;
     /**
-     * Creates an instance of GameView.
+     * Bootstraps the root listener binding it to a persistent layout container.
      *
-     * @param p - The p5 instance used for rendering and event handling.
-     * @param parent - The DOM element where the game view will be attached.
+     * @param {HTMLElement} parent - The DOM element where the game view will be attached.
      */
     constructor(parent: HTMLElement);
     /**
-     * Checks if the game body has been built.
-     * @returns True if the game body has been built, false otherwise.
+     * Verifies if the physical Canvas context has successfully mounted into the Document structure.
+     *
+     * @returns {boolean} True if the game body has been built, false otherwise.
      */
     isBodyBuilt(): boolean;
     /**
@@ -54,47 +53,65 @@ export default class GameView {
         canvasHeight: number;
     };
     /**
-     * Sets up the session modal with the current game modules.
-     * @param gameModules - The game modules to be used in the session modal.
+     * Injects the strictly structured overlay handling interrupted restoration flows.
+     *
+     * @returns {void} Returns nothing.
      */
     setupSessionModal(): void;
+    /**
+     * Invokes the blocking popup intercepting control until the User forces a choice.
+     *
+     * @param {function(): void} onConfirm - The mapped execution sequence if the dialog is accepted.
+     * @param {function(): void} onCancel - The mapped execution sequence if the dialog is declined.
+     * @returns {void} Returns nothing.
+     */
     showSessionModal(onConfirm: () => void, onCancel: () => void): void;
     /**
-     * Sets up the debugger with the current game modules.
-     * @param gameModules - The game modules to be debugged.
+     * Instantiates the technical UI diagnostics tool aggregating dynamic execution values into the DOM.
+     *
+     * @param {GameModules} gameModules - The specific suite of active modules evaluated by pointers.
+     * @returns {void} Returns nothing.
      */
     setupDebugger(gameModules: GameModules): void;
+    /**
+     * Points the tracked overlay values dynamically onto a newly injected module configuration suite.
+     *
+     * @param {GameModules} gameModules - The collection of logically active states swapping contexts.
+     * @returns {void} Returns nothing.
+     */
     updateDebuggerGameModules(gameModules: GameModules): void;
     /**
-     * Updates the debugger with the current game state.
+     * Forces an execution cycle translating the latest internal module variables to the DOM interface.
+     *
+     * @returns {void} Returns nothing.
      */
     updateDebugger(): void;
     /**
-     * Binds game control events to the view buttons.
-     *
-     * Connects click and hold events from the UI buttons to the game logic controllers.
+     * Traps all specific DOM elements mapping pointer and mouse events directly down to engine triggers.
      *
-     * @param control - The control module instance.
+     * @param {Control} control - The active translation gateway reading raw clicks.
+     * @returns {void} Returns nothing.
      */
     bindControls(control: Control): void;
     /**
-     * Unbinds all events from the view buttons.
+     * Safely disengages all listeners destroying pointer mappings across all buttons.
      *
-     * Replaces all event listeners with empty functions to prevent interaction
-     * (e.g., when the game is paused or stopped).
+     * @returns {void} Returns nothing.
      */
     unbindControls(): void;
     /**
-     * Helper method to bind press and release events using ControlInputHandler.
+     * Helper injecting standard up/down polling loops directly onto native elements safely.
      *
-     * @param btn - The p5 button element to bind.
-     * @param key - The control key to notify.
+     * @param {p5.Element} btn - The specific HTML reference targeted.
+     * @param {ControlKey} key - The enumerated alias dispatched downstream on interaction.
+     * @returns {void} Returns nothing.
      */
     private _bindButtonEvents;
     /**
-     * Helper method to hide the splash screen after a delay.
+     * Schedules the destructive cleanup sequence fading initialization overlays away gracefully.
      *
-     * @param delay - The delay in milliseconds (defaults to `configs.viewLayout.splashHideDelayMs`).
+     * @param {number} delay - The specific integer mapped in layout configs.
+     * @returns {void} Returns nothing.
      */
     private _hideSplash;
 }

package/dist/types/view/SessionModal.d.ts

@@ -1,10 +1,34 @@
 import { Initializable } from '../core/types/Interfaces';
+/**
+ * Specialized interrupt overlay confirming persistence restores asynchronously.
+ *
+ * It generates vanilla DOM elements that intentionally block Canvas execution pointers,
+ * preventing game logics from polluting local memory until a Human clearly decides
+ * whether to load or destroy auto-saved metadata safely.
+ */
 export default class SessionModal implements Initializable {
     private _container;
     private _confirmButton;
     private _cancelButton;
     constructor();
+    /**
+     * Bootstraps the Vanilla DOM creation assigning hidden CSS parameters until execution calls.
+     *
+     * @returns {void} Returns nothing.
+     */
     setup(): void;
+    /**
+     * Removes the CSS hidden barrier and binds strictly required callback endpoints to the physical buttons.
+     *
+     * @param {function(): void} onConfirm - The pointer mapped when the player wants to restore data.
+     * @param {function(): void} onCancel - The pointer mapped when the player declines restoration.
+     * @returns {void} Returns nothing.
+     */
     show(onConfirm: () => void, onCancel: () => void): void;
+    /**
+     * Nullifies listeners and applies strictly blocking CSS classes safely.
+     *
+     * @returns {void} Returns nothing.
+     */
     private _hide;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "brick-engine-js",
-  "version": "1.0.22",
+  "version": "1.0.23",
   "description": "A lightweight brick engine built with p5.js and TypeScript",
   "type": "commonjs",
   "main": "dist/brick-engine.js",

package/dist/CNAME

@@ -1 +0,0 @@
-brickengine.com.br