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.
Files changed (98) hide show
  1. package/README.adoc +2 -2
  2. package/dist/docs/index.html +3 -3
  3. package/dist/docs/jsdoc_standard.html +30 -13
  4. package/dist/docs/reference/bootstrap.html +556 -0
  5. package/dist/docs/reference/context/RendererContext.html +19 -9
  6. package/dist/docs/reference/enums/Color.html +11 -5
  7. package/dist/docs/reference/enums/ControlEventType.html +7 -5
  8. package/dist/docs/reference/enums/ControlKey.html +7 -5
  9. package/dist/docs/reference/enums/EventSuffix.html +7 -5
  10. package/dist/docs/reference/enums/FontAlignment.html +9 -7
  11. package/dist/docs/reference/enums/FontSize.html +7 -5
  12. package/dist/docs/reference/enums/Sound.html +7 -5
  13. package/dist/docs/reference/enums/StateProperty.html +7 -5
  14. package/dist/docs/reference/helpers/CellHelper.html +6 -2
  15. package/dist/docs/reference/helpers/ControlInputHandlerHelper.html +9 -5
  16. package/dist/docs/reference/helpers/CoordinateHelper.html +14 -10
  17. package/dist/docs/reference/helpers/RelativeValuesHelper.html +7 -3
  18. package/dist/docs/reference/interfaces/Debuggable.html +9 -7
  19. package/dist/docs/reference/interfaces/GameModules.html +7 -5
  20. package/dist/docs/reference/interfaces/Initializable.html +9 -7
  21. package/dist/docs/reference/interfaces/RendererInitializable.html +9 -7
  22. package/dist/docs/reference/interfaces/StateContext.html +7 -5
  23. package/dist/docs/reference/interfaces/StateSyncable.html +11 -9
  24. package/dist/docs/reference/interfaces/modules/Control.html +19 -17
  25. package/dist/docs/reference/interfaces/modules/Grid.html +77 -55
  26. package/dist/docs/reference/interfaces/modules/Renderer.html +9 -7
  27. package/dist/docs/reference/interfaces/modules/RendererComposite.html +13 -11
  28. package/dist/docs/reference/interfaces/modules/Score.html +21 -19
  29. package/dist/docs/reference/interfaces/modules/Session.html +64 -18
  30. package/dist/docs/reference/interfaces/modules/State.html +59 -57
  31. package/dist/docs/reference/interfaces/modules/Text.html +21 -19
  32. package/dist/docs/reference/interfaces/modules/Time.html +80 -24
  33. package/dist/docs/reference/modules/Debugger.html +16 -14
  34. package/dist/docs/reference/modules/DisplayRenderer.html +10 -8
  35. package/dist/docs/reference/modules/EventEmitter.html +34 -26
  36. package/dist/docs/reference/modules/Game.html +55 -30
  37. package/dist/docs/reference/modules/GameControl.html +49 -44
  38. package/dist/docs/reference/modules/GameEventRegistry.html +17 -34
  39. package/dist/docs/reference/modules/GameGrid.html +174 -116
  40. package/dist/docs/reference/modules/GameHudGrid.html +10 -8
  41. package/dist/docs/reference/modules/GameRenderer.html +14 -12
  42. package/dist/docs/reference/modules/GameScore.html +36 -34
  43. package/dist/docs/reference/modules/GameSession.html +37 -19
  44. package/dist/docs/reference/modules/GameSound.html +20 -18
  45. package/dist/docs/reference/modules/GameState.html +70 -68
  46. package/dist/docs/reference/modules/GameText.html +29 -27
  47. package/dist/docs/reference/modules/GameTime.html +98 -30
  48. package/dist/docs/reference/modules/HudRenderer.html +10 -8
  49. package/dist/docs/reference/modules/InitialStateSnapshot.html +13 -11
  50. package/dist/docs/reference/modules/SessionModal.html +11 -9
  51. package/dist/docs/reference/types/Axis.html +7 -5
  52. package/dist/docs/reference/types/Cell.html +7 -5
  53. package/dist/docs/reference/types/ControlCallback.html +7 -5
  54. package/dist/docs/reference/types/Coordinate.html +7 -5
  55. package/dist/docs/reference/types/GameEvent.html +7 -5
  56. package/dist/docs/reference/types/Piece.html +7 -5
  57. package/dist/docs/reference/types/RendererMetrics.html +7 -5
  58. package/dist/docs/reference/types/Vector.html +7 -5
  59. package/dist/docs/reference/view/GameView.html +29 -21
  60. package/dist/docs/testing_best_practices.html +2 -2
  61. package/dist/game.bundle.js +1 -1
  62. package/dist/types/bootstrap.d.ts +12 -11
  63. package/dist/types/core/Game.d.ts +46 -39
  64. package/dist/types/core/InitialStateSnapshot.d.ts +18 -6
  65. package/dist/types/core/context/RendererContext.d.ts +32 -10
  66. package/dist/types/core/event/EventEmitter.d.ts +64 -21
  67. package/dist/types/core/event/GameEventRegistry.d.ts +17 -3
  68. package/dist/types/core/helpers/CellHelper.d.ts +11 -4
  69. package/dist/types/core/helpers/ControlInputHandlerHelper.d.ts +20 -11
  70. package/dist/types/core/helpers/CoordinateHelper.d.ts +28 -23
  71. package/dist/types/core/helpers/InterfaceIdentifierHelper.d.ts +34 -0
  72. package/dist/types/core/helpers/RelativeValuesHelper.d.ts +10 -8
  73. package/dist/types/core/module/control/GameControl.d.ts +26 -14
  74. package/dist/types/core/module/grid/GameGrid.d.ts +68 -53
  75. package/dist/types/core/module/grid/GameHudGrid.d.ts +9 -7
  76. package/dist/types/core/module/grid/engines/GridAnalysisEngine.d.ts +25 -6
  77. package/dist/types/core/module/grid/engines/GridLineEngine.d.ts +51 -13
  78. package/dist/types/core/module/grid/engines/GridMovementEngine.d.ts +97 -13
  79. package/dist/types/core/module/grid/engines/GridRegionEngine.d.ts +24 -5
  80. package/dist/types/core/module/grid/engines/GridTransformEngine.d.ts +21 -5
  81. package/dist/types/core/module/renderer/DisplayRenderer.d.ts +27 -15
  82. package/dist/types/core/module/renderer/GameRenderer.d.ts +20 -13
  83. package/dist/types/core/module/renderer/HudRenderer.d.ts +27 -19
  84. package/dist/types/core/module/score/GameScore.d.ts +29 -18
  85. package/dist/types/core/module/session/GameSession.d.ts +56 -0
  86. package/dist/types/core/module/sound/GameSound.d.ts +39 -23
  87. package/dist/types/core/module/state/GameState.d.ts +38 -14
  88. package/dist/types/core/module/text/GameText.d.ts +40 -25
  89. package/dist/types/core/module/time/GameTime.d.ts +23 -10
  90. package/dist/types/core/types/Interfaces.d.ts +15 -0
  91. package/dist/types/core/types/Types.d.ts +1 -0
  92. package/dist/types/core/types/enums.d.ts +2 -1
  93. package/dist/types/core/types/modules.d.ts +193 -43
  94. package/dist/types/view/Debugger.d.ts +23 -0
  95. package/dist/types/view/GameView.d.ts +44 -27
  96. package/dist/types/view/SessionModal.d.ts +24 -0
  97. package/package.json +1 -1
  98. package/dist/CNAME +0 -1
