brick-engine-js 1.0.22 → 1.0.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.adoc +2 -2
- package/dist/docs/index.html +3 -3
- package/dist/docs/jsdoc_standard.html +30 -13
- package/dist/docs/reference/bootstrap.html +556 -0
- package/dist/docs/reference/context/RendererContext.html +19 -9
- package/dist/docs/reference/enums/Color.html +11 -5
- package/dist/docs/reference/enums/ControlEventType.html +7 -5
- package/dist/docs/reference/enums/ControlKey.html +7 -5
- package/dist/docs/reference/enums/EventSuffix.html +7 -5
- package/dist/docs/reference/enums/FontAlignment.html +9 -7
- package/dist/docs/reference/enums/FontSize.html +7 -5
- package/dist/docs/reference/enums/Sound.html +7 -5
- package/dist/docs/reference/enums/StateProperty.html +7 -5
- package/dist/docs/reference/helpers/CellHelper.html +6 -2
- package/dist/docs/reference/helpers/ControlInputHandlerHelper.html +9 -5
- package/dist/docs/reference/helpers/CoordinateHelper.html +14 -10
- package/dist/docs/reference/helpers/RelativeValuesHelper.html +7 -3
- package/dist/docs/reference/interfaces/Debuggable.html +9 -7
- package/dist/docs/reference/interfaces/GameModules.html +7 -5
- package/dist/docs/reference/interfaces/Initializable.html +9 -7
- package/dist/docs/reference/interfaces/RendererInitializable.html +9 -7
- package/dist/docs/reference/interfaces/StateContext.html +7 -5
- package/dist/docs/reference/interfaces/StateSyncable.html +11 -9
- package/dist/docs/reference/interfaces/modules/Control.html +19 -17
- package/dist/docs/reference/interfaces/modules/Grid.html +77 -55
- package/dist/docs/reference/interfaces/modules/Renderer.html +9 -7
- package/dist/docs/reference/interfaces/modules/RendererComposite.html +13 -11
- package/dist/docs/reference/interfaces/modules/Score.html +21 -19
- package/dist/docs/reference/interfaces/modules/Session.html +64 -18
- package/dist/docs/reference/interfaces/modules/State.html +59 -57
- package/dist/docs/reference/interfaces/modules/Text.html +21 -19
- package/dist/docs/reference/interfaces/modules/Time.html +80 -24
- package/dist/docs/reference/modules/Debugger.html +16 -14
- package/dist/docs/reference/modules/DisplayRenderer.html +10 -8
- package/dist/docs/reference/modules/EventEmitter.html +34 -26
- package/dist/docs/reference/modules/Game.html +55 -30
- package/dist/docs/reference/modules/GameControl.html +49 -44
- package/dist/docs/reference/modules/GameEventRegistry.html +17 -34
- package/dist/docs/reference/modules/GameGrid.html +174 -116
- package/dist/docs/reference/modules/GameHudGrid.html +10 -8
- package/dist/docs/reference/modules/GameRenderer.html +14 -12
- package/dist/docs/reference/modules/GameScore.html +36 -34
- package/dist/docs/reference/modules/GameSession.html +37 -19
- package/dist/docs/reference/modules/GameSound.html +20 -18
- package/dist/docs/reference/modules/GameState.html +70 -68
- package/dist/docs/reference/modules/GameText.html +29 -27
- package/dist/docs/reference/modules/GameTime.html +98 -30
- package/dist/docs/reference/modules/HudRenderer.html +10 -8
- package/dist/docs/reference/modules/InitialStateSnapshot.html +13 -11
- package/dist/docs/reference/modules/SessionModal.html +11 -9
- package/dist/docs/reference/types/Axis.html +7 -5
- package/dist/docs/reference/types/Cell.html +7 -5
- package/dist/docs/reference/types/ControlCallback.html +7 -5
- package/dist/docs/reference/types/Coordinate.html +7 -5
- package/dist/docs/reference/types/GameEvent.html +7 -5
- package/dist/docs/reference/types/Piece.html +7 -5
- package/dist/docs/reference/types/RendererMetrics.html +7 -5
- package/dist/docs/reference/types/Vector.html +7 -5
- package/dist/docs/reference/view/GameView.html +29 -21
- package/dist/docs/testing_best_practices.html +2 -2
- package/dist/game.bundle.js +1 -1
- package/dist/types/bootstrap.d.ts +12 -11
- package/dist/types/core/Game.d.ts +46 -39
- package/dist/types/core/InitialStateSnapshot.d.ts +18 -6
- package/dist/types/core/context/RendererContext.d.ts +32 -10
- package/dist/types/core/event/EventEmitter.d.ts +64 -21
- package/dist/types/core/event/GameEventRegistry.d.ts +17 -3
- package/dist/types/core/helpers/CellHelper.d.ts +11 -4
- package/dist/types/core/helpers/ControlInputHandlerHelper.d.ts +20 -11
- package/dist/types/core/helpers/CoordinateHelper.d.ts +28 -23
- package/dist/types/core/helpers/InterfaceIdentifierHelper.d.ts +34 -0
- package/dist/types/core/helpers/RelativeValuesHelper.d.ts +10 -8
- package/dist/types/core/module/control/GameControl.d.ts +26 -14
- package/dist/types/core/module/grid/GameGrid.d.ts +68 -53
- package/dist/types/core/module/grid/GameHudGrid.d.ts +9 -7
- package/dist/types/core/module/grid/engines/GridAnalysisEngine.d.ts +25 -6
- package/dist/types/core/module/grid/engines/GridLineEngine.d.ts +51 -13
- package/dist/types/core/module/grid/engines/GridMovementEngine.d.ts +97 -13
- package/dist/types/core/module/grid/engines/GridRegionEngine.d.ts +24 -5
- package/dist/types/core/module/grid/engines/GridTransformEngine.d.ts +21 -5
- package/dist/types/core/module/renderer/DisplayRenderer.d.ts +27 -15
- package/dist/types/core/module/renderer/GameRenderer.d.ts +20 -13
- package/dist/types/core/module/renderer/HudRenderer.d.ts +27 -19
- package/dist/types/core/module/score/GameScore.d.ts +29 -18
- package/dist/types/core/module/session/GameSession.d.ts +56 -0
- package/dist/types/core/module/sound/GameSound.d.ts +39 -23
- package/dist/types/core/module/state/GameState.d.ts +38 -14
- package/dist/types/core/module/text/GameText.d.ts +40 -25
- package/dist/types/core/module/time/GameTime.d.ts +23 -10
- package/dist/types/core/types/Interfaces.d.ts +15 -0
- package/dist/types/core/types/Types.d.ts +1 -0
- package/dist/types/core/types/enums.d.ts +2 -1
- package/dist/types/core/types/modules.d.ts +193 -43
- package/dist/types/view/Debugger.d.ts +23 -0
- package/dist/types/view/GameView.d.ts +44 -27
- package/dist/types/view/SessionModal.d.ts +24 -0
- package/package.json +1 -1
- package/dist/CNAME +0 -1
|
@@ -443,22 +443,24 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
443
443
|
<div id="toc" class="toc2">
|
|
444
444
|
<div id="toctitle">Table of Contents</div>
|
|
445
445
|
<ul class="sectlevel1">
|
|
446
|
-
<li><a href="#
|
|
447
|
-
<li><a href="#
|
|
448
|
-
<li><a href="#
|
|
446
|
+
<li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
|
|
447
|
+
<li><a href="#inheritance">2. Inheritance</a></li>
|
|
448
|
+
<li><a href="#usage">3. Usage</a></li>
|
|
449
|
+
<li><a href="#implementation-specifics">4. Implementation Specifics</a></li>
|
|
449
450
|
</ul>
|
|
450
451
|
</div>
|
|
451
452
|
</div>
|
|
452
453
|
<div id="content">
|
|
453
|
-
<div
|
|
454
|
+
<div class="sect1">
|
|
455
|
+
<h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
|
|
454
456
|
<div class="sectionbody">
|
|
455
457
|
<div class="paragraph">
|
|
456
|
-
<p>The <code>GameHudGrid</code>
|
|
458
|
+
<p>The <code>GameHudGrid</code> acts as a specialized engine implementation isolating the visual preview logic for upcoming pieces. By statically overriding the fluid dimensions of a standard <code>GameGrid</code> down to a strict 4x4 coordinate plane, it transparently provides rendering modules exactly the same API for iterating over cells, but guarantees the data remains segregated from the primary physics loop resolving active lines.</p>
|
|
457
459
|
</div>
|
|
458
460
|
</div>
|
|
459
461
|
</div>
|
|
460
462
|
<div class="sect1">
|
|
461
|
-
<h2 id="inheritance"><a class="link" href="#inheritance">
|
|
463
|
+
<h2 id="inheritance"><a class="link" href="#inheritance">2. Inheritance</a></h2>
|
|
462
464
|
<div class="sectionbody">
|
|
463
465
|
<div class="paragraph">
|
|
464
466
|
<p><code>GameHudGrid</code> extends <a href="GameGrid.html">GameGrid</a>. It inherits all methods for filling areas, stamping pieces, and checking occupancy.</p>
|
|
@@ -466,7 +468,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
466
468
|
</div>
|
|
467
469
|
</div>
|
|
468
470
|
<div class="sect1">
|
|
469
|
-
<h2 id="usage"><a class="link" href="#usage">
|
|
471
|
+
<h2 id="usage"><a class="link" href="#usage">3. Usage</a></h2>
|
|
470
472
|
<div class="sectionbody">
|
|
471
473
|
<div class="paragraph">
|
|
472
474
|
<p>Accessible via <code>modules.hudGrid</code>.</p>
|
|
@@ -485,7 +487,7 @@ hudGrid.stampPiece(nextPieceCoords, 1, Color.BLUE);</code></pre>
|
|
|
485
487
|
</div>
|
|
486
488
|
</div>
|
|
487
489
|
<div class="sect1">
|
|
488
|
-
<h2 id="implementation-specifics"><a class="link" href="#implementation-specifics">
|
|
490
|
+
<h2 id="implementation-specifics"><a class="link" href="#implementation-specifics">4. Implementation Specifics</a></h2>
|
|
489
491
|
<div class="sectionbody">
|
|
490
492
|
<div class="paragraph">
|
|
491
493
|
<p>The <code>GameHudGrid</code> overrides the dimensions provided in the global configuration, strictly enforcing a 4x4 matrix. This ensures consistency for HUD-specific rendering logic.</p>
|
|
@@ -443,30 +443,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
443
443
|
<div id="toc" class="toc2">
|
|
444
444
|
<div id="toctitle">Table of Contents</div>
|
|
445
445
|
<ul class="sectlevel1">
|
|
446
|
-
<li><a href="#
|
|
446
|
+
<li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
|
|
447
|
+
<li><a href="#api-reference">2. API Reference</a>
|
|
447
448
|
<ul class="sectlevel2">
|
|
448
|
-
<li><a href="#renderermetrics-renderermetrics">
|
|
449
|
-
<li><a href="#addrendererrenderer-renderer-void">
|
|
450
|
-
<li><a href="#rendergrid-cell-modules-gamemodules-void">
|
|
451
|
-
<li><a href="#getdebugdata-recordstring-string-number-boolean">
|
|
449
|
+
<li><a href="#renderermetrics-renderermetrics">2.1. <code>rendererMetrics: RendererMetrics</code></a></li>
|
|
450
|
+
<li><a href="#addrendererrenderer-renderer-void">2.2. <code>addRenderer(renderer: Renderer): void</code></a></li>
|
|
451
|
+
<li><a href="#rendergrid-cell-modules-gamemodules-void">2.3. <code>render(grid: Cell[][], modules: GameModules): void</code></a></li>
|
|
452
|
+
<li><a href="#getdebugdata-recordstring-string-number-boolean">2.4. <code>getDebugData(): Record<string, string | number | boolean></code></a></li>
|
|
452
453
|
</ul>
|
|
453
454
|
</li>
|
|
454
455
|
</ul>
|
|
455
456
|
</div>
|
|
456
457
|
</div>
|
|
457
458
|
<div id="content">
|
|
458
|
-
<div
|
|
459
|
+
<div class="sect1">
|
|
460
|
+
<h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
|
|
459
461
|
<div class="sectionbody">
|
|
460
462
|
<div class="paragraph">
|
|
461
|
-
<p>The <code>GameRenderer</code> module
|
|
463
|
+
<p>The <code>GameRenderer</code> module acts as the visual context manager, orchestrating composite drawing pipelines. It bridges the rigid logical <code><a href="../interfaces/modules/Grid.html">Grid</a></code> limits to the fluid, responsive Canvas dimensions. By computing and freezing pixel scaling math precisely once via a <code><a href="../types/RendererMetrics.html">RendererMetrics</a></code> payload during initialization, it guarantees that all nested rendering loops run without any expensive trigonometric boundaries-checking per frame.</p>
|
|
462
464
|
</div>
|
|
463
465
|
</div>
|
|
464
466
|
</div>
|
|
465
467
|
<div class="sect1">
|
|
466
|
-
<h2 id="api-reference"><a class="link" href="#api-reference">
|
|
468
|
+
<h2 id="api-reference"><a class="link" href="#api-reference">2. API Reference</a></h2>
|
|
467
469
|
<div class="sectionbody">
|
|
468
470
|
<div class="sect2">
|
|
469
|
-
<h3 id="renderermetrics-renderermetrics"><a class="link" href="#renderermetrics-renderermetrics">
|
|
471
|
+
<h3 id="renderermetrics-renderermetrics"><a class="link" href="#renderermetrics-renderermetrics">2.1. <code>rendererMetrics: RendererMetrics</code></a></h3>
|
|
470
472
|
<div class="paragraph">
|
|
471
473
|
<p>Read-only property containing the calculated dimensions and origins for all UI components.</p>
|
|
472
474
|
</div>
|
|
@@ -485,7 +487,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
485
487
|
<hr>
|
|
486
488
|
</div>
|
|
487
489
|
<div class="sect2">
|
|
488
|
-
<h3 id="addrendererrenderer-renderer-void"><a class="link" href="#addrendererrenderer-renderer-void">
|
|
490
|
+
<h3 id="addrendererrenderer-renderer-void"><a class="link" href="#addrendererrenderer-renderer-void">2.2. <code>addRenderer(renderer: Renderer): void</code></a></h3>
|
|
489
491
|
<div class="paragraph">
|
|
490
492
|
<p>Registers a new rendering layer.</p>
|
|
491
493
|
</div>
|
|
@@ -520,7 +522,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
520
522
|
<hr>
|
|
521
523
|
</div>
|
|
522
524
|
<div class="sect2">
|
|
523
|
-
<h3 id="rendergrid-cell-modules-gamemodules-void"><a class="link" href="#rendergrid-cell-modules-gamemodules-void">
|
|
525
|
+
<h3 id="rendergrid-cell-modules-gamemodules-void"><a class="link" href="#rendergrid-cell-modules-gamemodules-void">2.3. <code>render(grid: Cell[][], modules: GameModules): void</code></a></h3>
|
|
524
526
|
<div class="paragraph">
|
|
525
527
|
<p>The main drawing execution call.</p>
|
|
526
528
|
</div>
|
|
@@ -560,7 +562,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
560
562
|
<hr>
|
|
561
563
|
</div>
|
|
562
564
|
<div class="sect2">
|
|
563
|
-
<h3 id="getdebugdata-recordstring-string-number-boolean"><a class="link" href="#getdebugdata-recordstring-string-number-boolean">
|
|
565
|
+
<h3 id="getdebugdata-recordstring-string-number-boolean"><a class="link" href="#getdebugdata-recordstring-string-number-boolean">2.4. <code>getDebugData(): Record<string, string | number | boolean></code></a></h3>
|
|
564
566
|
<div class="paragraph">
|
|
565
567
|
<p>Returns metadata for the real-time debugger.</p>
|
|
566
568
|
</div>
|
|
@@ -443,60 +443,62 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
443
443
|
<div id="toc" class="toc2">
|
|
444
444
|
<div id="toctitle">Table of Contents</div>
|
|
445
445
|
<ul class="sectlevel1">
|
|
446
|
-
<li><a href="#
|
|
446
|
+
<li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
|
|
447
|
+
<li><a href="#api-reference">2. API Reference</a>
|
|
447
448
|
<ul class="sectlevel2">
|
|
448
|
-
<li><a href="#score-number">
|
|
449
|
-
<li><a href="#level-number">
|
|
450
|
-
<li><a href="#multiplier-number">
|
|
451
|
-
<li><a href="#highscore-number">
|
|
452
|
-
<li><a href="#increasescoreamount-number-void">
|
|
453
|
-
<li><a href="#resetscore-void">
|
|
454
|
-
<li><a href="#increaselevelamount-number-void">
|
|
455
|
-
<li><a href="#resetlevel-void">
|
|
456
|
-
<li><a href="#setupgamehighscoreid-string-void">
|
|
457
|
-
<li><a href="#getformattedscoredigits-number-string">
|
|
458
|
-
<li><a href="#serialize-string">
|
|
459
|
-
<li><a href="#deserializedata-string-void">
|
|
460
|
-
<li><a href="#getdebugdata-recordstring-string-number-boolean">
|
|
449
|
+
<li><a href="#score-number">2.1. <code>score: number</code></a></li>
|
|
450
|
+
<li><a href="#level-number">2.2. <code>level: number</code></a></li>
|
|
451
|
+
<li><a href="#multiplier-number">2.3. <code>multiplier: number</code></a></li>
|
|
452
|
+
<li><a href="#highscore-number">2.4. <code>highScore: number</code></a></li>
|
|
453
|
+
<li><a href="#increasescoreamount-number-void">2.5. <code>increaseScore(amount: number): void</code></a></li>
|
|
454
|
+
<li><a href="#resetscore-void">2.6. <code>resetScore(): void</code></a></li>
|
|
455
|
+
<li><a href="#increaselevelamount-number-void">2.7. <code>increaseLevel(amount: number): void</code></a></li>
|
|
456
|
+
<li><a href="#resetlevel-void">2.8. <code>resetLevel(): void</code></a></li>
|
|
457
|
+
<li><a href="#setupgamehighscoreid-string-void">2.9. <code>setupGameHighScore(id: string): void</code></a></li>
|
|
458
|
+
<li><a href="#getformattedscoredigits-number-string">2.10. <code>getFormattedScore(digits: number): string</code></a></li>
|
|
459
|
+
<li><a href="#serialize-string">2.11. <code>serialize(): string</code></a></li>
|
|
460
|
+
<li><a href="#deserializedata-string-void">2.12. <code>deserialize(data: string): void</code></a></li>
|
|
461
|
+
<li><a href="#getdebugdata-recordstring-string-number-boolean">2.13. <code>getDebugData(): Record<string, string | number | boolean></code></a></li>
|
|
461
462
|
</ul>
|
|
462
463
|
</li>
|
|
463
464
|
</ul>
|
|
464
465
|
</div>
|
|
465
466
|
</div>
|
|
466
467
|
<div id="content">
|
|
467
|
-
<div
|
|
468
|
+
<div class="sect1">
|
|
469
|
+
<h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
|
|
468
470
|
<div class="sectionbody">
|
|
469
471
|
<div class="paragraph">
|
|
470
|
-
<p>The <code>GameScore</code> module
|
|
472
|
+
<p>The <code>GameScore</code> module acts as the strict authority dedicated to tracking real-time player performance metrics, levels, and point multipliers. It prevents transient session logic from interacting with persistent storage, explicitly taking over saving the global <code>highScore</code> into an isolated <code>LocalStorage</code> namespace directly, ensuring different game engines do not overwrite each other’s records.</p>
|
|
471
473
|
</div>
|
|
472
474
|
</div>
|
|
473
475
|
</div>
|
|
474
476
|
<div class="sect1">
|
|
475
|
-
<h2 id="api-reference"><a class="link" href="#api-reference">
|
|
477
|
+
<h2 id="api-reference"><a class="link" href="#api-reference">2. API Reference</a></h2>
|
|
476
478
|
<div class="sectionbody">
|
|
477
479
|
<div class="sect2">
|
|
478
|
-
<h3 id="score-number"><a class="link" href="#score-number">
|
|
480
|
+
<h3 id="score-number"><a class="link" href="#score-number">2.1. <code>score: number</code></a></h3>
|
|
479
481
|
<div class="paragraph">
|
|
480
482
|
<p>Read-only property returning the current session’s points.</p>
|
|
481
483
|
</div>
|
|
482
484
|
<hr>
|
|
483
485
|
</div>
|
|
484
486
|
<div class="sect2">
|
|
485
|
-
<h3 id="level-number"><a class="link" href="#level-number">
|
|
487
|
+
<h3 id="level-number"><a class="link" href="#level-number">2.2. <code>level: number</code></a></h3>
|
|
486
488
|
<div class="paragraph">
|
|
487
489
|
<p>Read-only property returning the current difficulty level.</p>
|
|
488
490
|
</div>
|
|
489
491
|
<hr>
|
|
490
492
|
</div>
|
|
491
493
|
<div class="sect2">
|
|
492
|
-
<h3 id="multiplier-number"><a class="link" href="#multiplier-number">
|
|
494
|
+
<h3 id="multiplier-number"><a class="link" href="#multiplier-number">2.3. <code>multiplier: number</code></a></h3>
|
|
493
495
|
<div class="paragraph">
|
|
494
496
|
<p>Read and Write property for the current points multiplier.</p>
|
|
495
497
|
</div>
|
|
496
498
|
<hr>
|
|
497
499
|
</div>
|
|
498
500
|
<div class="sect2">
|
|
499
|
-
<h3 id="highscore-number"><a class="link" href="#highscore-number">
|
|
501
|
+
<h3 id="highscore-number"><a class="link" href="#highscore-number">2.4. <code>highScore: number</code></a></h3>
|
|
500
502
|
<div class="paragraph">
|
|
501
503
|
<p>Read and Write property for the highest overall score achieved.</p>
|
|
502
504
|
</div>
|
|
@@ -509,7 +511,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
509
511
|
<hr>
|
|
510
512
|
</div>
|
|
511
513
|
<div class="sect2">
|
|
512
|
-
<h3 id="increasescoreamount-number-void"><a class="link" href="#increasescoreamount-number-void">
|
|
514
|
+
<h3 id="increasescoreamount-number-void"><a class="link" href="#increasescoreamount-number-void">2.5. <code>increaseScore(amount: number): void</code></a></h3>
|
|
513
515
|
<div class="paragraph">
|
|
514
516
|
<p>Adds points to the current session.</p>
|
|
515
517
|
</div>
|
|
@@ -531,7 +533,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
531
533
|
<tr>
|
|
532
534
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>amount</code></p></td>
|
|
533
535
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
|
|
534
|
-
<td class="tableblock halign-left valign-top"><p class="tableblock">Base points to add.</p></td>
|
|
536
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Base raw integer points to add before multiplier application.</p></td>
|
|
535
537
|
</tr>
|
|
536
538
|
</tbody>
|
|
537
539
|
</table>
|
|
@@ -544,14 +546,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
544
546
|
<hr>
|
|
545
547
|
</div>
|
|
546
548
|
<div class="sect2">
|
|
547
|
-
<h3 id="resetscore-void"><a class="link" href="#resetscore-void">
|
|
549
|
+
<h3 id="resetscore-void"><a class="link" href="#resetscore-void">2.6. <code>resetScore(): void</code></a></h3>
|
|
548
550
|
<div class="paragraph">
|
|
549
551
|
<p>Resets the session score to zero.</p>
|
|
550
552
|
</div>
|
|
551
553
|
<hr>
|
|
552
554
|
</div>
|
|
553
555
|
<div class="sect2">
|
|
554
|
-
<h3 id="increaselevelamount-number-void"><a class="link" href="#increaselevelamount-number-void">
|
|
556
|
+
<h3 id="increaselevelamount-number-void"><a class="link" href="#increaselevelamount-number-void">2.7. <code>increaseLevel(amount: number): void</code></a></h3>
|
|
555
557
|
<div class="paragraph">
|
|
556
558
|
<p>Increases the game difficulty level.</p>
|
|
557
559
|
</div>
|
|
@@ -573,21 +575,21 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
573
575
|
<tr>
|
|
574
576
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>amount</code></p></td>
|
|
575
577
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
|
|
576
|
-
<td class="tableblock halign-left valign-top"><p class="tableblock">
|
|
578
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Positive integer count of step levels to advance globally.</p></td>
|
|
577
579
|
</tr>
|
|
578
580
|
</tbody>
|
|
579
581
|
</table>
|
|
580
582
|
<hr>
|
|
581
583
|
</div>
|
|
582
584
|
<div class="sect2">
|
|
583
|
-
<h3 id="resetlevel-void"><a class="link" href="#resetlevel-void">
|
|
585
|
+
<h3 id="resetlevel-void"><a class="link" href="#resetlevel-void">2.8. <code>resetLevel(): void</code></a></h3>
|
|
584
586
|
<div class="paragraph">
|
|
585
587
|
<p>Resets the level counter to 1.
|
|
586
588
|
'''</p>
|
|
587
589
|
</div>
|
|
588
590
|
</div>
|
|
589
591
|
<div class="sect2">
|
|
590
|
-
<h3 id="setupgamehighscoreid-string-void"><a class="link" href="#setupgamehighscoreid-string-void">
|
|
592
|
+
<h3 id="setupgamehighscoreid-string-void"><a class="link" href="#setupgamehighscoreid-string-void">2.9. <code>setupGameHighScore(id: string): void</code></a></h3>
|
|
591
593
|
<div class="paragraph">
|
|
592
594
|
<p>Initializes the module with the specific game ID and loads the corresponding high score.</p>
|
|
593
595
|
</div>
|
|
@@ -609,14 +611,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
609
611
|
<tr>
|
|
610
612
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>id</code></p></td>
|
|
611
613
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>string</code></p></td>
|
|
612
|
-
<td class="tableblock halign-left valign-top"><p class="tableblock">The unique game identifier used as a prefix for
|
|
614
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">The unique game UUID identifier used as a persistent prefix for namespace isolation.</p></td>
|
|
613
615
|
</tr>
|
|
614
616
|
</tbody>
|
|
615
617
|
</table>
|
|
616
618
|
<hr>
|
|
617
619
|
</div>
|
|
618
620
|
<div class="sect2">
|
|
619
|
-
<h3 id="getformattedscoredigits-number-string"><a class="link" href="#getformattedscoredigits-number-string">
|
|
621
|
+
<h3 id="getformattedscoredigits-number-string"><a class="link" href="#getformattedscoredigits-number-string">2.10. <code>getFormattedScore(digits: number): string</code></a></h3>
|
|
620
622
|
<div class="paragraph">
|
|
621
623
|
<p>Returns the score as a padded string suitable for HUD display.</p>
|
|
622
624
|
</div>
|
|
@@ -638,7 +640,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
638
640
|
<tr>
|
|
639
641
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>digits</code></p></td>
|
|
640
642
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
|
|
641
|
-
<td class="tableblock halign-left valign-top"><p class="tableblock">Total length
|
|
643
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">Total character length to dictate string sequence width (e.g., 6 outputs "000150").</p></td>
|
|
642
644
|
</tr>
|
|
643
645
|
</tbody>
|
|
644
646
|
</table>
|
|
@@ -651,7 +653,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
651
653
|
<hr>
|
|
652
654
|
</div>
|
|
653
655
|
<div class="sect2">
|
|
654
|
-
<h3 id="serialize-string"><a class="link" href="#serialize-string">
|
|
656
|
+
<h3 id="serialize-string"><a class="link" href="#serialize-string">2.11. <code>serialize(): string</code></a></h3>
|
|
655
657
|
<div class="paragraph">
|
|
656
658
|
<p><strong>Behavior</strong></p>
|
|
657
659
|
</div>
|
|
@@ -661,7 +663,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
661
663
|
<hr>
|
|
662
664
|
</div>
|
|
663
665
|
<div class="sect2">
|
|
664
|
-
<h3 id="deserializedata-string-void"><a class="link" href="#deserializedata-string-void">
|
|
666
|
+
<h3 id="deserializedata-string-void"><a class="link" href="#deserializedata-string-void">2.12. <code>deserialize(data: string): void</code></a></h3>
|
|
665
667
|
<div class="paragraph">
|
|
666
668
|
<p><strong>Behavior</strong></p>
|
|
667
669
|
</div>
|
|
@@ -671,7 +673,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
671
673
|
<hr>
|
|
672
674
|
</div>
|
|
673
675
|
<div class="sect2">
|
|
674
|
-
<h3 id="getdebugdata-recordstring-string-number-boolean"><a class="link" href="#getdebugdata-recordstring-string-number-boolean">
|
|
676
|
+
<h3 id="getdebugdata-recordstring-string-number-boolean"><a class="link" href="#getdebugdata-recordstring-string-number-boolean">2.13. <code>getDebugData(): Record<string, string | number | boolean></code></a></h3>
|
|
675
677
|
<div class="paragraph">
|
|
676
678
|
<p>Returns metadata for the real-time debugger.</p>
|
|
677
679
|
</div>
|
|
@@ -442,38 +442,56 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
442
442
|
<div id="toc" class="toc2">
|
|
443
443
|
<div id="toctitle">Table of Contents</div>
|
|
444
444
|
<ul class="sectlevel1">
|
|
445
|
-
<li><a href="#
|
|
445
|
+
<li><a href="#_architectural_purpose">1. Architectural Purpose</a></li>
|
|
446
|
+
<li><a href="#_session_management">2. Session Management</a>
|
|
446
447
|
<ul class="sectlevel2">
|
|
447
|
-
<li><a href="#_savesession_void">
|
|
448
|
-
<li><a href="#
|
|
449
|
-
<li><a href="#
|
|
450
|
-
<li><a href="#
|
|
448
|
+
<li><a href="#_savesession_void">2.1. <code>saveSession(): void</code></a></li>
|
|
449
|
+
<li><a href="#_issessionresolved_boolean">2.2. <code>isSessionResolved(): boolean</code></a></li>
|
|
450
|
+
<li><a href="#_setresetfunctionresetfn_void_void">2.3. <code>setResetFunction(resetFn: () ⇒ void): void</code></a></li>
|
|
451
|
+
<li><a href="#_setsessionenabledenabled_boolean_void">2.4. <code>setSessionEnabled(enabled: boolean): void</code></a></li>
|
|
452
|
+
<li><a href="#_clearsession_void">2.5. <code>clearSession(): void</code></a></li>
|
|
453
|
+
<li><a href="#_syncstatestate_state_void">2.6. <code>syncState(state: State): void</code></a></li>
|
|
451
454
|
</ul>
|
|
452
455
|
</li>
|
|
453
|
-
<li><a href="#_internals">
|
|
456
|
+
<li><a href="#_internals">3. Internals</a></li>
|
|
454
457
|
</ul>
|
|
455
458
|
</div>
|
|
456
459
|
</div>
|
|
457
460
|
<div id="content">
|
|
458
|
-
<div
|
|
461
|
+
<div class="sect1">
|
|
462
|
+
<h2 id="_architectural_purpose"><a class="link" href="#_architectural_purpose">1. Architectural Purpose</a></h2>
|
|
459
463
|
<div class="sectionbody">
|
|
460
464
|
<div class="paragraph">
|
|
461
|
-
<p>The <code>GameSession</code> module implements the <code><a href="
|
|
465
|
+
<p>The <code>GameSession</code> module implements the engine’s core persistence logic orchestrator for transient serialized data. Rather than mixing user preferences (<code>GameState</code>) with dynamic game-over progress (like active piece locations or multipliers), <code>GameSession</code> secures an isolated boundary that hooks directly into the logical <code><a href="GameState.html">GameState</a></code> phase shifts and intelligently pauses flow via modal confirmations before accidental memory leaks or overwrites occur.</p>
|
|
462
466
|
</div>
|
|
463
467
|
</div>
|
|
464
468
|
</div>
|
|
465
469
|
<div class="sect1">
|
|
466
|
-
<h2 id="_session_management"><a class="link" href="#_session_management">
|
|
470
|
+
<h2 id="_session_management"><a class="link" href="#_session_management">2. Session Management</a></h2>
|
|
467
471
|
<div class="sectionbody">
|
|
468
472
|
<div class="sect2">
|
|
469
|
-
<h3 id="_savesession_void"><a class="link" href="#_savesession_void">
|
|
473
|
+
<h3 id="_savesession_void"><a class="link" href="#_savesession_void">2.1. <code>saveSession(): void</code></a></h3>
|
|
474
|
+
<div class="paragraph">
|
|
475
|
+
<p>Persists the current state of all registered <code><a href="../Serializable.html">Serializable</a></code> instances. Early returns if the session is disabled (via <code>setSessionEnabled</code>) or if the session restoration flow is not yet complete (<code>isSessionResolved()</code> is <code>false</code>).</p>
|
|
476
|
+
</div>
|
|
477
|
+
<hr>
|
|
478
|
+
</div>
|
|
479
|
+
<div class="sect2">
|
|
480
|
+
<h3 id="_issessionresolved_boolean"><a class="link" href="#_issessionresolved_boolean">2.2. <code>isSessionResolved(): boolean</code></a></h3>
|
|
481
|
+
<div class="paragraph">
|
|
482
|
+
<p>Implementation of the interface method. Returns whether the session resolution has been finalized.</p>
|
|
483
|
+
</div>
|
|
484
|
+
<hr>
|
|
485
|
+
</div>
|
|
486
|
+
<div class="sect2">
|
|
487
|
+
<h3 id="_setresetfunctionresetfn_void_void"><a class="link" href="#_setresetfunctionresetfn_void_void">2.3. <code>setResetFunction(resetFn: () ⇒ void): void</code></a></h3>
|
|
470
488
|
<div class="paragraph">
|
|
471
|
-
<p>
|
|
489
|
+
<p>Stores the reset callback that will be invoked if the user chooses to cancel restoration.</p>
|
|
472
490
|
</div>
|
|
473
491
|
<hr>
|
|
474
492
|
</div>
|
|
475
493
|
<div class="sect2">
|
|
476
|
-
<h3 id="_setsessionenabledenabled_boolean_void"><a class="link" href="#_setsessionenabledenabled_boolean_void">
|
|
494
|
+
<h3 id="_setsessionenabledenabled_boolean_void"><a class="link" href="#_setsessionenabledenabled_boolean_void">2.4. <code>setSessionEnabled(enabled: boolean): void</code></a></h3>
|
|
477
495
|
<div class="paragraph">
|
|
478
496
|
<p>Enables or disables the session recovery mechanism. When disabled, the engine will neither show the session recovery modal nor save the session.</p>
|
|
479
497
|
</div>
|
|
@@ -495,19 +513,19 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
495
513
|
<tr>
|
|
496
514
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>enabled</code></p></td>
|
|
497
515
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean</code></p></td>
|
|
498
|
-
<td class="tableblock halign-left valign-top"><p class="tableblock">
|
|
516
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">The primitive strict boolean enforcing if a startup evaluates past history (<code>true</code>) or resets blindly (<code>false</code>).</p></td>
|
|
499
517
|
</tr>
|
|
500
518
|
</tbody>
|
|
501
519
|
</table>
|
|
502
520
|
</div>
|
|
503
521
|
<div class="sect2">
|
|
504
|
-
<h3 id="_clearsession_void"><a class="link" href="#_clearsession_void">
|
|
522
|
+
<h3 id="_clearsession_void"><a class="link" href="#_clearsession_void">2.5. <code>clearSession(): void</code></a></h3>
|
|
505
523
|
<div class="paragraph">
|
|
506
524
|
<p>Removes the saved instances from <code>localStorage</code>.</p>
|
|
507
525
|
</div>
|
|
508
526
|
</div>
|
|
509
527
|
<div class="sect2">
|
|
510
|
-
<h3 id="_syncstatestate_state_void"><a class="link" href="#_syncstatestate_state_void">
|
|
528
|
+
<h3 id="_syncstatestate_state_void"><a class="link" href="#_syncstatestate_state_void">2.6. <code>syncState(state: State): void</code></a></h3>
|
|
511
529
|
<div class="paragraph">
|
|
512
530
|
<p>Subscribes to <code><a href="GameState.html">GameState</a></code> interactions.</p>
|
|
513
531
|
</div>
|
|
@@ -529,7 +547,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
529
547
|
<tr>
|
|
530
548
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>state</code></p></td>
|
|
531
549
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../interfaces/modules/State.html">State</a></code></p></td>
|
|
532
|
-
<td class="tableblock halign-left valign-top"><p class="tableblock">The
|
|
550
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">The global singleton source-of-truth object orchestrator explicitly exposing lifecycle events.</p></td>
|
|
533
551
|
</tr>
|
|
534
552
|
</tbody>
|
|
535
553
|
</table>
|
|
@@ -538,7 +556,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
538
556
|
</div>
|
|
539
557
|
<div class="paragraph">
|
|
540
558
|
<p>Reacts to:
|
|
541
|
-
- <code>PLAYING</code>: If a session for the current <code>gameId</code> exists, session is enabled, and the modal hasn’t been closed, it invokes the modal via <code>_showSessionModal</code>. If accepted, calls deserialize on all registered targets. If canceled or if no previous session exists, proceeds normally. The modal state is tracked to prevent re-triggering during the same power cycle.
|
|
559
|
+
- <code>PLAYING</code>: If a session for the current <code>gameId</code> exists, session is enabled, and the modal hasn’t been closed, it invokes the modal via <code>_showSessionModal</code>. If accepted, calls deserialize on all registered targets. If canceled or if no previous session exists, proceeds normally. The modal state is tracked to prevent re-triggering during the same power cycle. If canceled, it also invokes the registered <code>resetFn</code> to ensure the game starts with a clean state.
|
|
542
560
|
- <code>ON</code> (when false): Resets the modal state tracking closure, allowing the session modal to appear again after the device is powered back on.
|
|
543
561
|
- <code>GAME_OVER</code>: Clears active session entirely.</p>
|
|
544
562
|
</div>
|
|
@@ -546,7 +564,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
546
564
|
</div>
|
|
547
565
|
</div>
|
|
548
566
|
<div class="sect1">
|
|
549
|
-
<h2 id="_internals"><a class="link" href="#_internals">
|
|
567
|
+
<h2 id="_internals"><a class="link" href="#_internals">3. Internals</a></h2>
|
|
550
568
|
<div class="sectionbody">
|
|
551
569
|
<div class="paragraph">
|
|
552
570
|
<p>The system scopes data internally via the <code>${gameId}::${serialId}</code> key pattern within the <code>localStorage</code>. Under the hood, the engine identifies instances that implements the <code><a href="../interfaces/Serializable.html">Serializable</a></code> capability and registers them here implicitly during the bootstrap.</p>
|
|
@@ -556,7 +574,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
556
574
|
</div>
|
|
557
575
|
<div id="footer">
|
|
558
576
|
<div id="footer-text">
|
|
559
|
-
Last updated 2026-02-
|
|
577
|
+
Last updated 2026-02-27 21:47:24 -0300
|
|
560
578
|
</div>
|
|
561
579
|
</div>
|
|
562
580
|
</body>
|
|
@@ -443,32 +443,34 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
443
443
|
<div id="toc" class="toc2">
|
|
444
444
|
<div id="toctitle">Table of Contents</div>
|
|
445
445
|
<ul class="sectlevel1">
|
|
446
|
-
<li><a href="#
|
|
446
|
+
<li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
|
|
447
|
+
<li><a href="#api-reference">2. API Reference</a>
|
|
447
448
|
<ul class="sectlevel2">
|
|
448
|
-
<li><a href="#playsound-sound-promisevoid">
|
|
449
|
-
<li><a href="#stopsound-sound-void">
|
|
450
|
-
<li><a href="#stopall-void">
|
|
451
|
-
<li><a href="#togglemute-void">
|
|
452
|
-
<li><a href="#syncstatestate-state-void">
|
|
453
|
-
<li><a href="#getdebugdata-recordstring-string-number-boolean">
|
|
449
|
+
<li><a href="#playsound-sound-promisevoid">2.1. <code>play(sound: Sound): Promise<void></code></a></li>
|
|
450
|
+
<li><a href="#stopsound-sound-void">2.2. <code>stop(sound: Sound): void</code></a></li>
|
|
451
|
+
<li><a href="#stopall-void">2.3. <code>stopAll(): void</code></a></li>
|
|
452
|
+
<li><a href="#togglemute-void">2.4. <code>toggleMute(): void</code></a></li>
|
|
453
|
+
<li><a href="#syncstatestate-state-void">2.5. <code>syncState(state: State): void</code></a></li>
|
|
454
|
+
<li><a href="#getdebugdata-recordstring-string-number-boolean">2.6. <code>getDebugData(): Record<string, string | number | boolean></code></a></li>
|
|
454
455
|
</ul>
|
|
455
456
|
</li>
|
|
456
457
|
</ul>
|
|
457
458
|
</div>
|
|
458
459
|
</div>
|
|
459
460
|
<div id="content">
|
|
460
|
-
<div
|
|
461
|
+
<div class="sect1">
|
|
462
|
+
<h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
|
|
461
463
|
<div class="sectionbody">
|
|
462
464
|
<div class="paragraph">
|
|
463
|
-
<p>The <code>GameSound</code> module manages audio playback
|
|
465
|
+
<p>The <code>GameSound</code> module manages non-blocking audio playback using the raw <strong>Web Audio API</strong>. It decouples context management and audio file loading processes away from the simple gameplay components. By abstracting buffer decoding and muting operations, it allows modules to securely emit audio triggers without managing active <code>GainNode</code> flows or managing overlaps directly.</p>
|
|
464
466
|
</div>
|
|
465
467
|
</div>
|
|
466
468
|
</div>
|
|
467
469
|
<div class="sect1">
|
|
468
|
-
<h2 id="api-reference"><a class="link" href="#api-reference">
|
|
470
|
+
<h2 id="api-reference"><a class="link" href="#api-reference">2. API Reference</a></h2>
|
|
469
471
|
<div class="sectionbody">
|
|
470
472
|
<div class="sect2">
|
|
471
|
-
<h3 id="playsound-sound-promisevoid"><a class="link" href="#playsound-sound-promisevoid">
|
|
473
|
+
<h3 id="playsound-sound-promisevoid"><a class="link" href="#playsound-sound-promisevoid">2.1. <code>play(sound: Sound): Promise<void></code></a></h3>
|
|
472
474
|
<div class="paragraph">
|
|
473
475
|
<p>Plays a preloaded sound effect.</p>
|
|
474
476
|
</div>
|
|
@@ -490,7 +492,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
490
492
|
<tr>
|
|
491
493
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sound</code></p></td>
|
|
492
494
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/Sound.html">Sound</a></code></p></td>
|
|
493
|
-
<td class="tableblock halign-left valign-top"><p class="tableblock">The enum identifier of the
|
|
495
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">The exact registered enum identifier of the active soundtrack/effect file to trigger.</p></td>
|
|
494
496
|
</tr>
|
|
495
497
|
</tbody>
|
|
496
498
|
</table>
|
|
@@ -517,7 +519,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
517
519
|
<hr>
|
|
518
520
|
</div>
|
|
519
521
|
<div class="sect2">
|
|
520
|
-
<h3 id="stopsound-sound-void"><a class="link" href="#stopsound-sound-void">
|
|
522
|
+
<h3 id="stopsound-sound-void"><a class="link" href="#stopsound-sound-void">2.2. <code>stop(sound: Sound): void</code></a></h3>
|
|
521
523
|
<div class="paragraph">
|
|
522
524
|
<p>Stops all active instances of a specific sound.</p>
|
|
523
525
|
</div>
|
|
@@ -539,7 +541,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
539
541
|
<tr>
|
|
540
542
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sound</code></p></td>
|
|
541
543
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/Sound.html">Sound</a></code></p></td>
|
|
542
|
-
<td class="tableblock halign-left valign-top"><p class="tableblock">The enum
|
|
544
|
+
<td class="tableblock halign-left valign-top"><p class="tableblock">The explicit enum identity of the playing audio buffer layer to abruptly physically halt.</p></td>
|
|
543
545
|
</tr>
|
|
544
546
|
</tbody>
|
|
545
547
|
</table>
|
|
@@ -552,14 +554,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
552
554
|
<hr>
|
|
553
555
|
</div>
|
|
554
556
|
<div class="sect2">
|
|
555
|
-
<h3 id="stopall-void"><a class="link" href="#stopall-void">
|
|
557
|
+
<h3 id="stopall-void"><a class="link" href="#stopall-void">2.3. <code>stopAll(): void</code></a></h3>
|
|
556
558
|
<div class="paragraph">
|
|
557
559
|
<p>Stops every sound currently playing in the engine.</p>
|
|
558
560
|
</div>
|
|
559
561
|
<hr>
|
|
560
562
|
</div>
|
|
561
563
|
<div class="sect2">
|
|
562
|
-
<h3 id="togglemute-void"><a class="link" href="#togglemute-void">
|
|
564
|
+
<h3 id="togglemute-void"><a class="link" href="#togglemute-void">2.4. <code>toggleMute(): void</code></a></h3>
|
|
563
565
|
<div class="paragraph">
|
|
564
566
|
<p>Toggles the master mute status.</p>
|
|
565
567
|
</div>
|
|
@@ -572,7 +574,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
572
574
|
<hr>
|
|
573
575
|
</div>
|
|
574
576
|
<div class="sect2">
|
|
575
|
-
<h3 id="syncstatestate-state-void"><a class="link" href="#syncstatestate-state-void">
|
|
577
|
+
<h3 id="syncstatestate-state-void"><a class="link" href="#syncstatestate-state-void">2.5. <code>syncState(state: State): void</code></a></h3>
|
|
576
578
|
<div class="paragraph">
|
|
577
579
|
<p>Synchronizes audio settings with the global game state.</p>
|
|
578
580
|
</div>
|
|
@@ -607,7 +609,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
|
|
|
607
609
|
<hr>
|
|
608
610
|
</div>
|
|
609
611
|
<div class="sect2">
|
|
610
|
-
<h3 id="getdebugdata-recordstring-string-number-boolean"><a class="link" href="#getdebugdata-recordstring-string-number-boolean">
|
|
612
|
+
<h3 id="getdebugdata-recordstring-string-number-boolean"><a class="link" href="#getdebugdata-recordstring-string-number-boolean">2.6. <code>getDebugData(): Record<string, string | number | boolean></code></a></h3>
|
|
611
613
|
<div class="paragraph">
|
|
612
614
|
<p>Returns metadata for the real-time debugger.</p>
|
|
613
615
|
</div>
|