brick-engine-js 1.0.21 → 1.0.23

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

@@ -443,24 +443,28 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
 <ul class="sectlevel1">
-<li><a href="#properties">1. Properties</a></li>
-<li><a href="#methods">2. Methods</a>
+<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>
 <ul class="sectlevel2">
-<li><a href="#updatedeltatime-number-void">2.1. <code>update(deltaTime: number): void</code></a></li>
-<li><a href="#shouldtick-boolean">2.2. <code>shouldTick(): boolean</code></a></li>
-<li><a href="#reset-void">2.3. <code>reset(): void</code></a></li>
-<li><a href="#incrementtickintervalamount-number-void">2.4. <code>incrementTickInterval(amount: number): void</code></a></li>
-<li><a href="#decrementtickintervalamount-number-void">2.5. <code>decrementTickInterval(amount: number): void</code></a></li>
-<li><a href="#settickintervalinterval-number-void">2.6. <code>setTickInterval(interval: number): void</code></a></li>
-<li><a href="#setmintickintervalinterval-number-void">2.7. <code>setMinTickInterval(interval: number): void</code></a></li>
+<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>
 </ul>
 </li>
-<li><a href="#general-usage">3. General Usage</a></li>
+<li><a href="#general-usage">4. General Usage</a></li>
 </ul>
 </div>
 </div>
 <div id="content">
-<div id="preamble">
+<div class="sect1">
+<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>
@@ -468,7 +472,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 </div>
 </div>
 <div class="sect1">
-<h2 id="properties"><a class="link" href="#properties">1. Properties</a></h2>
+<h2 id="properties"><a class="link" href="#properties">2. Properties</a></h2>
 <div class="sectionbody">
 <table class="tableblock frame-all grid-all stretch">
 <colgroup>
@@ -487,17 +491,27 @@ 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>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">2. Methods</a></h2>
+<h2 id="methods"><a class="link" href="#methods">3. Methods</a></h2>
 <div class="sectionbody">
 <div class="sect2">
-<h3 id="updatedeltatime-number-void"><a class="link" href="#updatedeltatime-number-void">2.1. <code>update(deltaTime: number): void</code></a></h3>
+<h3 id="updatedeltatime-number-void"><a class="link" href="#updatedeltatime-number-void">3.1. <code>update(deltaTime: number): void</code></a></h3>
 <div class="paragraph">
-<p>Adds elapsed time to the internal accumulator. Called every frame.</p>
+<p>Adds elapsed time to the internal tick accumulator. Called every frame.</p>
 </div>
 <div class="paragraph">
 <p><strong>Parameters</strong></p>
@@ -524,9 +538,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <hr>
 </div>
 <div class="sect2">
-<h3 id="shouldtick-boolean"><a class="link" href="#shouldtick-boolean">2.2. <code>shouldTick(): boolean</code></a></h3>
+<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 accumulator has exceeded the <code>tickInterval</code>, indicating a logic update is due.</p>
+<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>
@@ -537,14 +551,49 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <hr>
 </div>
 <div class="sect2">
-<h3 id="reset-void"><a class="link" href="#reset-void">2.3. <code>reset(): void</code></a></h3>
+<h3 id="reset-void"><a class="link" href="#reset-void">3.3. <code>reset(): void</code></a></h3>
 <div class="paragraph">
-<p>Clears the time accumulator. Useful during game restarts.</p>
+<p>Clears the tick accumulator and resets global time counters. Useful during game restarts.</p>
 </div>
 <hr>
 </div>
 <div class="sect2">
-<h3 id="incrementtickintervalamount-number-void"><a class="link" href="#incrementtickintervalamount-number-void">2.4. <code>incrementTickInterval(amount: number): void</code></a></h3>
+<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>
+</div>
+<div class="paragraph">
+<p><strong>Parameters</strong></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 tick frequency to check.</p></td>
+</tr>
+</tbody>
+</table>
+<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>
+</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>
@@ -573,7 +622,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <hr>
 </div>
 <div class="sect2">
-<h3 id="decrementtickintervalamount-number-void"><a class="link" href="#decrementtickintervalamount-number-void">2.5. <code>decrementTickInterval(amount: number): void</code></a></h3>
+<h3 id="decrementtickintervalamount-number-void"><a class="link" href="#decrementtickintervalamount-number-void">3.6. <code>decrementTickInterval(amount: number): void</code></a></h3>
 <div class="paragraph">
 <p>Speeds up the game by decreasing the time between ticks.</p>
 </div>
