brick-engine-js 1.0.16 → 1.0.18

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.
Files changed (53) hide show
  1. package/README.adoc +7 -2
  2. package/dist/docs/getting-started.html +1 -1
  3. package/dist/docs/index.html +17 -1
  4. package/dist/docs/publishing.html +1 -1
  5. package/dist/docs/reference/context/RendererContext.html +584 -0
  6. package/dist/docs/reference/{types/GameEntry.html → enums/EventSuffix.html} +21 -22
  7. package/dist/docs/reference/helpers/CoordinateHelper.html +10 -35
  8. package/dist/docs/reference/helpers/RelativeValuesHelper.html +4 -14
  9. package/dist/docs/reference/interfaces/GameModules.html +14 -9
  10. package/dist/docs/reference/{modules/GameMenu.html → interfaces/StateContext.html} +50 -71
  11. package/dist/docs/reference/interfaces/modules/Score.html +6 -6
  12. package/dist/docs/reference/interfaces/modules/Session.html +31 -1
  13. package/dist/docs/reference/modules/EventEmitter.html +624 -0
  14. package/dist/docs/reference/modules/Game.html +18 -136
  15. package/dist/docs/reference/modules/GameControl.html +170 -9
  16. package/dist/docs/reference/modules/GameEventRegistry.html +605 -0
  17. package/dist/docs/reference/modules/GameScore.html +40 -10
  18. package/dist/docs/reference/modules/GameSession.html +37 -7
  19. package/dist/docs/reference/modules/GameState.html +119 -6
  20. package/dist/docs/reference/modules/InitialStateSnapshot.html +5 -2
  21. package/dist/docs/reference/view/GameView.html +606 -0
  22. package/dist/game.bundle.js +1 -1
  23. package/dist/types/bootstrap.d.ts +1 -1
  24. package/dist/types/core/Game.d.ts +16 -5
  25. package/dist/types/core/context/RendererContext.d.ts +25 -0
  26. package/dist/types/core/context/RendererContext.test.d.ts +1 -0
  27. package/dist/types/core/event/EventEmitter.d.ts +71 -0
  28. package/dist/types/core/event/EventEmitter.test.d.ts +1 -0
  29. package/dist/types/core/event/GameEventRegistry.d.ts +28 -0
  30. package/dist/types/core/event/GameEventRegistry.test.d.ts +1 -0
  31. package/dist/types/core/helpers/CoordinateHelper.d.ts +5 -11
  32. package/dist/types/core/helpers/RelativeValuesHelper.d.ts +2 -5
  33. package/dist/types/core/module/control/GameControl.d.ts +11 -15
  34. package/dist/types/core/module/renderer/DisplayRenderer.d.ts +0 -8
  35. package/dist/types/core/module/renderer/GameRenderer.d.ts +0 -8
  36. package/dist/types/core/module/renderer/HudRenderer.d.ts +0 -8
  37. package/dist/types/core/module/score/GameScore.d.ts +5 -3
  38. package/dist/types/core/module/session/GameSession.d.ts +0 -1
  39. package/dist/types/core/module/state/GameState.d.ts +12 -16
  40. package/dist/types/core/module/text/GameText.d.ts +0 -9
  41. package/dist/types/core/types/modules.d.ts +77 -7
  42. package/dist/types/index.d.ts +2 -0
  43. package/dist/types/view/Debugger.d.ts +1 -3
  44. package/dist/types/view/GameView.d.ts +1 -2
  45. package/dist/types/view/SessionModal.d.ts +1 -3
  46. package/dist/types/view/components/layout/ButtonLayout.d.ts +1 -1
  47. package/dist/types/view/components/layout/ContainerLayout.d.ts +1 -1
  48. package/dist/types/view/components/layout/FrameLayout.d.ts +1 -1
  49. package/dist/types/view/components/ui/BigButton.d.ts +1 -1
  50. package/dist/types/view/components/ui/Button.d.ts +1 -1
  51. package/dist/types/view/components/ui/Canvas.d.ts +1 -1
  52. package/dist/types/view/components/ui/SmallButton.d.ts +1 -1
  53. package/package.json +1 -1
package/dist/docs/reference/{types/GameEntry.html → enums/EventSuffix.html} RENAMED
@@ -5,9 +5,9 @@
5
5
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
6
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
7
7
  <meta name="generator" content="Asciidoctor 2.0.20">
8
- <meta name="description" content="Defines the structure for games registered in the engine's repository.">
9
- <meta name="keywords" content="game, entry, repository, structure">
10
- <title>GameEntry Reference</title>
8
+ <meta name="description" content="Suffixes used to scope events to specific game states.">
9
+ <meta name="keywords" content="event, suffix, context, state">
10
+ <title>EventSuffix Reference</title>
11
11
  <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">