package/dist/docs/reference/interfaces/GameModules.html CHANGED
@@ -443,13 +443,15 @@ 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="#properties">1. Properties</a></li>
447
- <li><a href="#general-usage">2. General Usage</a></li>
446
+ <li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
447
+ <li><a href="#properties">2. Properties</a></li>
448
+ <li><a href="#general-usage">3. General Usage</a></li>
448
449
  </ul>
449
450
  </div>
450
451
  </div>
451
452
  <div id="content">
452
- <div id="preamble">
453
+ <div class="sect1">
454
+ <h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
453
455
  <div class="sectionbody">
454
456
  <div class="paragraph">
455
457
  <p>The central hub providing component-to-component visibility.</p>
@@ -457,7 +459,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
457
459
  </div>
458
460
  </div>
459
461
  <div class="sect1">
460
- <h2 id="properties"><a class="link" href="#properties">1. Properties</a></h2>
462
+ <h2 id="properties"><a class="link" href="#properties">2. Properties</a></h2>
461
463
  <div class="sectionbody">
462
464
  <table class="tableblock frame-all grid-all stretch">
463
465
  <colgroup>
@@ -526,7 +528,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
526
528
  </div>
527
529
  </div>
528
530
  <div class="sect1">
529
- <h2 id="general-usage"><a class="link" href="#general-usage">2. General Usage</a></h2>
531
+ <h2 id="general-usage"><a class="link" href="#general-usage">3. General Usage</a></h2>
530
532
  <div class="sectionbody">