@@ -602,7 +651,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <hr>
 </div>
 <div class="sect2">
-<h3 id="settickintervalinterval-number-void"><a class="link" href="#settickintervalinterval-number-void">2.6. <code>setTickInterval(interval: number): void</code></a></h3>
+<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>
 </div>
@@ -631,7 +680,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <hr>
 </div>
 <div class="sect2">
-<h3 id="setmintickintervalinterval-number-void"><a class="link" href="#setmintickintervalinterval-number-void">2.7. <code>setMinTickInterval(interval: number): void</code></a></h3>
+<h3 id="setmintickintervalinterval-number-void"><a class="link" href="#setmintickintervalinterval-number-void">3.8. <code>setMinTickInterval(interval: number): void</code></a></h3>
 <div class="paragraph">
 <p>Sets the minimum limit for the tick interval, preventing the game from speeding up beyond this point.</p>
 </div>
@@ -657,11 +706,18 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 </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">3. General Usage</a></h2>
+<h2 id="general-usage"><a class="link" href="#general-usage">4. 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>

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

@@ -443,31 +443,33 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
 <ul class="sectlevel1">
-<li><a href="#api-reference">1. API Reference</a>
+<li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
+<li><a href="#api-reference">2. API Reference</a>
 <ul class="sectlevel2">
-<li><a href="#setup-void">1.1. <code>setup(): void</code></a></li>
-<li><a href="#setgamemodulesgamemodules-gamemodules-void">1.2. <code>setGameModules(gameModules: GameModules): void</code></a></li>
-<li><a href="#update-promisevoid">1.3. <code>update(): Promise&lt;void&gt;</code></a></li>
+<li><a href="#setup-void">2.1. <code>setup(): void</code></a></li>
+<li><a href="#setgamemodulesgamemodules-gamemodules-void">2.2. <code>setGameModules(gameModules: GameModules): void</code></a></li>
+<li><a href="#update-promisevoid">2.3. <code>update(): Promise&lt;void&gt;</code></a></li>
 </ul>
 </li>
-<li><a href="#configuration">2. Configuration</a></li>
-<li><a href="#implementation">3. Implementation</a></li>
+<li><a href="#configuration">3. Configuration</a></li>
+<li><a href="#implementation">4. Implementation</a></li>
 </ul>
 </div>
 </div>
 <div id="content">
-<div id="preamble">
+<div class="sect1">
+<h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p>The <code>Debugger</code> class provides a real-time, HTML-based overlay for monitoring the state of all engine modules. It automatically identifies and extracts data from any module that implements the <code><a href="../interfaces/Debuggable.html">Debuggable</a></code> interface.</p>
+<p>The <code>Debugger</code> module establishes an isolated inspection perimeter generating <code>&lt;details&gt;</code> tags mirroring runtime property values. Its architecture separates text-rendering diagnostics strictly from the hardware-accelerated Canvas loop allowing it to freely display un-optimized dynamic string representations of data models (<code><a href="../interfaces/Debuggable.html">Debuggable</a></code>) without plummeting framerates dragging continuous geometric translations.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
-<h2 id="api-reference"><a class="link" href="#api-reference">1. API Reference</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="setup-void"><a class="link" href="#setup-void">1.1. <code>setup(): void</code></a></h3>
+<h3 id="setup-void"><a class="link" href="#setup-void">2.1. <code>setup(): void</code></a></h3>
 <div class="paragraph">
 <p>Initializes the debugger&#8217;s DOM structure.</p>
 </div>
@@ -480,7 +482,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <hr>
 </div>
 <div class="sect2">
-<h3 id="setgamemodulesgamemodules-gamemodules-void"><a class="link" href="#setgamemodulesgamemodules-gamemodules-void">1.2. <code>setGameModules(gameModules: GameModules): void</code></a></h3>
+<h3 id="setgamemodulesgamemodules-gamemodules-void"><a class="link" href="#setgamemodulesgamemodules-gamemodules-void">2.2. <code>setGameModules(gameModules: GameModules): void</code></a></h3>
 <div class="paragraph">
 <p>Updates the active game modules being monitored by the debugger.</p>
 </div>
@@ -517,7 +519,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <hr>
 </div>
 <div class="sect2">