12
12
  <style>
13
13
  /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
@@ -439,11 +439,11 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
439
439
  </head>
440
440
  <body class="article toc2 toc-left">
441
441
  <div id="header">
442
- <h1>GameEntry Reference</h1>
442
+ <h1>EventSuffix Reference</h1>
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="#attributes">1. Attributes</a></li>
446
+ <li><a href="#values">1. Values</a></li>
447
447
  <li><a href="#general-usage">2. General Usage</a></li>
448
448
  </ul>
449
449
  </div>
@@ -452,39 +452,38 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
452
452
  <div id="preamble">
453
453
  <div class="sectionbody">
454
454
  <div class="paragraph">
455
- <p>Defines the structure for games registered in the engine&#8217;s repository.</p>
455
+ <p>The <code>EventSuffix</code> enum defines the available suffixes used to scope events within the engine&#8217;s contextual notification system.</p>
456
456
  </div>
457
457
  </div>
458
458
  </div>
459
459
  <div class="sect1">
460
- <h2 id="attributes"><a class="link" href="#attributes">1. Attributes</a></h2>
460
+ <h2 id="values"><a class="link" href="#values">1. Values</a></h2>
461
461
  <div class="sectionbody">
462
462
  <table class="tableblock frame-all grid-all stretch">
463
463
  <colgroup>
464
- <col style="width: 20%;">
465
- <col style="width: 20%;">
466
- <col style="width: 60%;">
464
+ <col style="width: 25%;">
465
+ <col style="width: 75%;">
467
466
  </colgroup>
468
467
  <tbody>
469
468
  <tr>
470
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
471
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
469
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Value</p></td>
472
470
  <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
473
471
  </tr>
474
472
  <tr>
475
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>id</code></p></td>
476
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>string</code></p></td>
477
- <td class="tableblock halign-left valign-top"><p class="tableblock">The unique identifier of the game instance.</p></td>
473
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code>PLAYING</code></p></td>
474
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The game is actively running.</p></td>
478
475
  </tr>
479
476
  <tr>
480
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td>
481
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>string</code></p></td>
482
- <td class="tableblock halign-left valign-top"><p class="tableblock">The human-readable label for the game.</p></td>
477
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code>PAUSED</code></p></td>
478
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The game is started but currently halted.</p></td>
483
479
  </tr>
484
480
  <tr>
485
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>url</code></p></td>
486
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>string</code></p></td>
487
- <td class="tableblock halign-left valign-top"><p class="tableblock">The remote URL of the game&#8217;s JavaScript bundle.</p></td>
481
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code>TITLE</code></p></td>
482
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The engine is powered on but the game has not started yet.</p></td>
483
+ </tr>
484
+ <tr>
485
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code>GAMEOVER</code></p></td>
486
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The current game session has ended.</p></td>
488
487
  </tr>
489
488
  </tbody>
490
489
  </table>
@@ -494,7 +493,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
494
493
  <h2 id="general-usage"><a class="link" href="#general-usage">2. General Usage</a></h2>
495
494
  <div class="sectionbody">
496
495
  <div class="paragraph">
497
- <p>The repository uses <code>GameEntry</code> to populate menu lists and manage the lifecycle of different game instances.</p>
496
+ <p>These suffixes are used by the <code><a href="../modules/EventEmitter.html">EventEmitter</a></code> to construct specialized event names (e.g., <code>UP:pressed:playing</code>) and by modules like <code><a href="../modules/GameControl.html">GameControl</a></code> and <code><a href="../modules/GameState.html">GameState</a></code> for state-scoped subscriptions.</p>
498
497
  </div>
499
498
  </div>
500
499
  </div>
package/dist/docs/reference/helpers/CoordinateHelper.html CHANGED
@@ -445,11 +445,11 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
445
445
  <ul class="sectlevel1">
446
446
  <li><a href="#api-reference">1. API Reference</a>
447
447
  <ul class="sectlevel2">