531
533
  <div class="paragraph">
532
534
  <p>This registry is passed to almost every lifecycle method (<code>update</code>, <code>render</code>, <code>ControlCallback</code>). It allows modules to interact without tight coupling. For example, the <code><a href="modules/Sound.html">Sound</a></code> module uses it to play sounds via <code>modules.sound.play()</code>.</p>
package/dist/docs/reference/interfaces/Initializable.html CHANGED
@@ -443,17 +443,19 @@ 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="#methods">1. Methods</a>
446
+ <li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
447
+ <li><a href="#methods">2. Methods</a>
447
448
  <ul class="sectlevel2">
448
- <li><a href="#setup-void">1.1. <code>setup(): void</code></a></li>
449
+ <li><a href="#setup-void">2.1. <code>setup(): void</code></a></li>
449
450
  </ul>
450
451
  </li>
451
- <li><a href="#general-usage">2. General Usage</a></li>
452
+ <li><a href="#general-usage">3. General Usage</a></li>
452
453
  </ul>
453
454
  </div>
454
455
  </div>
455
456
  <div id="content">
456
- <div id="preamble">
457
+ <div class="sect1">
458
+ <h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
457
459
  <div class="sectionbody">
458
460
  <div class="paragraph">
459
461
  <p>A fundamental contract for modules that require an assembly phase.</p>
@@ -461,10 +463,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
461
463
  </div>
462
464
  </div>
463
465
  <div class="sect1">
464
- <h2 id="methods"><a class="link" href="#methods">1. Methods</a></h2>
466
+ <h2 id="methods"><a class="link" href="#methods">2. Methods</a></h2>
465
467
  <div class="sectionbody">
466
468
  <div class="sect2">
467
- <h3 id="setup-void"><a class="link" href="#setup-void">1.1. <code>setup(): void</code></a></h3>
469
+ <h3 id="setup-void"><a class="link" href="#setup-void">2.1. <code>setup(): void</code></a></h3>
468
470
  <div class="paragraph">
469
471
  <p>Invoked once by the engine after all modules are constructed.</p>
470
472
  </div>
@@ -472,7 +474,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
472
474
  </div>
473
475
  </div>
474
476
  <div class="sect1">
475
- <h2 id="general-usage"><a class="link" href="#general-usage">2. General Usage</a></h2>
477
+ <h2 id="general-usage"><a class="link" href="#general-usage">3. General Usage</a></h2>
476
478
  <div class="sectionbody">
477
479
  <div class="paragraph">
478
480
  <p>Modules implementing <code>Initializable</code> use the <code>setup()</code> phase to establish internal buffers, bind event listeners, or perform calculations that depend on final configuration values.</p>
package/dist/docs/reference/interfaces/RendererInitializable.html CHANGED
@@ -443,17 +443,19 @@ 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="#methods">1. Methods</a>
446
+ <li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
447
+ <li><a href="#methods">2. Methods</a>
447
448
  <ul class="sectlevel2">
