brick-engine-js 1.0.38 → 1.0.40

package/dist/docs/reference/interfaces/modules/Time.html

@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="generator" content="Asciidoctor 2.0.20">
-<meta name="description" content="Interface for managing the game's logical clock and update frequency.">
+<meta name="description" content="Interface defining the contract for logical game time management.">
 <meta name="keywords" content="time, clock, tick, interval, game-loop">
 <title>Time Reference</title>
 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
@@ -444,21 +444,25 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <div id="toctitle">Table of Contents</div>
 <ul class="sectlevel1">
 <li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
-<li><a href="#properties">2. Properties</a></li>
-<li><a href="#methods">3. Methods</a>
+<li><a href="#api-reference">2. API Reference</a>
 <ul class="sectlevel2">
-<li><a href="#updatedeltatime-number-void">3.1. <code>update(deltaTime: number): void</code></a></li>
-<li><a href="#shouldtick-boolean">3.2. <code>shouldTick(): boolean</code></a></li>
-<li><a href="#reset-void">3.3. <code>reset(): void</code></a></li>
-<li><a href="#istickeveryinterval-number-boolean">3.4. <code>isTickEvery(interval: number): boolean</code></a></li>
-<li><a href="#incrementtickintervalamount-number-void">3.5. <code>incrementTickInterval(amount: number): void</code></a></li>
-<li><a href="#decrementtickintervalamount-number-void">3.6. <code>decrementTickInterval(amount: number): void</code></a></li>
-<li><a href="#settickintervalinterval-number-void">3.7. <code>setTickInterval(interval: number): void</code></a></li>
-<li><a href="#setmintickintervalinterval-number-void">3.8. <code>setMinTickInterval(interval: number): void</code></a></li>
-<li><a href="#captureinitialstate-void">3.9. <code>captureInitialState(): void</code></a></li>
+<li><a href="#core-simulation">2.1. Core Simulation</a>
+<ul class="sectlevel3">
+<li><a href="#updatedeltatime-number-void">2.1.1. <code>update(deltaTime: number): void</code></a></li>
+<li><a href="#accumulatedeltatime-number-void">2.1.2. <code>accumulate(deltaTime: number): void</code></a></li>
+<li><a href="#shouldtick-boolean">2.1.3. <code>shouldTick(): boolean</code></a></li>
+<li><a href="#reset-void">2.1.4. <code>reset(): void</code></a></li>
 </ul>
 </li>