448
- <li><a href="#getrelativecoordinatep-p5-coordinate-coordinate-coordinate">1.1. <code>getRelativeCoordinate(p: p5, coordinate: Coordinate): Coordinate</code></a></li>
449
- <li><a href="#getdisplayposxp-p5-x-number-displaywidth-number-number">1.2. <code>getDisplayPosX(p: p5, x: number, displayWidth: number): number</code></a></li>
450
- <li><a href="#getdisplayposyp-p5-y-number-displayheight-number-number">1.3. <code>getDisplayPosY(p: p5, y: number, displayHeight: number): number</code></a></li>
451
- <li><a href="#gethudposxp-p5-x-number-displaywidth-number-number">1.4. <code>getHudPosX(p: p5, x: number, displayWidth: number): number</code></a></li>
452
- <li><a href="#gethudposyp-p5-y-number-displayheight-number-number">1.5. <code>getHudPosY(p: p5, y: number, displayHeight: number): number</code></a></li>
448
+ <li><a href="#getrelativecoordinatecoordinate-coordinate-coordinate">1.1. <code>getRelativeCoordinate(coordinate: Coordinate): Coordinate</code></a></li>
449
+ <li><a href="#getdisplayposxx-number-displaywidth-number-number">1.2. <code>getDisplayPosX(x: number, displayWidth: number): number</code></a></li>
450
+ <li><a href="#getdisplayposyy-number-displayheight-number-number">1.3. <code>getDisplayPosY(y: number, displayHeight: number): number</code></a></li>
451
+ <li><a href="#gethudposxx-number-displaywidth-number-number">1.4. <code>getHudPosX(x: number, displayWidth: number): number</code></a></li>
452
+ <li><a href="#gethudposyy-number-displayheight-number-number">1.5. <code>getHudPosY(y: number, displayHeight: number): number</code></a></li>
453
453
  </ul>
454
454
  </li>
455
455
  </ul>
@@ -467,7 +467,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
467
467
  <h2 id="api-reference"><a class="link" href="#api-reference">1. API Reference</a></h2>
468
468
  <div class="sectionbody">
469
469
  <div class="sect2">
470
- <h3 id="getrelativecoordinatep-p5-coordinate-coordinate-coordinate"><a class="link" href="#getrelativecoordinatep-p5-coordinate-coordinate-coordinate">1.1. <code>getRelativeCoordinate(p: p5, coordinate: <a href="../types/Coordinate.html">Coordinate</a>): <a href="../types/Coordinate.html">Coordinate</a></code></a></h3>
470
+ <h3 id="getrelativecoordinatecoordinate-coordinate-coordinate"><a class="link" href="#getrelativecoordinatecoordinate-coordinate-coordinate">1.1. <code>getRelativeCoordinate(coordinate: <a href="../types/Coordinate.html">Coordinate</a>): <a href="../types/Coordinate.html">Coordinate</a></code></a></h3>
471
471
  <div class="paragraph">
472
472
  <p>Converts a pixel-based coordinate into a normalized relative coordinate (0.0 to 1.0).</p>
473
473
  </div>
@@ -487,11 +487,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
487
487
  <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
488
488
  </tr>
489
489
  <tr>
490
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>p</code></p></td>
491
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>p5</code></p></td>
492
- <td class="tableblock halign-left valign-top"><p class="tableblock">The P5.js instance.</p></td>
493
- </tr>
494
- <tr>
495
490
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>coordinate</code></p></td>
496
491
  <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../types/Coordinate.html">Coordinate</a></p></td>
497
492
  <td class="tableblock halign-left valign-top"><p class="tableblock">The absolute pixel coordinate.</p></td>
@@ -507,7 +502,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
507
502
  <hr>
508
503
  </div>
509
504
  <div class="sect2">
510
- <h3 id="getdisplayposxp-p5-x-number-displaywidth-number-number"><a class="link" href="#getdisplayposxp-p5-x-number-displaywidth-number-number">1.2. <code>getDisplayPosX(p: p5, x: number, displayWidth: number): number</code></a></h3>
505
+ <h3 id="getdisplayposxx-number-displaywidth-number-number"><a class="link" href="#getdisplayposxx-number-displaywidth-number-number">1.2. <code>getDisplayPosX(x: number, displayWidth: number): number</code></a></h3>
511
506
  <div class="paragraph">
512
507
  <p>Calculates the absolute X pixel position on the main game display.</p>
513
508
  </div>
@@ -527,11 +522,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
527
522
  <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
528
523
  </tr>
529
524
  <tr>
530
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>p</code></p></td>
531
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>p5</code></p></td>
532
- <td class="tableblock halign-left valign-top"><p class="tableblock">The P5.js instance.</p></td>
533
- </tr>
534
- <tr>
535
525
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>x</code></p></td>
536
526
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
537
527
  <td class="tableblock halign-left valign-top"><p class="tableblock">Normalized horizontal position (0.0 to 1.0).</p></td>
@@ -552,7 +542,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
552
542
  <hr>
553
543
  </div>
554
544
  <div class="sect2">
555
- <h3 id="getdisplayposyp-p5-y-number-displayheight-number-number"><a class="link" href="#getdisplayposyp-p5-y-number-displayheight-number-number">1.3. <code>getDisplayPosY(p: p5, y: number, displayHeight: number): number</code></a></h3>
545
+ <h3 id="getdisplayposyy-number-displayheight-number-number"><a class="link" href="#getdisplayposyy-number-displayheight-number-number">1.3. <code>getDisplayPosY(y: number, displayHeight: number): number</code></a></h3>
556
546
  <div class="paragraph">