-<h3 id="update-promisevoid"><a class="link" href="#update-promisevoid">1.3. <code>update(): Promise&lt;void&gt;</code></a></h3>
+<h3 id="update-promisevoid"><a class="link" href="#update-promisevoid">2.3. <code>update(): Promise&lt;void&gt;</code></a></h3>
 <div class="paragraph">
 <p>Refreshes the overlay with new data from the modules.</p>
 </div>
@@ -531,7 +533,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 </div>
 </div>
 <div class="sect1">
-<h2 id="configuration"><a class="link" href="#configuration">2. Configuration</a></h2>
+<h2 id="configuration"><a class="link" href="#configuration">3. Configuration</a></h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>The debugger behavior is controlled via the main <code>configs.ts</code> file:</p>
@@ -549,7 +551,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 </div>
 </div>
 <div class="sect1">
-<h2 id="implementation"><a class="link" href="#implementation">3. Implementation</a></h2>
+<h2 id="implementation"><a class="link" href="#implementation">4. Implementation</a></h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>Modules wishing to appear in the debugger must implement the <code>Debuggable</code> interface:</p>

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

@@ -443,28 +443,30 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
 <ul class="sectlevel1">
-<li><a href="#api-reference">1. API Reference</a>
+<li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
+<li><a href="#api-reference">2. API Reference</a>
 <ul class="sectlevel2">
-<li><a href="#setuprenderermetrics-renderermetrics-void">1.1. <code>setup(rendererMetrics: RendererMetrics): void</code></a></li>
-<li><a href="#rendergrid-cell-void">1.2. <code>render(grid: Cell[][]): void</code></a></li>
+<li><a href="#setuprenderermetrics-renderermetrics-void">2.1. <code>setup(rendererMetrics: RendererMetrics): void</code></a></li>
+<li><a href="#rendergrid-cell-void">2.2. <code>render(grid: Cell[][]): void</code></a></li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
 <div id="content">
-<div id="preamble">
+<div class="sect1">
+<h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p>The <code>DisplayRenderer</code> is responsible for drawing the main game grid and the active bricks. It implements the standard <code><a href="../interfaces/modules/Renderer.html">Renderer</a></code> interface and is managed by the <code><a href="GameRenderer.html">GameRenderer</a></code>.</p>
+<p>The <code>DisplayRenderer</code> is a dedicated visual presentation component completely isolated from gameplay logic. It translates logical cell matrix data directly into pixel payloads, leveraging hardware-accelerated drawing contexts. By pre-building a static background image buffer, it guarantees the volatile foreground update loop exclusively processes the minimum amount of dynamic rectangles required, aggressively reducing power consumption.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
-<h2 id="api-reference"><a class="link" href="#api-reference">1. API Reference</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="setuprenderermetrics-renderermetrics-void"><a class="link" href="#setuprenderermetrics-renderermetrics-void">1.1. <code>setup(rendererMetrics: RendererMetrics): void</code></a></h3>
+<h3 id="setuprenderermetrics-renderermetrics-void"><a class="link" href="#setuprenderermetrics-renderermetrics-void">2.1. <code>setup(rendererMetrics: RendererMetrics): void</code></a></h3>
 <div class="paragraph">
 <p>Initializes the renderer and pre-calculates the static scene.</p>
 </div>
@@ -499,7 +501,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <hr>
 </div>
 <div class="sect2">
-<h3 id="rendergrid-cell-void"><a class="link" href="#rendergrid-cell-void">1.2. <code>render(grid: Cell[][]): void</code></a></h3>
+<h3 id="rendergrid-cell-void"><a class="link" href="#rendergrid-cell-void">2.2. <code>render(grid: Cell[][]): void</code></a></h3>
 <div class="paragraph">
 <p>Executes the main display drawing logic.</p>
 </div>

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

@@ -443,29 +443,31 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
 <ul class="sectlevel1">
-<li><a href="#contextual-notification-system">1. Contextual Notification System</a></li>
-<li><a href="#api-reference">2. API Reference</a>
+<li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
+<li><a href="#contextual-notification-system">2. Contextual Notification System</a></li>
+<li><a href="#api-reference">3. API Reference</a>
 <ul class="sectlevel2">