-<li><a href="#general-usage">4. General Usage</a></li>
+<li><a href="#declarative-api">2.2. Declarative API</a>
+<ul class="sectlevel3">
+<li><a href="#atintervalms-number-boolean">2.2.1. <code>atInterval(ms: number): boolean</code></a></li>
+<li><a href="#everyms-number-action-void-void">2.2.2. <code>every(ms: number, action: () &#8658; void): void</code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li><a href="#general-usage">3. General Usage</a></li>
 </ul>
 </div>
 </div>
@@ -467,51 +471,19 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p>Interface for managing the game&#8217;s logical clock and update frequency.</p>
+<p>The <code>Time</code> interface defines the core contract for managing the engine&#8217;s logical clock and update frequency. It ensures that any implementation provides the necessary tools to decouple deterministic game logic from the visual frame rate.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
-<h2 id="properties"><a class="link" href="#properties">2. Properties</a></h2>
-<div class="sectionbody">
-<table class="tableblock frame-all grid-all stretch">
-<colgroup>
-<col style="width: 20%;">
-<col style="width: 20%;">
-<col style="width: 60%;">
-</colgroup>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>tickInterval</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The duration in milliseconds between logic updates.</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>totalTicks</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The total number of logic ticks that have occurred since the game started.</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>elapsedTime</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The total time in milliseconds elapsed since the game started.</p></td>
-</tr>
-</tbody>
-</table>
-</div>
-</div>
-<div class="sect1">
-<h2 id="methods"><a class="link" href="#methods">3. Methods</a></h2>
+<h2 id="api-reference"><a class="link" href="#api-reference">2. API Reference</a></h2>
 <div class="sectionbody">
 <div class="sect2">
-<h3 id="updatedeltatime-number-void"><a class="link" href="#updatedeltatime-number-void">3.1. <code>update(deltaTime: number): void</code></a></h3>
+<h3 id="core-simulation"><a class="link" href="#core-simulation">2.1. Core Simulation</a></h3>
+<div class="sect3">
+<h4 id="updatedeltatime-number-void"><a class="link" href="#updatedeltatime-number-void">2.1.1. <code>update(deltaTime: number): void</code></a></h4>
 <div class="paragraph">
-<p>Adds elapsed time to the internal tick accumulator. Called every frame.</p>
+<p>Advances the internal physical stats (FPS/TPS).</p>
 </div>
 <div class="paragraph">
 <p><strong>Parameters</strong></p>
@@ -531,36 +503,16 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>deltaTime</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Time in milliseconds since last frame.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Time physically elapsed since the last rendering frame in milliseconds.</p></td>
 </tr>
 </tbody>
 </table>
 <hr>
 </div>
-<div class="sect2">
-<h3 id="shouldtick-boolean"><a class="link" href="#shouldtick-boolean">3.2. <code>shouldTick(): boolean</code></a></h3>
-<div class="paragraph">
-<p>Returns <code>true</code> if the tick accumulator has exceeded the <code>tickInterval</code>, indicating a logic update is due.</p>
-</div>
-<div class="paragraph">
-<p><strong>Returns</strong></p>
-</div>
-<div class="paragraph">
-<p><code>boolean</code> - <code>true</code> if a tick should occur.</p>
-</div>
-<hr>
-</div>
-<div class="sect2">
-<h3 id="reset-void"><a class="link" href="#reset-void">3.3. <code>reset(): void</code></a></h3>
+<div class="sect3">
+<h4 id="accumulatedeltatime-number-void"><a class="link" href="#accumulatedeltatime-number-void">2.1.2. <code>accumulate(deltaTime: number): void</code></a></h4>
 <div class="paragraph">
-<p>Clears the tick accumulator and resets global time counters. Useful during game restarts.</p>
-</div>
-<hr>
-</div>
-<div class="sect2">
-<h3 id="istickeveryinterval-number-boolean"><a class="link" href="#istickeveryinterval-number-boolean">3.4. <code>isTickEvery(interval: number): boolean</code></a></h3>
-<div class="paragraph">
-<p>Returns <code>true</code> if the <code>totalTicks</code> is a multiple of the specified <code>interval</code>. Useful for scheduling recurring game events.</p>
+<p>Adds elapsed time to the simulation accumulator.</p>
 </div>
 <div class="paragraph">
 <p><strong>Parameters</strong></p>
@@ -578,53 +530,41 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>interval</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>deltaTime</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The tick frequency to check.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Time in milliseconds to add to the simulation.</p></td>
 </tr>
 </tbody>
 </table>
+<hr>
+</div>
+<div class="sect3">
+<h4 id="shouldtick-boolean"><a class="link" href="#shouldtick-boolean">2.1.3. <code>shouldTick(): boolean</code></a></h4>
+<div class="paragraph">
+<p>Evaluates if a logical simulation tick should be executed.</p>
+</div>
 <div class="paragraph">
 <p><strong>Returns</strong></p>
 </div>
 <div class="paragraph">
-<p><code>boolean</code> - <code>true</code> if the current tick is a multiple of the interval (and greater than 0).</p>
+<p><code>boolean</code> - <code>true</code> if at least one tick was consumed.</p>
 </div>
 <hr>
 </div>
-<div class="sect2">
-<h3 id="incrementtickintervalamount-number-void"><a class="link" href="#incrementtickintervalamount-number-void">3.5. <code>incrementTickInterval(amount: number): void</code></a></h3>
-<div class="paragraph">
-<p>Slows down the game by increasing the time between ticks.</p>
-</div>
+<div class="sect3">
+<h4 id="reset-void"><a class="link" href="#reset-void">2.1.4. <code>reset(): void</code></a></h4>
 <div class="paragraph">
-<p><strong>Parameters</strong></p>
+<p>Resets all internal timers and counters.</p>
 </div>
-<table class="tableblock frame-all grid-all stretch">
-<colgroup>
-<col style="width: 20%;">
-<col style="width: 20%;">
-<col style="width: 60%;">
-</colgroup>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>amount</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Milliseconds to add to the interval.</p></td>
-</tr>
-</tbody>
-</table>
 <hr>
 </div>
+</div>
 <div class="sect2">
-<h3 id="decrementtickintervalamount-number-void"><a class="link" href="#decrementtickintervalamount-number-void">3.6. <code>decrementTickInterval(amount: number): void</code></a></h3>
+<h3 id="declarative-api"><a class="link" href="#declarative-api">2.2. Declarative API</a></h3>
+<div class="sect3">
+<h4 id="atintervalms-number-boolean"><a class="link" href="#atintervalms-number-boolean">2.2.1. <code>atInterval(ms: number): boolean</code></a></h4>
 <div class="paragraph">
-<p>Speeds up the game by decreasing the time between ticks.</p>
+<p>Checks if the logical clock has crossed a millisecond interval.</p>
 </div>
 <div class="paragraph">
 <p><strong>Parameters</strong></p>
@@ -642,47 +582,24 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>amount</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ms</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Milliseconds to subtract from the interval.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The millisecond interval to check.</p></td>
 </tr>
 </tbody>
 </table>
-<hr>
-</div>
-<div class="sect2">
-<h3 id="settickintervalinterval-number-void"><a class="link" href="#settickintervalinterval-number-void">3.7. <code>setTickInterval(interval: number): void</code></a></h3>
 <div class="paragraph">
-<p>Sets the tick interval exactly to the specified value.</p>
+<p><strong>Returns</strong></p>
 </div>
 <div class="paragraph">
-<p><strong>Parameters</strong></p>
+<p><code>boolean</code> - <code>true</code> if the interval boundary was crossed.</p>
 </div>
-<table class="tableblock frame-all grid-all stretch">
-<colgroup>
-<col style="width: 20%;">
-<col style="width: 20%;">
-<col style="width: 60%;">
-</colgroup>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>interval</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The new interval between logic updates (in milliseconds).</p></td>
-</tr>
-</tbody>
-</table>
 <hr>
 </div>
-<div class="sect2">
-<h3 id="setmintickintervalinterval-number-void"><a class="link" href="#setmintickintervalinterval-number-void">3.8. <code>setMinTickInterval(interval: number): void</code></a></h3>
+<div class="sect3">
+<h4 id="everyms-number-action-void-void"><a class="link" href="#everyms-number-action-void-void">2.2.2. <code>every(ms: number, action: () &#8658; void): void</code></a></h4>
 <div class="paragraph">
-<p>Sets the minimum limit for the tick interval, preventing the game from speeding up beyond this point.</p>
+<p>Executes a callback every N milliseconds of logical game time.</p>
 </div>
 <div class="paragraph">
 <p><strong>Parameters</strong></p>
@@ -700,27 +617,26 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>interval</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ms</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The minimum interval allowed (in milliseconds).</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Millisecond interval.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>action</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>() &#8658; void</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Callback function.</p></td>
 </tr>
 </tbody>
 </table>
-<hr>
-</div>
-<div class="sect2">
-<h3 id="captureinitialstate-void"><a class="link" href="#captureinitialstate-void">3.9. <code>captureInitialState(): void</code></a></h3>
-<div class="paragraph">
-<p>Captures the current <code>tickInterval</code> as the initial state. This should be called after a game has performed its specific initialization to ensure that future resets restore the correct starting speed.</p>
 </div>
 </div>
 </div>
 </div>
 <div class="sect1">
-<h2 id="general-usage"><a class="link" href="#general-usage">4. General Usage</a></h2>
+<h2 id="general-usage"><a class="link" href="#general-usage">3. General Usage</a></h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p>Implemented by <code><a href="../../modules/GameTime.html">GameTime</a></code>. This module ensures that game logic (like falling pieces) runs at a consistent speed regardless of the render frame rate.</p>
+<p>Implemented by <code><a href="../../modules/GameTime.html">GameTime</a></code>. This interface allows other modules to depend on a standardized timing contract without being tied to a specific implementation.</p>
 </div>
 </div>
 </div>

package/dist/docs/reference/modules/GameEventRegistry.html

@@ -448,7 +448,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <li><a href="#api-reference">3. API Reference</a>
 <ul class="sectlevel2">
 <li><a href="#setupcontroleventsmodules-gamemodules-onreset-void-void">3.1. <code>setupControlEvents(modules: GameModules, onReset: () &#8658; void): void</code></a></li>
-<li><a href="#setupstateeventsmodules-gamemodules-void">3.2. <code>setupStateEvents(modules: GameModules): void</code></a></li>
+<li><a href="#setupstateeventsmodules-gamemodules-view-gameview-void">3.2. <code>setupStateEvents(modules: GameModules, view: GameView): void</code></a></li>
 </ul>
 </li>
 </ul>
@@ -534,9 +534,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <hr>
 </div>
 <div class="sect2">
-<h3 id="setupstateeventsmodules-gamemodules-void"><a class="link" href="#setupstateeventsmodules-gamemodules-void">3.2. <code>setupStateEvents(modules: GameModules): void</code></a></h3>
+<h3 id="setupstateeventsmodules-gamemodules-view-gameview-void"><a class="link" href="#setupstateeventsmodules-gamemodules-view-gameview-void">3.2. <code>setupStateEvents(modules: GameModules, view: <a href="../view/GameView.html">GameView</a>): void</code></a></h3>
 <div class="paragraph">
-<p>Sets up all system-level state property subscriptions. Binds lifecycle behaviors to state property changes, such as clearing current session data upon encountering Game Over, or fully purging rendering/grid variables when the system is virtually powered down.</p>
+<p>Sets up all system-level state property subscriptions. Binds lifecycle behaviors to state property changes, such as clearing current session data upon encountering Game Over, fully purging rendering/grid variables when the system is virtually powered down, or toggling the trackpad layout.</p>
 </div>
 <div class="paragraph">
 <p><strong>Parameters</strong></p>
@@ -558,6 +558,11 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../types/GameModules.html">GameModules</a></code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">The structured collection of engine modules.</p></td>
 </tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>view</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../view/GameView.html">GameView</a></code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The active game view to notify about visual state changes.</p></td>
+</tr>
 </tbody>
 </table>
 <div class="paragraph">
@@ -566,7 +571,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <div class="paragraph">
 <p>Registers listeners for:
 *   <code>StateProperty.ON</code>: Resets all modules when the system is turned off.
-*   <code>StateProperty.GAME_OVER</code>: Clears the session when the player loses.</p>
+*   <code>StateProperty.GAME_OVER</code>: Clears the session when the player loses.
+*   <code>StateProperty.TRACKPAD</code>: Toggles the trackpad layout mode.</p>
 </div>
 <hr>
 </div>