557
547
  <p>Calculates the absolute Y pixel position on the main game display.</p>
558
548
  </div>
@@ -572,11 +562,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
572
562
  <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
573
563
  </tr>
574
564
  <tr>
575
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>p</code></p></td>
576
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>p5</code></p></td>
577
- <td class="tableblock halign-left valign-top"><p class="tableblock">The P5.js instance.</p></td>
578
- </tr>
579
- <tr>
580
565
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>y</code></p></td>
581
566
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
582
567
  <td class="tableblock halign-left valign-top"><p class="tableblock">Normalized vertical position (0.0 to 1.0).</p></td>
@@ -597,7 +582,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
597
582
  <hr>
598
583
  </div>
599
584
  <div class="sect2">
600
- <h3 id="gethudposxp-p5-x-number-displaywidth-number-number"><a class="link" href="#gethudposxp-p5-x-number-displaywidth-number-number">1.4. <code>getHudPosX(p: p5, x: number, displayWidth: number): number</code></a></h3>
585
+ <h3 id="gethudposxx-number-displaywidth-number-number"><a class="link" href="#gethudposxx-number-displaywidth-number-number">1.4. <code>getHudPosX(x: number, displayWidth: number): number</code></a></h3>
601
586
  <div class="paragraph">
602
587
  <p>Calculates the absolute X pixel position within the HUD area.</p>
603
588
  </div>
@@ -617,11 +602,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
617
602
  <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
618
603
  </tr>
619
604
  <tr>
620
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>p</code></p></td>
621
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>p5</code></p></td>
622
- <td class="tableblock halign-left valign-top"><p class="tableblock">The P5.js instance.</p></td>
623
- </tr>
624
- <tr>
625
605
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>x</code></p></td>
626
606
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
627
607
  <td class="tableblock halign-left valign-top"><p class="tableblock">Normalized horizontal position (0.0 to 1.0) relative to the HUD area.</p></td>
@@ -642,7 +622,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
642
622
  <hr>
643
623
  </div>
644
624
  <div class="sect2">
645
- <h3 id="gethudposyp-p5-y-number-displayheight-number-number"><a class="link" href="#gethudposyp-p5-y-number-displayheight-number-number">1.5. <code>getHudPosY(p: p5, y: number, displayHeight: number): number</code></a></h3>
625
+ <h3 id="gethudposyy-number-displayheight-number-number"><a class="link" href="#gethudposyy-number-displayheight-number-number">1.5. <code>getHudPosY(y: number, displayHeight: number): number</code></a></h3>
646
626
  <div class="paragraph">
647
627
  <p>Calculates the absolute Y pixel position within the HUD area.</p>
648
628
  </div>
@@ -662,11 +642,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
662
642
  <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
663
643
  </tr>
664
644
  <tr>
665
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>p</code></p></td>
666
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>p5</code></p></td>
667
- <td class="tableblock halign-left valign-top"><p class="tableblock">The P5.js instance.</p></td>
668
- </tr>
669
- <tr>
670
645
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>y</code></p></td>
671
646
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
672
647
  <td class="tableblock halign-left valign-top"><p class="tableblock">Normalized vertical position (0.0 to 1.0) relative to the HUD area.</p></td>
package/dist/docs/reference/helpers/RelativeValuesHelper.html CHANGED
@@ -445,8 +445,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
445
445
  <ul class="sectlevel1">
446
446
  <li><a href="#methods">1. Methods</a>
447
447
  <ul class="sectlevel2">
448
- <li><a href="#getrelativewidthp-p5-size-number-number">1.1. <code>getRelativeWidth(p: p5, size: number): number</code></a></li>
449
- <li><a href="#getrelativeheightp-p5-size-number-number">1.2. <code>getRelativeHeight(p: p5, size: number): number</code></a></li>
448
+ <li><a href="#getrelativewidthsize-number-number">1.1. <code>getRelativeWidth(size: number): number</code></a></li>
449
+ <li><a href="#getrelativeheightsize-number-number">1.2. <code>getRelativeHeight(size: number): number</code></a></li>
450
450
  </ul>
451
451
  </li>
452
452
  </ul>
@@ -464,7 +464,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
464
464
  <h2 id="methods"><a class="link" href="#methods">1. Methods</a></h2>
465
465
  <div class="sectionbody">
466
466
  <div class="sect2">
467
- <h3 id="getrelativewidthp-p5-size-number-number"><a class="link" href="#getrelativewidthp-p5-size-number-number">1.1. <code>getRelativeWidth(p: p5, size: number): number</code></a></h3>
467
+ <h3 id="getrelativewidthsize-number-number"><a class="link" href="#getrelativewidthsize-number-number">1.1. <code>getRelativeWidth(size: number): number</code></a></h3>
468
468
  <div class="paragraph">