-<li><a href="#subscribeeventname-string-callback-eventcallbackt-suffix-eventsuffix-void">2.1. <code>subscribe(eventName: string, callback: EventCallback&lt;T&gt;, suffix?: EventSuffix): void</code></a></li>
-<li><a href="#unsubscribeeventname-string-callback-eventcallbackt-suffix-eventsuffix-void">2.2. <code>unsubscribe(eventName: string, callback: EventCallback&lt;T&gt;, suffix?: EventSuffix): void</code></a></li>
-<li><a href="#notifyeventname-string-payload-t-void">2.3. <code>notify(eventName: string, payload: T): void</code></a></li>
-<li><a href="#notifycontextualeventname-string-payload-t-context-statecontext-void">2.4. <code>notifyContextual(eventName: string, payload: T, context: StateContext): void</code></a></li>
+<li><a href="#subscribeeventname-string-callback-eventcallbackt-suffix-eventsuffix-void">3.1. <code>subscribe(eventName: string, callback: EventCallback&lt;T&gt;, suffix?: EventSuffix): void</code></a></li>
+<li><a href="#unsubscribeeventname-string-callback-eventcallbackt-suffix-eventsuffix-void">3.2. <code>unsubscribe(eventName: string, callback: EventCallback&lt;T&gt;, suffix?: EventSuffix): void</code></a></li>
+<li><a href="#notifyeventname-string-payload-t-void">3.3. <code>notify(eventName: string, payload: T): void</code></a></li>
+<li><a href="#notifycontextualeventname-string-payload-t-context-statecontext-void">3.4. <code>notifyContextual(eventName: string, payload: T, context: StateContext): void</code></a></li>
 </ul>
 </li>
-<li><a href="#internal-name-formatting">3. Internal Name Formatting</a></li>
+<li><a href="#internal-name-formatting">4. Internal Name Formatting</a></li>
 </ul>
 </div>
 </div>
 <div id="content">
-<div id="preamble">
+<div class="sect1">
+<h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p>The <code>EventEmitter</code> is the backbone of the engine&#8217;s reactive architecture. It allows modules to communicate without direct dependencies and supports <strong>Contextual Notifications</strong> that automatically target specific game states (e.g., Playing vs. Paused).</p>
+<p>The <code>EventEmitter</code> acts as the centralized communication backbone of the engine reactor. It allows entirely decoupled modules to hook into each other&#8217;s lifecycles without direct direct method calls. By supporting <strong>Contextual Notifications</strong>, it prevents tight coupling and enables dynamic routing where events can automatically target specific game active states (e.g., Playing vs. Paused).</p>
 </div>
 </div>
 </div>
 <div class="sect1">
-<h2 id="contextual-notification-system"><a class="link" href="#contextual-notification-system">1. Contextual Notification System</a></h2>
+<h2 id="contextual-notification-system"><a class="link" href="#contextual-notification-system">2. Contextual Notification System</a></h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>The <code>EventEmitter</code> extends simple pub/sub by supporting event suffixes. When a module notifies a "contextual" event, the emitter propagates the signal to:
@@ -479,12 +481,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 </div>
 </div>
 <div class="sect1">
-<h2 id="api-reference"><a class="link" href="#api-reference">2. API Reference</a></h2>
+<h2 id="api-reference"><a class="link" href="#api-reference">3. API Reference</a></h2>
 <div class="sectionbody">
 <div class="sect2">
-<h3 id="subscribeeventname-string-callback-eventcallbackt-suffix-eventsuffix-void"><a class="link" href="#subscribeeventname-string-callback-eventcallbackt-suffix-eventsuffix-void">2.1. <code>subscribe(eventName: string, callback: EventCallback&lt;T&gt;, suffix?: EventSuffix): void</code></a></h3>
+<h3 id="subscribeeventname-string-callback-eventcallbackt-suffix-eventsuffix-void"><a class="link" href="#subscribeeventname-string-callback-eventcallbackt-suffix-eventsuffix-void">3.1. <code>subscribe(eventName: string, callback: EventCallback&lt;T&gt;, suffix?: EventSuffix): void</code></a></h3>
 <div class="paragraph">
-<p>Registers a listener for a specific event.</p>
+<p>Registers a listener callback to be executed whenever the specified event is emitted. If a <code>EventSuffix</code> is provided, it subscribes to the contextual sub-channel (e.g. <code>UP:playing</code>) instead of the base channel.</p>
 </div>
 <div class="paragraph">
 <p><strong>Parameters</strong></p>