448
- <li><a href="#setuprenderermetrics-renderermetrics-void">1.1. <code>setup(rendererMetrics: RendererMetrics): void</code></a></li>
449
+ <li><a href="#setuprenderermetrics-renderermetrics-void">2.1. <code>setup(rendererMetrics: RendererMetrics): void</code></a></li>
449
450
  </ul>
450
451
  </li>
451
- <li><a href="#general-usage">2. General Usage</a></li>
452
+ <li><a href="#general-usage">3. General Usage</a></li>
452
453
  </ul>
453
454
  </div>
454
455
  </div>
455
456
  <div id="content">
456
- <div id="preamble">
457
+ <div class="sect1">
458
+ <h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
457
459
  <div class="sectionbody">
458
460
  <div class="paragraph">
459
461
  <p>Extension of <code><a href="Initializable.html">Initializable</a></code> specifically for rendering components.</p>
@@ -461,10 +463,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
461
463
  </div>
462
464
  </div>
463
465
  <div class="sect1">
464
- <h2 id="methods"><a class="link" href="#methods">1. Methods</a></h2>
466
+ <h2 id="methods"><a class="link" href="#methods">2. Methods</a></h2>
465
467
  <div class="sectionbody">
466
468
  <div class="sect2">
467
- <h3 id="setuprenderermetrics-renderermetrics-void"><a class="link" href="#setuprenderermetrics-renderermetrics-void">1.1. <code>setup(rendererMetrics: <a href="../types/RendererMetrics.html">RendererMetrics</a>): void</code></a></h3>
469
+ <h3 id="setuprenderermetrics-renderermetrics-void"><a class="link" href="#setuprenderermetrics-renderermetrics-void">2.1. <code>setup(rendererMetrics: <a href="../types/RendererMetrics.html">RendererMetrics</a>): void</code></a></h3>
468
470
  <div class="paragraph">
469
471
  <p>Invoked with live geometric metrics for the current session.</p>
470
472
  </div>
@@ -494,7 +496,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
494
496
  </div>
495
497
  </div>
496
498
  <div class="sect1">
497
- <h2 id="general-usage"><a class="link" href="#general-usage">2. General Usage</a></h2>
499
+ <h2 id="general-usage"><a class="link" href="#general-usage">3. General Usage</a></h2>
498
500
  <div class="sectionbody">
499
501
  <div class="paragraph">
500
502
  <p>Implemented by components like <code><a href="../modules/DisplayRenderer.html">DisplayRenderer</a></code> to receive pre-calculated X/Y origins and cell sizes before the first frame is drawn.</p>
package/dist/docs/reference/interfaces/StateContext.html CHANGED
@@ -443,13 +443,15 @@ 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="#methods">1. Methods</a></li>
447
- <li><a href="#general-usage">2. General Usage</a></li>
446
+ <li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
447
+ <li><a href="#methods">2. Methods</a></li>
448
+ <li><a href="#general-usage">3. General Usage</a></li>
448
449
  </ul>
449
450
  </div>
450
451
  </div>
451
452
  <div id="content">
452
- <div id="preamble">
453
+ <div class="sect1">
454
+ <h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
453
455
  <div class="sectionbody">
454
456
  <div class="paragraph">
455
457
  <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>
@@ -457,7 +459,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
457
459
  </div>
458
460
  </div>
459
461
  <div class="sect1">
460
- <h2 id="methods"><a class="link" href="#methods">1. Methods</a></h2>
462
+ <h2 id="methods"><a class="link" href="#methods">2. Methods</a></h2>
461
463
  <div class="sectionbody">
462
464
  <table class="tableblock frame-all grid-all stretch">
463
465
  <colgroup>
@@ -494,7 +496,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
494
496
  </div>
495
497
  </div>
496
498
  <div class="sect1">
497
- <h2 id="general-usage"><a class="link" href="#general-usage">2. General Usage</a></h2>
499
+ <h2 id="general-usage"><a class="link" href="#general-usage">3. General Usage</a></h2>
498
500
  <div class="sectionbody">