469
469
  <p>Calculates a pixel width based on a normalized percentage.</p>
470
470
  </div>
@@ -484,11 +484,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
484
484
  <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
485
485
  </tr>
486
486
  <tr>
487
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>p</code></p></td>
488
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>p5</code></p></td>
489
- <td class="tableblock halign-left valign-top"><p class="tableblock">The P5.js instance.</p></td>
490
- </tr>
491
- <tr>
492
487
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>size</code></p></td>
493
488
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
494
489
  <td class="tableblock halign-left valign-top"><p class="tableblock">A float between 0.0 and 1.0 representing percentage of width.</p></td>
@@ -504,7 +499,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
504
499
  <hr>
505
500
  </div>
506
501
  <div class="sect2">
507
- <h3 id="getrelativeheightp-p5-size-number-number"><a class="link" href="#getrelativeheightp-p5-size-number-number">1.2. <code>getRelativeHeight(p: p5, size: number): number</code></a></h3>
502
+ <h3 id="getrelativeheightsize-number-number"><a class="link" href="#getrelativeheightsize-number-number">1.2. <code>getRelativeHeight(size: number): number</code></a></h3>
508
503
  <div class="paragraph">
509
504
  <p>Calculates a pixel height based on a normalized percentage.</p>
510
505
  </div>
@@ -524,11 +519,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
524
519
  <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
525
520
  </tr>
526
521
  <tr>
527
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>p</code></p></td>
528
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>p5</code></p></td>
529
- <td class="tableblock halign-left valign-top"><p class="tableblock">The P5.js instance.</p></td>
530
- </tr>
531
- <tr>
532
522
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>size</code></p></td>
533
523
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>number</code></p></td>
534
524
  <td class="tableblock halign-left valign-top"><p class="tableblock">A float between 0.0 and 1.0 representing percentage of height.</p></td>
package/dist/docs/reference/interfaces/GameModules.html CHANGED
@@ -473,47 +473,52 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
473
473
  </tr>
474
474
  <tr>
475
475
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>grid</code></p></td>
476
- <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="modules/Grid.html">Grid</a></p></td>
476
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../modules/GameGrid.html">GameGrid</a></code></p></td>
477
477
  <td class="tableblock halign-left valign-top"><p class="tableblock">Main game field manager.</p></td>
478
478
  </tr>
479
479
  <tr>
480
480
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>hudGrid</code></p></td>
481
- <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="modules/Grid.html">Grid</a></p></td>
481
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../modules/GameHudGrid.html">GameHudGrid</a></code></p></td>
482
482
  <td class="tableblock halign-left valign-top"><p class="tableblock">Secondary 4x4 grid for HUD elements.</p></td>
483
483
  </tr>
484
484
  <tr>
485
485
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>state</code></p></td>
486
- <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="modules/State.html">State</a></p></td>
486
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../modules/GameState.html">GameState</a></code></p></td>
487
487
  <td class="tableblock halign-left valign-top"><p class="tableblock">Single source of truth for game flags.</p></td>
488
488
  </tr>
489
489
  <tr>
490
490
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>control</code></p></td>
491
- <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="modules/Control.html">Control</a></p></td>
491
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../modules/GameControl.html">GameControl</a></code></p></td>
492
492
  <td class="tableblock halign-left valign-top"><p class="tableblock">Input handling service.</p></td>
493
493
  </tr>
494
494
  <tr>
495
495
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td>
496
- <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="modules/Text.html">Text</a></p></td>
496
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../modules/GameText.html">GameText</a></code></p></td>
497
497
  <td class="tableblock halign-left valign-top"><p class="tableblock">Canvas typography service.</p></td>
498
498
  </tr>
499
499
  <tr>
500
500
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>time</code></p></td>
501
- <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="modules/Time.html">Time</a></p></td>
501
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../modules/GameTime.html">GameTime</a></code></p></td>
502
502
  <td class="tableblock halign-left valign-top"><p class="tableblock">Logical clock manager.</p></td>
503
503
  </tr>
504
504
  <tr>
505
505
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>sound</code></p></td>
506
- <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="Sound.html">Sound</a></p></td>
506
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../modules/GameSound.html">GameSound</a></code></p></td>
507
507
  <td class="tableblock halign-left valign-top"><p class="tableblock">Audio playback service.</p></td>
508
508
  </tr>
509
509
  <tr>
510
510
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>score</code></p></td>
511
- <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="modules/Score.html">Score</a></p></td>
511
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../modules/GameScore.html">GameScore</a></code></p></td>
512
512
  <td class="tableblock halign-left valign-top"><p class="tableblock">Session performance tracker.</p></td>