@@ -504,40 +506,46 @@ 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>eventName</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>string</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The base name of the event.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The base string identifier of the event to listen for.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>callback</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Function</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The function to execute.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The function to execute when the event triggers. Receives the payload if applicable.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>suffix</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/EventSuffix.html">EventSuffix</a></code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">(Optional) The context suffix (e.g., <code>EventSuffix.PAUSED</code>).</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">(Optional) The context restricted modifier to listen only on specific lifecycle states.</p></td>
 </tr>
 </tbody>
 </table>
 <hr>
 </div>
 <div class="sect2">
-<h3 id="unsubscribeeventname-string-callback-eventcallbackt-suffix-eventsuffix-void"><a class="link" href="#unsubscribeeventname-string-callback-eventcallbackt-suffix-eventsuffix-void">2.2. <code>unsubscribe(eventName: string, callback: EventCallback&lt;T&gt;, suffix?: EventSuffix): void</code></a></h3>
+<h3 id="unsubscribeeventname-string-callback-eventcallbackt-suffix-eventsuffix-void"><a class="link" href="#unsubscribeeventname-string-callback-eventcallbackt-suffix-eventsuffix-void">3.2. <code>unsubscribe(eventName: string, callback: EventCallback&lt;T&gt;, suffix?: EventSuffix): void</code></a></h3>
 <div class="paragraph">
-<p>Removes a registration. The suffix must match the one used during subscription.</p>
+<p>Safely removes the provided callback from the notification queue. The exact function reference must be used. If the event was subscribed with a suffix, the same suffix must be provided here to target the correct sub-channel.</p>
 </div>
 <hr>
 </div>
 <div class="sect2">
-<h3 id="notifyeventname-string-payload-t-void"><a class="link" href="#notifyeventname-string-payload-t-void">2.3. <code>notify(eventName: string, payload: T): void</code></a></h3>
+<h3 id="notifyeventname-string-payload-t-void"><a class="link" href="#notifyeventname-string-payload-t-void">3.3. <code>notify(eventName: string, payload: T): void</code></a></h3>
+<div class="paragraph">
+<p><strong>Behavior</strong></p>
+</div>
 <div class="paragraph">
-<p>Dispatches an event to the base channel.</p>
+<p>Iterates over all callbacks associated with the given channel key and invokes them sequentially with the provided payload. This acts strictly on the base channel without evaluating current game states.</p>
 </div>
 <hr>
 </div>
 <div class="sect2">
-<h3 id="notifycontextualeventname-string-payload-t-context-statecontext-void"><a class="link" href="#notifycontextualeventname-string-payload-t-context-statecontext-void">2.4. <code>notifyContextual(eventName: string, payload: T, context: StateContext): void</code></a></h3>
+<h3 id="notifycontextualeventname-string-payload-t-context-statecontext-void"><a class="link" href="#notifycontextualeventname-string-payload-t-context-statecontext-void">3.4. <code>notifyContextual(eventName: string, payload: T, context: StateContext): void</code></a></h3>
+<div class="paragraph">
+<p><strong>Behavior</strong></p>
+</div>
 <div class="paragraph">
-<p>Dispatches an event to the base channel AND an appropriate state-specific channel.</p>
+<p>Performs a standard notify on the base <code>eventName</code>, and then evaluates the provided <code><a href="../interfaces/StateContext.html">StateContext</a></code> to decide which secondary <code><a href="../enums/EventSuffix.html">EventSuffix</a></code> channel should also receive the payload. This enables multi-cast signals where listeners can opt into receiving only under certain states.</p>
 </div>
 <div class="paragraph">
 <p><strong>Parameters</strong></p>
@@ -557,17 +565,17 @@ 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>eventName</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>string</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The base name.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The core string identifier of the event broadcast.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>payload</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>any</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The data to pass.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The required event data to be passed to callbacks in both base and context channels.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>context</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../interfaces/StateContext.html">StateContext</a></code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The current engine context.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The engine state provider used to determine applicable conditions (Playing, Paused, Title, Gameover).</p></td>
 </tr>
 </tbody>
 </table>
@@ -595,7 +603,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 </div>
 </div>
 <div class="sect1">
-<h2 id="internal-name-formatting"><a class="link" href="#internal-name-formatting">3. Internal Name Formatting</a></h2>
+<h2 id="internal-name-formatting"><a class="link" href="#internal-name-formatting">4. Internal Name Formatting</a></h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>The <code>EventEmitter</code> encapsulates its naming convention within a private <code>_formatName</code> method. The current standard uses a colon separator:</p>