499
501
  <div class="paragraph">
500
502
  <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>
package/dist/docs/reference/interfaces/StateSyncable.html CHANGED
@@ -443,18 +443,20 @@ 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="#properties">1. Properties</a></li>
447
- <li><a href="#methods">2. Methods</a>
446
+ <li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
447
+ <li><a href="#properties">2. Properties</a></li>
448
+ <li><a href="#methods">3. Methods</a>
448
449
  <ul class="sectlevel2">
449
- <li><a href="#syncstatestate-state-void">2.1. <code>syncState(state: State): void</code></a></li>
450
+ <li><a href="#syncstatestate-state-void">3.1. <code>syncState(state: State): void</code></a></li>
450
451
  </ul>
451
452
  </li>
452
- <li><a href="#general-usage">3. General Usage</a></li>
453
+ <li><a href="#general-usage">4. General Usage</a></li>
453
454
  </ul>
454
455
  </div>
455
456
  </div>
456
457
  <div id="content">
457
- <div id="preamble">
458
+ <div class="sect1">
459
+ <h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
458
460
  <div class="sectionbody">
459
461
  <div class="paragraph">
460
462
  <p>Contract for modules that must react to global state changes.</p>
@@ -462,7 +464,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
462
464
  </div>
463
465
  </div>
464
466
  <div class="sect1">
465
- <h2 id="properties"><a class="link" href="#properties">1. Properties</a></h2>
467
+ <h2 id="properties"><a class="link" href="#properties">2. Properties</a></h2>
466
468
  <div class="sectionbody">
467
469
  <table class="tableblock frame-all grid-all stretch">
468
470
  <colgroup>
@@ -486,10 +488,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
486
488
  </div>
487
489
  </div>
488
490
  <div class="sect1">
489
- <h2 id="methods"><a class="link" href="#methods">2. Methods</a></h2>
491
+ <h2 id="methods"><a class="link" href="#methods">3. Methods</a></h2>
490
492
  <div class="sectionbody">
491
493
  <div class="sect2">
492
- <h3 id="syncstatestate-state-void"><a class="link" href="#syncstatestate-state-void">2.1. <code>syncState(state: <a href="modules/State.html">State</a>): void</code></a></h3>
494
+ <h3 id="syncstatestate-state-void"><a class="link" href="#syncstatestate-state-void">3.1. <code>syncState(state: <a href="modules/State.html">State</a>): void</code></a></h3>
493
495
  <div class="paragraph">
494
496
  <p>Links the module instance and allows it to subscribe to properties.</p>
495
497
  </div>
@@ -519,7 +521,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
519
521
  </div>
520
522
  </div>
521
523
  <div class="sect1">
522
- <h2 id="general-usage"><a class="link" href="#general-usage">3. General Usage</a></h2>
524
+ <h2 id="general-usage"><a class="link" href="#general-usage">4. General Usage</a></h2>
523
525
  <div class="sectionbody">
524
526
  <div class="paragraph">
525
527
  <p>Implemented by <code><a href="../modules/GameSound.html">GameSound</a></code> and <code><a href="../modules/GameScore.html">GameScore</a></code>. During the start-up sequence, the engine calls <code>syncState()</code> on these modules to ensure they have the latest references to <code>muted</code> flags and <code>highScore</code> data.</p>
package/dist/docs/reference/interfaces/modules/Control.html CHANGED
@@ -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="#methods">1. Methods</a>
446
+ <li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
447
+ <li><a href="#methods">2. Methods</a>
447
448
  <ul class="sectlevel2">