513
513
  </tr>
514
514
  <tr>
515
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code>session</code></p></td>
516
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../modules/GameSession.html">GameSession</a></code></p></td>
517
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The manager for intra-session progress.</p></td>
518
+ </tr>
519
+ <tr>
515
520
  <td class="tableblock halign-left valign-top"><p class="tableblock"><code>renderer</code></p></td>
516
- <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="modules/RendererComposite.html">RendererComposite</a></p></td>
521
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../modules/GameRenderer.html">GameRenderer</a></code></p></td>
517
522
  <td class="tableblock halign-left valign-top"><p class="tableblock">The visual orchestration layer.</p></td>
518
523
  </tr>
519
524
  </tbody>
package/dist/docs/reference/{modules/GameMenu.html → interfaces/StateContext.html} RENAMED
@@ -5,9 +5,9 @@
5
5
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
6
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
7
7
  <meta name="generator" content="Asciidoctor 2.0.20">
8
- <meta name="description" content="Represents the orchestrator entry state, allowing navigation between games.">
9
- <meta name="keywords" content="menu, selection, entry point, root">
10
- <title>GameMenu Module Reference</title>
8
+ <meta name="description" content="Interface for querying the current engine lifecycle context.">
9
+ <meta name="keywords" content="interface, state, context, lifecycle">
10
+ <title>StateContext Reference</title>
11
11
  <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">
12
12
  <style>
13
13
  /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
@@ -435,30 +435,16 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
435
435
  @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
436
436
  </style>
437
437
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
438
+ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/styles/github.min.css">
438
439
  </head>
439
440
  <body class="article toc2 toc-left">
440
441
  <div id="header">
441
- <h1>GameMenu Module Reference</h1>
442
+ <h1>StateContext Reference</h1>
442
443
  <div id="toc" class="toc2">
443
444
  <div id="toctitle">Table of Contents</div>
444
445
  <ul class="sectlevel1">
445
- <li><a href="#_initialization_configuration">1. Initialization &amp; Configuration</a>
446
- <ul class="sectlevel2">
447
- <li><a href="#_setupgame_void">1.1. <code>setupGame(): void</code></a></li>
448
- <li><a href="#_gameid_property">1.2. <code>gameId</code> Property</a></li>
449
- </ul>
450
- </li>
451
- <li><a href="#_rendering">2. Rendering</a>
452
- <ul class="sectlevel2">
453
- <li><a href="#_drawtitlescreen_void">2.1. <code>drawTitleScreen(): void</code></a></li>
454
- <li><a href="#_drawgameoverscreen_void">2.2. <code>drawGameOverScreen(): void</code></a></li>
455
- </ul>
456
- </li>
457
- <li><a href="#_event_handling">3. Event Handling</a>
458
- <ul class="sectlevel2">
459
- <li><a href="#_menu_controls">3.1. Menu Controls</a></li>
460
- </ul>
461
- </li>
446
+ <li><a href="#methods">1. Methods</a></li>
447
+ <li><a href="#general-usage">2. General Usage</a></li>
462
448
  </ul>
463
449
  </div>
464
450
  </div>
@@ -466,73 +452,66 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
466
452
  <div id="preamble">
467
453
  <div class="sectionbody">
468
454
  <div class="paragraph">
469
- <p>The <code>GameMenu</code> is a concrete implementation of <code><a href="Game.html">Game</a></code>. It serves as the primary gateway or entry screen for players, allowing them to browse and select which logic/game module to initialize from the central <code>GameRepository</code>.</p>
455
+ <p>The <code>StateContext</code> interface provides a read-only view of the engine&#8217;s current lifecycle state. It is primarily used by the <code><a href="../modules/EventEmitter.html">EventEmitter</a></code> to determine which contextual channels to notify.</p>
470
456
  </div>
471
457
  </div>
472
458
  </div>
473
459
  <div class="sect1">
474
- <h2 id="_initialization_configuration"><a class="link" href="#_initialization_configuration">1. Initialization &amp; Configuration</a></h2>
460
+ <h2 id="methods"><a class="link" href="#methods">1. Methods</a></h2>
475
461
  <div class="sectionbody">
476
- <div class="sect2">
477
- <h3 id="_setupgame_void"><a class="link" href="#_setupgame_void">1.1. <code>setupGame(): void</code></a></h3>
478
- <div class="paragraph">
479
- <p>Adjusts formatting and presentation logic specific to the menu&#8217;s state (e.g., Font setup). Unbinds standard game inputs and hooks into UP/DOWN/ENTER for menu navigation.</p>
480
- </div>
481
- </div>
482
- <div class="sect2">
483
- <h3 id="_gameid_property"><a class="link" href="#_gameid_property">1.2. <code>gameId</code> Property</a></h3>
484
- <div class="paragraph">
485
- <p>Set to <code>game-menu</code> upon instantiation. This ensures the menu state is intentionally ignored by the <code><a href="GameSession.html">GameSession</a></code> mechanism, averting logic conflicts that would try to parse the "menu" as a playable state.</p>
486
- </div>
487
- </div>
462
+ <table class="tableblock frame-all grid-all stretch">
463
+ <colgroup>
464
+ <col style="width: 25%;">
465
+ <col style="width: 75%;">
466
+ </colgroup>
467
+ <tbody>
468
+ <tr>
469
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Method</p></td>
470
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
471
+ </tr>
472
+ <tr>
473
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code>isOn()</code></p></td>
474
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Returns <code>true</code> if the system is powered on.</p></td>
475
+ </tr>
476
+ <tr>
477
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code>isStarted()</code></p></td>
478
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Returns <code>true</code> if a game session has begun.</p></td>
479
+ </tr>
480
+ <tr>
481
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code>isPlaying()</code></p></td>
482
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Returns <code>true</code> if gameplay is active and not paused.</p></td>
483
+ </tr>
484
+ <tr>
485
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code>isPaused()</code></p></td>
486
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Returns <code>true</code> if the game is started but halted.</p></td>
487
+ </tr>
488
+ <tr>
489
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code>isGameOver()</code></p></td>
490
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Returns <code>true</code> if the player has lost.</p></td>
491
+ </tr>
492
+ </tbody>
493
+ </table>
488
494
  </div>
489
495
  </div>
490
496
  <div class="sect1">
491
- <h2 id="_rendering"><a class="link" href="#_rendering">2. Rendering</a></h2>
497
+ <h2 id="general-usage"><a class="link" href="#general-usage">2. General Usage</a></h2>
492
498
  <div class="sectionbody">
493
- <div class="sect2">
494
- <h3 id="_drawtitlescreen_void"><a class="link" href="#_drawtitlescreen_void">2.1. <code>drawTitleScreen(): void</code></a></h3>
495
- <div class="paragraph">
496
- <p>Renders the interactive menu. Reads from <code>GameRepository</code> and formats the available games interactively according to the internal active pointer value (<code>_gameSelectionPointer</code>). Updates dynamically when UP/DOWN are pressed.</p>
497
- </div>
498
- </div>
499
- <div class="sect2">
500
- <h3 id="_drawgameoverscreen_void"><a class="link" href="#_drawgameoverscreen_void">2.2. <code>drawGameOverScreen(): void</code></a></h3>
501
499
  <div class="paragraph">
502
- <p>The <code>GameMenu</code> does not have a Game Over logic screen hook. Attempting to enter the <code>GAME_OVER</code> state will have no visual effect.</p>
503
- </div>
504
- </div>
505
- </div>
506
- </div>
507
- <div class="sect1">
508
- <h2 id="_event_handling"><a class="link" href="#_event_handling">3. Event Handling</a></h2>
509
- <div class="sectionbody">
510
- <div class="sect2">
511
- <h3 id="_menu_controls"><a class="link" href="#_menu_controls">3.1. Menu Controls</a></h3>
512
- <div class="ulist">
513
- <ul>
514
- <li>
515
- <p><strong>UP</strong>: Decrements the selection pointer.</p>
516
- </li>
517
- <li>
518
- <p><strong>DOWN</strong>: Increments the selection pointer.</p>
519
- </li>
520
- <li>
521
- <p><strong>START_PAUSE</strong> (Enter): Instantiates the game at the current selection pointer and invokes <code>this.switchGame()</code> to seamlessly hand over control.</p>
522
- </li>
523
- <li>
524
- <p><strong>EXIT</strong>: In the context of the menu, it does not apply switching behaviors.</p>
525
- </li>
526
- </ul>
527
- </div>
500
+ <p>This interface is implemented by <code><a href="../modules/GameState.html">GameState</a></code> and is consumed by <code>notifyContextual</code> in the <code>EventEmitter</code>.</p>
528
501
  </div>
529
502
  </div>
530
503
  </div>
531
504
  </div>
532
505
  <div id="footer">
533
506
  <div id="footer-text">
534
- Last updated 2026-02-23 16:03:32 -0300
535
507
  </div>
536
508
  </div>
509
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
510
+ <script>
511
+ if (!hljs.initHighlighting.called) {
512
+ hljs.initHighlighting.called = true
513
+ ;[].slice.call(document.querySelectorAll('pre.highlight > code[data-lang]')).forEach(function (el) { hljs.highlightBlock(el) })
514
+ }
515
+ </script>
537
516
  </body>
538
517
  </html>