448
- <li><a href="#notifykey-controlkey-type-controleventtype-void">1.1. <code>notify(key: ControlKey, type: ControlEventType): void</code></a></li>
449
- <li><a href="#setmodulesmodules-gamemodules-void">1.2. <code>setModules(modules: GameModules): void</code></a></li>
450
- <li><a href="#subscribekey-controlkey-type-controleventtype-callback-controlcallback-void">1.3. <code>subscribe(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></li>
451
- <li><a href="#unsubscribekey-controlkey-type-controleventtype-callback-controlcallback-void">1.4. <code>unsubscribe(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></li>
452
- <li><a href="#unbindcontrols-void">1.5. <code>unbindControls(): void</code></a></li>
453
- <li><a href="#bindcontrols-void">1.6. <code>bindControls(): void</code></a></li>
449
+ <li><a href="#notifykey-controlkey-type-controleventtype-void">2.1. <code>notify(key: ControlKey, type: ControlEventType): void</code></a></li>
450
+ <li><a href="#setmodulesmodules-gamemodules-void">2.2. <code>setModules(modules: GameModules): void</code></a></li>
451
+ <li><a href="#subscribekey-controlkey-type-controleventtype-callback-controlcallback-void">2.3. <code>subscribe(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></li>
452
+ <li><a href="#unsubscribekey-controlkey-type-controleventtype-callback-controlcallback-void">2.4. <code>unsubscribe(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></li>
453
+ <li><a href="#unbindcontrols-void">2.5. <code>unbindControls(): void</code></a></li>
454
+ <li><a href="#bindcontrols-void">2.6. <code>bindControls(): void</code></a></li>
454
455
  </ul>
455
456
  </li>
456
- <li><a href="#general-usage">2. General Usage</a></li>
457
+ <li><a href="#general-usage">3. General Usage</a></li>
457
458
  </ul>
458
459
  </div>
459
460
  </div>
460
461
  <div id="content">
461
- <div id="preamble">
462
+ <div class="sect1">
463
+ <h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
462
464
  <div class="sectionbody">
463
465
  <div class="paragraph">
464
466
  <p>Interface for input handling and event-driven control distribution.</p>
@@ -466,10 +468,10 @@ 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="methods"><a class="link" href="#methods">1. Methods</a></h2>
471
+ <h2 id="methods"><a class="link" href="#methods">2. Methods</a></h2>
470
472
  <div class="sectionbody">
471
473
  <div class="sect2">
472
- <h3 id="notifykey-controlkey-type-controleventtype-void"><a class="link" href="#notifykey-controlkey-type-controleventtype-void">1.1. <code>notify(key: <a href="../../enums/ControlKey.html">ControlKey</a>, type: <a href="../../enums/ControlEventType.html">ControlEventType</a>): void</code></a></h3>
474
+ <h3 id="notifykey-controlkey-type-controleventtype-void"><a class="link" href="#notifykey-controlkey-type-controleventtype-void">2.1. <code>notify(key: <a href="../../enums/ControlKey.html">ControlKey</a>, type: <a href="../../enums/ControlEventType.html">ControlEventType</a>): void</code></a></h3>
473
475
  <div class="paragraph">
474
476
  <p>Triggers an event manually. Usually called by hardware drivers (like Keyboard listeners).</p>
475
477
  </div>
@@ -503,7 +505,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
503
505
  <hr>
504
506
  </div>
505
507
  <div class="sect2">
506
- <h3 id="setmodulesmodules-gamemodules-void"><a class="link" href="#setmodulesmodules-gamemodules-void">1.2. <code>setModules(modules: <a href="../GameModules.html">GameModules</a>): void</code></a></h3>
508
+ <h3 id="setmodulesmodules-gamemodules-void"><a class="link" href="#setmodulesmodules-gamemodules-void">2.2. <code>setModules(modules: <a href="../GameModules.html">GameModules</a>): void</code></a></h3>
507
509
  <div class="paragraph">
508
510
  <p>Provides the context registry required for <code><a href="../../types/GameEvent.html">GameEvent</a></code> construction.</p>
509
511
  </div>
@@ -532,7 +534,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
532
534
  <hr>
533
535
  </div>
534
536
  <div class="sect2">
535
- <h3 id="subscribekey-controlkey-type-controleventtype-callback-controlcallback-void"><a class="link" href="#subscribekey-controlkey-type-controleventtype-callback-controlcallback-void">1.3. <code>subscribe(key: <a href="../../enums/ControlKey.html">ControlKey</a>, type: <a href="../../enums/ControlEventType.html">ControlEventType</a>, callback: <a href="../../types/ControlCallback.html">ControlCallback</a>): void</code></a></h3>
537
+ <h3 id="subscribekey-controlkey-type-controleventtype-callback-controlcallback-void"><a class="link" href="#subscribekey-controlkey-type-controleventtype-callback-controlcallback-void">2.3. <code>subscribe(key: <a href="../../enums/ControlKey.html">ControlKey</a>, type: <a href="../../enums/ControlEventType.html">ControlEventType</a>, callback: <a href="../../types/ControlCallback.html">ControlCallback</a>): void</code></a></h3>
536
538
  <div class="paragraph">
537
539
  <p>Registers a function to be executed when the specified input occurs.</p>
538
540
  </div>
@@ -571,7 +573,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
571
573
  <hr>
572
574
  </div>
573
575
  <div class="sect2">
574
- <h3 id="unsubscribekey-controlkey-type-controleventtype-callback-controlcallback-void"><a class="link" href="#unsubscribekey-controlkey-type-controleventtype-callback-controlcallback-void">1.4. <code>unsubscribe(key: <a href="../../enums/ControlKey.html">ControlKey</a>, type: <a href="../../enums/ControlEventType.html">ControlEventType</a>, callback: <a href="../../types/ControlCallback.html">ControlCallback</a>): void</code></a></h3>
576
+ <h3 id="unsubscribekey-controlkey-type-controleventtype-callback-controlcallback-void"><a class="link" href="#unsubscribekey-controlkey-type-controleventtype-callback-controlcallback-void">2.4. <code>unsubscribe(key: <a href="../../enums/ControlKey.html">ControlKey</a>, type: <a href="../../enums/ControlEventType.html">ControlEventType</a>, callback: <a href="../../types/ControlCallback.html">ControlCallback</a>): void</code></a></h3>
575
577
  <div class="paragraph">
576
578
  <p>Detaches a previously registered input listener.</p>
577
579
  </div>
@@ -610,14 +612,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
610
612
  <hr>
611
613
  </div>
612
614
  <div class="sect2">
613
- <h3 id="unbindcontrols-void"><a class="link" href="#unbindcontrols-void">1.5. <code>unbindControls(): void</code></a></h3>
615
+ <h3 id="unbindcontrols-void"><a class="link" href="#unbindcontrols-void">2.5. <code>unbindControls(): void</code></a></h3>
614
616
  <div class="paragraph">
615
617
  <p>Temporarily disables all input listeners.</p>
616
618
  </div>
617
619
  <hr>
618
620
  </div>
619
621
  <div class="sect2">
620
- <h3 id="bindcontrols-void"><a class="link" href="#bindcontrols-void">1.6. <code>bindControls(): void</code></a></h3>
622
+ <h3 id="bindcontrols-void"><a class="link" href="#bindcontrols-void">2.6. <code>bindControls(): void</code></a></h3>
621
623
  <div class="paragraph">
622
624
  <p>Re-enables input listeners.</p>
623
625
  </div>
@@ -625,7 +627,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
625
627
  </div>
626
628
  </div>
627
629
  <div class="sect1">
628
- <h2 id="general-usage"><a class="link" href="#general-usage">2. General Usage</a></h2>
630
+ <h2 id="general-usage"><a class="link" href="#general-usage">3. General Usage</a></h2>
629
631
  <div class="sectionbody">
630
632
  <div class="paragraph">
631
633
  <p>Implemented by <code><a href="../../modules/GameControl.html">GameControl</a></code>. Games use this to react to player movements (<code><a href="../../enums/ControlKey.html">LEFT</a></code>, <code><a href="../../enums/ControlKey.html">RIGHT</a></code>) or actions (<code><a href="../../enums/ControlKey.html">ACTION</a></code>).</p>