package/dist/docs/reference/interfaces/modules/Score.html CHANGED
@@ -451,7 +451,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
451
451
  <li><a href="#getformattedscoredigits-number-string">2.3. <code>getFormattedScore(digits?: number): string</code></a></li>
452
452
  <li><a href="#increaselevelamount-number-void">2.4. <code>increaseLevel(amount: number): void</code></a></li>
453
453
  <li><a href="#resetlevel-void">2.5. <code>resetLevel(): void</code></a></li>
454
- <li><a href="#setstatestate-state-void">2.6. <code>setState(state: State): void</code></a></li>
454
+ <li><a href="#setupgamehighscoreid-string-void">2.6. <code>setupGameHighScore(id: string): void</code></a></li>
455
455
  </ul>
456
456
  </li>
457
457
  <li><a href="#general-usage">3. General Usage</a></li>
@@ -616,9 +616,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
616
616
  <hr>
617
617
  </div>
618
618
  <div class="sect2">
619
- <h3 id="setstatestate-state-void"><a class="link" href="#setstatestate-state-void">2.6. <code>setState(state: <a href="State.html">State</a>): void</code></a></h3>
619
+ <h3 id="setupgamehighscoreid-string-void"><a class="link" href="#setupgamehighscoreid-string-void">2.6. <code>setupGameHighScore(id: string): void</code></a></h3>
620
620
  <div class="paragraph">
621
- <p>Internal setup method to link the score module with high-score persistence logic.</p>
621
+ <p>Initializes the high score for a specific game, loading it from namespaced storage.</p>
622
622
  </div>
623
623
  <div class="paragraph">
624
624
  <p><strong>Parameters</strong></p>
@@ -636,9 +636,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
636
636
  <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
637
637
  </tr>
638
638
  <tr>
639
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>state</code></p></td>
640
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="State.html">State</a></code></p></td>
641
- <td class="tableblock halign-left valign-top"><p class="tableblock">The global state manager.</p></td>
639
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code>id</code></p></td>
640
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code>string</code></p></td>
641
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The unique identifier of the game (e.g., from <code><a href="../modules/Game.html">Game.gameId</a></code>).</p></td>
642
642
  </tr>
643
643
  </tbody>
644
644
  </table>
package/dist/docs/reference/interfaces/modules/Session.html CHANGED
@@ -449,6 +449,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
449
449
  <li><a href="#_savesession_void">2.2. <code>saveSession(): void</code></a></li>
450
450
  <li><a href="#_clearsession_void">2.3. <code>clearSession(): void</code></a></li>
451
451
  <li><a href="#_setshowmodalfunctionshowmodal_onconfirm_void_oncancel_void_void_void">2.4. <code>setShowModalFunction(showModal: (onConfirm: () &#8658; void, onCancel: () &#8658; void) &#8658; void): void</code></a></li>
452
+ <li><a href="#_setsessionenabledenabled_boolean_void">2.5. <code>setSessionEnabled(enabled: boolean): void</code></a></li>
452
453
  </ul>
453
454
  </li>
454
455
  <li><a href="#_general_usage">3. General Usage</a></li>
@@ -564,6 +565,35 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
564
565
  </tr>
565
566
  </tbody>
566
567
  </table>
568
+ <hr>
569
+ </div>
570
+ <div class="sect2">
571
+ <h3 id="_setsessionenabledenabled_boolean_void"><a class="link" href="#_setsessionenabledenabled_boolean_void">2.5. <code>setSessionEnabled(enabled: boolean): void</code></a></h3>
572
+ <div class="paragraph">
573
+ <p>Enables or disables the session recovery mechanism for the current game instance.</p>
574
+ </div>
575
+ <div class="paragraph">
576
+ <p><strong>Parameters</strong></p>
577
+ </div>
578
+ <table class="tableblock frame-all grid-all stretch">
579
+ <colgroup>
580
+ <col style="width: 20%;">
581
+ <col style="width: 20%;">
582
+ <col style="width: 60%;">
583
+ </colgroup>
584
+ <tbody>
585
+ <tr>
586
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
587
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
588
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
589
+ </tr>
590
+ <tr>
591
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code>enabled</code></p></td>
592
+ <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean</code></p></td>
593
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Whether the session recovery should be enabled.</p></td>
594
+ </tr>
595
+ </tbody>
596
+ </table>
567
597
  </div>
568
598
  </div>
569
599
  </div>
@@ -578,7 +608,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
578
608
  </div>
579
609
  <div id="footer">
580
610
  <div id="footer-text">
581
- Last updated 2026-02-23 16:03:34 -0300
611
+ Last updated 2026-02-24 23:17:40 -0300
582
612
  </div>
583
613
  </div>
584
614
  </body>