brick-engine-js 1.0.26 → 1.0.28

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 (67) hide show
  1. package/dist/css/game.bundle.css +5 -0
  2. package/dist/docs/GAME_DEVELOPER_GUIDE.html +2271 -662
  3. package/dist/docs/brick-engine-guide.html +2238 -609
  4. package/dist/docs/documentation_style_guide.html +2698 -973
  5. package/dist/docs/getting-started.html +2192 -574
  6. package/dist/docs/index.html +2278 -608
  7. package/dist/docs/jsdoc_standard.html +2235 -617
  8. package/dist/docs/publishing.html +2196 -572
  9. package/dist/docs/reference/bootstrap.html +2172 -555
  10. package/dist/docs/reference/context/RendererContext.html +2220 -582
  11. package/dist/docs/reference/enums/Color.html +2152 -538
  12. package/dist/docs/reference/enums/ControlEventType.html +2108 -506
  13. package/dist/docs/reference/enums/ControlKey.html +2144 -530
  14. package/dist/docs/reference/enums/EventSuffix.html +2121 -514
  15. package/dist/docs/reference/enums/FontAlignment.html +2157 -546
  16. package/dist/docs/reference/enums/FontSize.html +2122 -518
  17. package/dist/docs/reference/enums/Sound.html +2210 -559
  18. package/dist/docs/reference/enums/StateProperty.html +2131 -526
  19. package/dist/docs/reference/helpers/CellHelper.html +2135 -523
  20. package/dist/docs/reference/helpers/ControlInputHandlerHelper.html +2204 -572
  21. package/dist/docs/reference/helpers/CoordinateHelper.html +2377 -681
  22. package/dist/docs/reference/helpers/RelativeValuesHelper.html +2165 -553
  23. package/dist/docs/reference/interfaces/Debuggable.html +2103 -502
  24. package/dist/docs/reference/interfaces/GameModules.html +2203 -550
  25. package/dist/docs/reference/interfaces/Initializable.html +2093 -496
  26. package/dist/docs/reference/interfaces/RendererInitializable.html +2125 -518
  27. package/dist/docs/reference/interfaces/StateContext.html +2133 -518
  28. package/dist/docs/reference/interfaces/StateSyncable.html +2154 -543
  29. package/dist/docs/reference/interfaces/modules/Control.html +2353 -649
  30. package/dist/docs/reference/interfaces/modules/Grid.html +3202 -1277
  31. package/dist/docs/reference/interfaces/modules/Renderer.html +2140 -523
  32. package/dist/docs/reference/interfaces/modules/RendererComposite.html +2209 -578
  33. package/dist/docs/reference/interfaces/modules/Score.html +2326 -670
  34. package/dist/docs/reference/interfaces/modules/Session.html +2333 -660
  35. package/dist/docs/reference/interfaces/modules/State.html +2651 -898
  36. package/dist/docs/reference/interfaces/modules/Text.html +2362 -669
  37. package/dist/docs/reference/interfaces/modules/Time.html +2418 -739
  38. package/dist/docs/reference/modules/Debugger.html +2206 -578
  39. package/dist/docs/reference/modules/DisplayRenderer.html +2186 -558
  40. package/dist/docs/reference/modules/EventEmitter.html +2321 -631
  41. package/dist/docs/reference/modules/Game.html +2544 -808
  42. package/dist/docs/reference/modules/GameControl.html +2745 -879
  43. package/dist/docs/reference/modules/GameEventRegistry.html +2226 -587
  44. package/dist/docs/reference/modules/GameGrid.html +4236 -1967
  45. package/dist/docs/reference/modules/GameHudGrid.html +2103 -503
  46. package/dist/docs/reference/modules/GameRenderer.html +2247 -590
  47. package/dist/docs/reference/modules/GameScore.html +2383 -695
  48. package/dist/docs/reference/modules/GameSession.html +2232 -580
  49. package/dist/docs/reference/modules/GameSound.html +2300 -637
  50. package/dist/docs/reference/modules/GameState.html +2846 -1032
  51. package/dist/docs/reference/modules/GameText.html +2427 -702
  52. package/dist/docs/reference/modules/GameTime.html +2460 -763
  53. package/dist/docs/reference/modules/HudRenderer.html +2205 -569
  54. package/dist/docs/reference/modules/InitialStateSnapshot.html +2185 -561
  55. package/dist/docs/reference/modules/SessionModal.html +2145 -521
  56. package/dist/docs/reference/types/Axis.html +2102 -506
  57. package/dist/docs/reference/types/Cell.html +2124 -515
  58. package/dist/docs/reference/types/ControlCallback.html +2084 -489
  59. package/dist/docs/reference/types/Coordinate.html +2110 -511
  60. package/dist/docs/reference/types/GameEvent.html +2123 -515
  61. package/dist/docs/reference/types/RendererMetrics.html +2133 -515
  62. package/dist/docs/reference/types/Vector.html +2111 -510
  63. package/dist/docs/reference/view/GameView.html +2282 -613
  64. package/dist/docs/testing_best_practices.html +2338 -699
  65. package/dist/game.bundle.js +1 -1
  66. package/dist/types/view/components/layout/FrameLayout.d.ts +1 -1
  67. package/package.json +1 -1
package/dist/docs/reference/modules/GameControl.html CHANGED
@@ -1,882 +1,2748 @@
1
- <!DOCTYPE html>
1
+ <!doctype html>
2
2
  <html lang="en">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
7
- <meta name="generator" content="Asciidoctor 2.0.20">
8
- <meta name="description" content="Handles user input from physical keyboards and virtual buttons.">
9
- <meta name="keywords" content="input, control, keyboard, interaction">
10
- <title>GameControl Module Reference</title>
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
- <style>
13
- /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
14
- /* Uncomment the following line when using as a custom stylesheet */
15
- /* @import "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"; */
16
- html{font-family:sans-serif;-webkit-text-size-adjust:100%}
17
- a{background:none}
18
- a:focus{outline:thin dotted}
19
- a:active,a:hover{outline:0}
20
- h1{font-size:2em;margin:.67em 0}
21
- b,strong{font-weight:bold}
22
- abbr{font-size:.9em}
23
- abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
24
- dfn{font-style:italic}
25
- hr{height:0}
26
- mark{background:#ff0;color:#000}
27
- code,kbd,pre,samp{font-family:monospace;font-size:1em}
28
- pre{white-space:pre-wrap}
29
- q{quotes:"\201C" "\201D" "\2018" "\2019"}
30
- small{font-size:80%}
31
- sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
32
- sup{top:-.5em}
33
- sub{bottom:-.25em}
34
- img{border:0}
35
- svg:not(:root){overflow:hidden}
36
- figure{margin:0}
37
- audio,video{display:inline-block}
38
- audio:not([controls]){display:none;height:0}
39
- fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
40
- legend{border:0;padding:0}
41
- button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
42
- button,input{line-height:normal}
43
- button,select{text-transform:none}
44
- button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
45
- button[disabled],html input[disabled]{cursor:default}
46
- input[type=checkbox],input[type=radio]{padding:0}
47
- button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
48
- textarea{overflow:auto;vertical-align:top}
49
- table{border-collapse:collapse;border-spacing:0}
50
- *,::before,::after{box-sizing:border-box}
51
- html,body{font-size:100%}
52
- body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
53
- a:hover{cursor:pointer}
54
- img,object,embed{max-width:100%;height:auto}
55
- object,embed{height:100%}
56
- img{-ms-interpolation-mode:bicubic}
57
- .left{float:left!important}
58
- .right{float:right!important}
59
- .text-left{text-align:left!important}
60
- .text-right{text-align:right!important}
61
- .text-center{text-align:center!important}
62
- .text-justify{text-align:justify!important}
63
- .hide{display:none}
64
- img,object,svg{display:inline-block;vertical-align:middle}
65
- textarea{height:auto;min-height:50px}
66
- select{width:100%}
67
- .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
68
- div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
69
- a{color:#2156a5;text-decoration:underline;line-height:inherit}
70
- a:hover,a:focus{color:#1d4b8f}
71
- a img{border:0}
72
- p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
73
- p aside{font-size:.875em;line-height:1.35;font-style:italic}
74
- h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
75
- h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
76
- h1{font-size:2.125em}
77
- h2{font-size:1.6875em}
78
- h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
79
- h4,h5{font-size:1.125em}
80
- h6{font-size:1em}
81
- hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
82
- em,i{font-style:italic;line-height:inherit}
83
- strong,b{font-weight:bold;line-height:inherit}
84
- small{font-size:60%;line-height:inherit}
85
- code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
86
- ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
87
- ul,ol{margin-left:1.5em}
88
- ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
89
- ul.circle{list-style-type:circle}
90
- ul.disc{list-style-type:disc}
91
- ul.square{list-style-type:square}
92
- ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
93
- ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
94
- dl dt{margin-bottom:.3125em;font-weight:bold}
95
- dl dd{margin-bottom:1.25em}
96
- blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
97
- blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
98
- @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
99
- h1{font-size:2.75em}
100
- h2{font-size:2.3125em}
101
- h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
102
- h4{font-size:1.4375em}}
103
- table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
104
- table thead,table tfoot{background:#f7f8f7}
105
- table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
106
- table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
107
- table tr.even,table tr.alt{background:#f8f8f7}
108
- table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
109
- h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
110
- h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
111
- .center{margin-left:auto;margin-right:auto}
112
- .stretch{width:100%}
113
- .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
114
- .clearfix::after,.float-group::after{clear:both}
115
- :not(pre).nobreak{word-wrap:normal}
116
- :not(pre).nowrap{white-space:nowrap}
117
- :not(pre).pre-wrap{white-space:pre-wrap}
118
- :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
119
- pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
120
- pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
121
- pre>code{display:block}
122
- pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
123
- em em{font-style:normal}
124
- strong strong{font-weight:400}
125
- .keyseq{color:rgba(51,51,51,.8)}
126
- kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
127
- .keyseq kbd:first-child{margin-left:0}
128
- .keyseq kbd:last-child{margin-right:0}
129
- .menuseq,.menuref{color:#000}
130
- .menuseq b:not(.caret),.menuref{font-weight:inherit}
131
- .menuseq{word-spacing:-.02em}
132
- .menuseq b.caret{font-size:1.25em;line-height:.8}
133
- .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
134
- b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
135
- b.button::before{content:"[";padding:0 3px 0 2px}
136
- b.button::after{content:"]";padding:0 2px 0 3px}
137
- p a>code:hover{color:rgba(0,0,0,.9)}
138
- #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
139
- #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
140
- #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
141
- #content{margin-top:1.25em}
142
- #content::before{content:none}
143
- #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
144
- #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
145
- #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
146
- #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
147
- #header .details span:first-child{margin-left:-.125em}
148
- #header .details span.email a{color:rgba(0,0,0,.85)}
149
- #header .details br{display:none}
150
- #header .details br+span::before{content:"\00a0\2013\00a0"}
151
- #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
152
- #header .details br+span#revremark::before{content:"\00a0|\00a0"}
153
- #header #revnumber{text-transform:capitalize}
154
- #header #revnumber::after{content:"\00a0"}
155
- #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
156
- #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
157
- #toc>ul{margin-left:.125em}
158
- #toc ul.sectlevel0>li>a{font-style:italic}
159
- #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
160
- #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
161
- #toc li{line-height:1.3334;margin-top:.3334em}
162
- #toc a{text-decoration:none}
163
- #toc a:active{text-decoration:underline}
164
- #toctitle{color:#7a2518;font-size:1.2em}
165
- @media screen and (min-width:768px){#toctitle{font-size:1.375em}
166
- body.toc2{padding-left:15em;padding-right:0}
167
- #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
168
- #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
169
- #toc.toc2>ul{font-size:.9em;margin-bottom:0}
170
- #toc.toc2 ul ul{margin-left:0;padding-left:1em}
171
- #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
172
- body.toc2.toc-right{padding-left:0;padding-right:15em}
173
- body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
174
- @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
175
- #toc.toc2{width:20em}
176
- #toc.toc2 #toctitle{font-size:1.375em}
177
- #toc.toc2>ul{font-size:.95em}
178
- #toc.toc2 ul ul{padding-left:1.25em}
179
- body.toc2.toc-right{padding-left:0;padding-right:20em}}
180
- #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
181
- #content #toc>:first-child{margin-top:0}
182
- #content #toc>:last-child{margin-bottom:0}
183
- #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
184
- #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
185
- #content{margin-bottom:.625em}
186
- .sect1{padding-bottom:.625em}
187
- @media screen and (min-width:768px){#content{margin-bottom:1.25em}
188
- .sect1{padding-bottom:1.25em}}
189
- .sect1:last-child{padding-bottom:0}
190
- .sect1+.sect1{border-top:1px solid #e7e7e9}
191
- #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
192
- #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
193
- #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
194
- #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
195
- #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
196
- details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
197
- details{margin-left:1.25rem}
198
- details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
199
- details>summary::-webkit-details-marker{display:none}
200
- details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
201
- details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
202
- details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
203
- .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
204
- table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
205
- .paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
206
- .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
207
- .admonitionblock>table td.icon{text-align:center;width:80px}
208
- .admonitionblock>table td.icon img{max-width:none}
209
- .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
210
- .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
211
- .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
212
- .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
213
- .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
214
- .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
215
- .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
216
- .exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
217
- .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
218
- @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
219
- @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
220
- .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
221
- .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
222
- .listingblock>.content{position:relative}
223
- .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
224
- .listingblock:hover code[data-lang]::before{display:block}
225
- .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
226
- .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
227
- .listingblock pre.highlightjs{padding:0}
228
- .listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
229
- .listingblock pre.prettyprint{border-width:0}
230
- .prettyprint{background:#f7f7f8}
231
- pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
232
- pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
233
- pre.prettyprint li code[data-lang]::before{opacity:1}
234
- pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
235
- table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
236
- table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
237
- table.linenotable td.code{padding-left:.75em}
238
- table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
239
- pre.pygments span.linenos{display:inline-block;margin-right:.75em}
240
- .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
241
- .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
242
- .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
243
- .quoteblock blockquote{margin:0;padding:0;border:0}
244
- .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
245
- .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
246
- .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
247
- .verseblock{margin:0 1em 1.25em}
248
- .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
249
- .verseblock pre strong{font-weight:400}
250
- .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
251
- .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
252
- .quoteblock .attribution br,.verseblock .attribution br{display:none}
253
- .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
254
- .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
255
- .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
256
- .quoteblock.abstract{margin:0 1em 1.25em;display:block}
257
- .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
258
- .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
259
- .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
260
- .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
261
- .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
262
- p.tableblock:last-child{margin-bottom:0}
263
- td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
264
- td.tableblock>.content>:last-child{margin-bottom:-1.25em}
265
- table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
266
- table.grid-all>*>tr>*{border-width:1px}
267
- table.grid-cols>*>tr>*{border-width:0 1px}
268
- table.grid-rows>*>tr>*{border-width:1px 0}
269
- table.frame-all{border-width:1px}
270
- table.frame-ends{border-width:1px 0}
271
- table.frame-sides{border-width:0 1px}
272
- table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
273
- table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
274
- table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
275
- table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
276
- table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
277
- th.halign-left,td.halign-left{text-align:left}
278
- th.halign-right,td.halign-right{text-align:right}
279
- th.halign-center,td.halign-center{text-align:center}
280
- th.valign-top,td.valign-top{vertical-align:top}
281
- th.valign-bottom,td.valign-bottom{vertical-align:bottom}
282
- th.valign-middle,td.valign-middle{vertical-align:middle}
283
- table thead th,table tfoot th{font-weight:bold}
284
- tbody tr th{background:#f7f8f7}
285
- tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
286
- p.tableblock>code:only-child{background:none;padding:0}
287
- p.tableblock{font-size:1em}
288
- ol{margin-left:1.75em}
289
- ul li ol{margin-left:1.5em}
290
- dl dd{margin-left:1.125em}
291
- dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
292
- li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
293
- ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
294
- ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
295
- ul.unstyled,ol.unstyled{margin-left:0}
296
- li>p:empty:only-child::before{content:"";display:inline-block}
297
- ul.checklist>li>p:first-child{margin-left:-1em}
298
- ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
299
- ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
300
- ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
301
- ul.inline>li{margin-left:1.25em}
302
- .unstyled dl dt{font-weight:400;font-style:normal}
303
- ol.arabic{list-style-type:decimal}
304
- ol.decimal{list-style-type:decimal-leading-zero}
305
- ol.loweralpha{list-style-type:lower-alpha}
306
- ol.upperalpha{list-style-type:upper-alpha}
307
- ol.lowerroman{list-style-type:lower-roman}
308
- ol.upperroman{list-style-type:upper-roman}
309
- ol.lowergreek{list-style-type:lower-greek}
310
- .hdlist>table,.colist>table{border:0;background:none}
311
- .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
312
- td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
313
- td.hdlist1{font-weight:bold;padding-bottom:1.25em}
314
- td.hdlist2{word-wrap:anywhere}
315
- .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
316
- .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
317
- .colist td:not([class]):first-child img{max-width:none}
318
- .colist td:not([class]):last-child{padding:.25em 0}
319
- .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
320
- .imageblock.left{margin:.25em .625em 1.25em 0}
321
- .imageblock.right{margin:.25em 0 1.25em .625em}
322
- .imageblock>.title{margin-bottom:0}
323
- .imageblock.thumb,.imageblock.th{border-width:6px}
324
- .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
325
- .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
326
- .image.left{margin-right:.625em}
327
- .image.right{margin-left:.625em}
328
- a.image{text-decoration:none;display:inline-block}
329
- a.image object{pointer-events:none}
330
- sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
331
- sup.footnote a,sup.footnoteref a{text-decoration:none}
332
- sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
333
- #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
334
- #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
335
- #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
336
- #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
337
- #footnotes .footnote:last-of-type{margin-bottom:0}
338
- #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
339
- div.unbreakable{page-break-inside:avoid}
340
- .big{font-size:larger}
341
- .small{font-size:smaller}
342
- .underline{text-decoration:underline}
343
- .overline{text-decoration:overline}
344
- .line-through{text-decoration:line-through}
345
- .aqua{color:#00bfbf}
346
- .aqua-background{background:#00fafa}
347
- .black{color:#000}
348
- .black-background{background:#000}
349
- .blue{color:#0000bf}
350
- .blue-background{background:#0000fa}
351
- .fuchsia{color:#bf00bf}
352
- .fuchsia-background{background:#fa00fa}
353
- .gray{color:#606060}
354
- .gray-background{background:#7d7d7d}
355
- .green{color:#006000}
356
- .green-background{background:#007d00}
357
- .lime{color:#00bf00}
358
- .lime-background{background:#00fa00}
359
- .maroon{color:#600000}
360
- .maroon-background{background:#7d0000}
361
- .navy{color:#000060}
362
- .navy-background{background:#00007d}
363
- .olive{color:#606000}
364
- .olive-background{background:#7d7d00}
365
- .purple{color:#600060}
366
- .purple-background{background:#7d007d}
367
- .red{color:#bf0000}
368
- .red-background{background:#fa0000}
369
- .silver{color:#909090}
370
- .silver-background{background:#bcbcbc}
371
- .teal{color:#006060}
372
- .teal-background{background:#007d7d}
373
- .white{color:#bfbfbf}
374
- .white-background{background:#fafafa}
375
- .yellow{color:#bfbf00}
376
- .yellow-background{background:#fafa00}
377
- span.icon>.fa{cursor:default}
378
- a span.icon>.fa{cursor:inherit}
379
- .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
380
- .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
381
- .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
382
- .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
383
- .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
384
- .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
385
- .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
386
- .conum[data-value] *{color:#fff!important}
387
- .conum[data-value]+b{display:none}
388
- .conum[data-value]::after{content:attr(data-value)}
389
- pre .conum[data-value]{position:relative;top:-.125em}
390
- b.conum *{color:inherit!important}
391
- .conum:not([data-value]):empty{display:none}
392
- dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
393
- h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
394
- p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
395
- p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
396
- p{margin-bottom:1.25rem}
397
- .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
398
- .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
399
- .print-only{display:none!important}
400
- @page{margin:1.25cm .75cm}
401
- @media print{*{box-shadow:none!important;text-shadow:none!important}
402
- html{font-size:80%}
403
- a{color:inherit!important;text-decoration:underline!important}
404
- a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
405
- a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
406
- abbr[title]{border-bottom:1px dotted}
407
- abbr[title]::after{content:" (" attr(title) ")"}
408
- pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
409
- thead{display:table-header-group}
410
- svg{max-width:100%}
411
- p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
412
- h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
413
- #header,#content,#footnotes,#footer{max-width:none}
414
- #toc,.sidebarblock,.exampleblock>.content{background:none!important}
415
- #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
416
- body.book #header{text-align:center}
417
- body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
418
- body.book #header .details{border:0!important;display:block;padding:0!important}
419
- body.book #header .details span:first-child{margin-left:0!important}
420
- body.book #header .details br{display:block}
421
- body.book #header .details br+span::before{content:none!important}
422
- body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
423
- body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
424
- .listingblock code[data-lang]::before{display:block}
425
- #footer{padding:0 .9375em}
426
- .hide-on-print{display:none!important}
427
- .print-only{display:block!important}
428
- .hide-for-print{display:none!important}
429
- .show-for-print{display:inherit!important}}
430
- @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
431
- .sect1{padding:0!important}
432
- .sect1+.sect1{border:0}
433
- #footer{background:none}
434
- #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
435
- @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
436
- </style>
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">
439
- </head>
440
- <body class="article toc2 toc-left">
441
- <div id="header">
442
- <h1>GameControl Module Reference</h1>
443
- <div id="toc" class="toc2">
444
- <div id="toctitle">Table of Contents</div>
445
- <ul class="sectlevel1">
446
- <li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
447
- <li><a href="#supported-keys-controlkey">2. Supported Keys (<code>ControlKey</code>)</a></li>
448
- <li><a href="#api-reference">3. API Reference</a>
449
- <ul class="sectlevel2">
450
- <li><a href="#subscribekey-controlkey-type-controleventtype-callback-controlcallback-void">3.1. <code>subscribe(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></li>
451
- <li><a href="#unsubscribekey-controlkey-type-controleventtype-callback-controlcallback-void">3.2. <code>unsubscribe(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></li>
452
- <li><a href="#subscribefortitlescreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.3. <code>subscribeForTitleScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></li>
453
- <li><a href="#unsubscribefortitlescreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.4. <code>unsubscribeForTitleScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></li>
454
- <li><a href="#subscribeforgameoverscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.5. <code>subscribeForGameOverScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></li>
455
- <li><a href="#unsubscribeforgameoverscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.6. <code>unsubscribeForGameOverScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></li>
456
- <li><a href="#subscribeforplayingscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.7. <code>subscribeForPlayingScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></li>
457
- <li><a href="#unsubscribeforplayingscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.8. <code>unsubscribeForPlayingScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></li>
458
- <li><a href="#subscribeforpausedscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.9. <code>subscribeForPausedScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></li>
459
- <li><a href="#unsubscribeforpausedscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.10. <code>unsubscribeForPausedScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></li>
460
- <li><a href="#bindcontrols-void">3.11. <code>bindControls(): void</code></a></li>
461
- <li><a href="#unbindcontrols-void">3.12. <code>unbindControls(): void</code></a></li>
462
- <li><a href="#notifykey-controlkey-type-controleventtype-void">3.13. <code>notify(key: ControlKey, type: ControlEventType): void</code></a></li>
463
- <li><a href="#getdebugdata-recordstring-string-number-boolean">3.14. <code>getDebugData(): Record&lt;string, string | number | boolean&gt;</code></a></li>
464
- </ul>
465
- </li>
466
- </ul>
467
- </div>
468
- </div>
469
- <div id="content">
470
- <div class="sect1">
471
- <h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
472
- <div class="sectionbody">
473
- <div class="paragraph">
474
- <p>The <code>GameControl</code> module functions as the central event bus translating physical browser and hardware DOM inputs into abstract game behaviors. It encapsulates raw environment listeners so distinct module parts can effortlessly subscribe to simplified <code><a href="../enums/ControlKey.html">ControlKey</a></code> hooks. Vitally, it centrally gates input propagation depending intelligently on the global engine <code><a href="GameState.html">GameState</a></code> (e.g. blocking game keys while in modals).</p>
475
- </div>
476
- </div>
477
- </div>
478
- <div class="sect1">
479
- <h2 id="supported-keys-controlkey"><a class="link" href="#supported-keys-controlkey">2. Supported Keys (<code>ControlKey</code>)</a></h2>
480
- <div class="sectionbody">
481
- <div class="paragraph">
482
- <p>The engine maps physical keys to virtual engine keys:</p>
483
- </div>
484
- <div class="ulist">
485
- <ul>
486
- <li>
487
- <p><code><a href="../enums/ControlKey.html">UP</a></code> / <code><a href="../enums/ControlKey.html">DOWN</a></code> / <code><a href="../enums/ControlKey.html">LEFT</a></code> / <code><a href="../enums/ControlKey.html">RIGHT</a></code>: Directional controls.</p>
488
- </li>
489
- <li>
490
- <p><code><a href="../enums/ControlKey.html">ACTION</a></code>: Primary action button.</p>
491
- </li>
492
- <li>
493
- <p><code><a href="../enums/ControlKey.html">START_PAUSE</a></code>: Toggles game start/pause.</p>
494
- </li>
495
- <li>
496
- <p><code><a href="../enums/ControlKey.html">RESET</a></code>: Soft reset of the game session.</p>
497
- </li>
498
- <li>
499
- <p><code><a href="../enums/ControlKey.html">SOUND</a></code>: Toggles master audio mute.</p>
500
- </li>
501
- <li>
502
- <p><code><a href="../enums/ControlKey.html">COLOR</a></code>: Toggles theme color mode.</p>
503
- </li>
504
- <li>
505
- <p><code><a href="../enums/ControlKey.html">POWER</a></code>: Main engine power toggle.</p>
506
- </li>
507
- <li>
508
- <p><code><a href="../enums/ControlKey.html">EXIT</a></code>: Hard stop of the engine.</p>
509
- </li>
510
- </ul>
511
- </div>
512
- <hr>
513
- </div>
514
- </div>
515
- <div class="sect1">
516
- <h2 id="api-reference"><a class="link" href="#api-reference">3. API Reference</a></h2>
517
- <div class="sectionbody">
518
- <div class="sect2">
519
- <h3 id="subscribekey-controlkey-type-controleventtype-callback-controlcallback-void"><a class="link" href="#subscribekey-controlkey-type-controleventtype-callback-controlcallback-void">3.1. <code>subscribe(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></h3>
520
- <div class="paragraph">
521
- <p>Registers a callback for a specific input event.</p>
522
- </div>
523
- <div class="paragraph">
524
- <p><strong>Parameters</strong></p>
525
- </div>
526
- <table class="tableblock frame-all grid-all stretch">
527
- <colgroup>
528
- <col style="width: 20%;">
529
- <col style="width: 20%;">
530
- <col style="width: 60%;">
531
- </colgroup>
532
- <tbody>
533
- <tr>
534
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
535
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
536
- <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
537
- </tr>
538
- <tr>
539
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>key</code></p></td>
540
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/ControlKey.html">ControlKey</a></code></p></td>
541
- <td class="tableblock halign-left valign-top"><p class="tableblock">The explicit abstract virtual key string mapping to monitor cleanly (e.g., <code>ControlKey.ACTION</code>).</p></td>
542
- </tr>
543
- <tr>
544
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>type</code></p></td>
545
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/ControlEventType.html">ControlEventType</a></code></p></td>
546
- <td class="tableblock halign-left valign-top"><p class="tableblock">The lifecycle trigger distinction (<code>PRESSED</code> or <code>HELD</code>).</p></td>
547
- </tr>
548
- <tr>
549
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>callback</code></p></td>
550
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../types/ControlCallback.html">ControlCallback</a></code></p></td>
551
- <td class="tableblock halign-left valign-top"><p class="tableblock">The injected execution sequence called securely when the payload completes.</p></td>
552
- </tr>
553
- </tbody>
554
- </table>
555
- <div class="paragraph">
556
- <p><strong>Behavior</strong></p>
557
- </div>
558
- <div class="paragraph">
559
- <p>Adds the callback to the internal subscription list. Multiple callbacks can be registered for the same key/type combination.</p>
560
- </div>
561
- <div class="paragraph">
562
- <p><strong>Example</strong></p>
563
- </div>
564
- <div class="listingblock">
565
- <div class="content">
566
- <pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">control.subscribe(ControlKey.ACTION, ControlEventType.PRESSED, (event) =&gt; {
3
+ <head>
4
+ <meta charset="UTF-8" />
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge" />
6
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
7
+ <meta name="generator" content="Asciidoctor 2.0.20" />
8
+ <meta name="description" content="Handles user input from physical keyboards and virtual buttons." />
9
+ <meta name="keywords" content="input, control, keyboard, interaction" />
10
+ <title>GameControl Module Reference</title>
11
+ <link
12
+ rel="stylesheet"
13
+ 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"
14
+ />
15
+ <style>
16
+ /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
17
+ /* Uncomment the following line when using as a custom stylesheet */
18
+ /* @import "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"; */
19
+ html {
20
+ font-family: sans-serif;
21
+ -webkit-text-size-adjust: 100%;
22
+ }
23
+ a {
24
+ background: none;
25
+ }
26
+ a:focus {
27
+ outline: thin dotted;
28
+ }
29
+ a:active,
30
+ a:hover {
31
+ outline: 0;
32
+ }
33
+ h1 {
34
+ font-size: 2em;
35
+ margin: 0.67em 0;
36
+ }
37
+ b,
38
+ strong {
39
+ font-weight: bold;
40
+ }
41
+ abbr {
42
+ font-size: 0.9em;
43
+ }
44
+ abbr[title] {
45
+ cursor: help;
46
+ border-bottom: 1px dotted #dddddf;
47
+ text-decoration: none;
48
+ }
49
+ dfn {
50
+ font-style: italic;
51
+ }
52
+ hr {
53
+ height: 0;
54
+ }
55
+ mark {
56
+ background: #ff0;
57
+ color: #000;
58
+ }
59
+ code,
60
+ kbd,
61
+ pre,
62
+ samp {
63
+ font-family: monospace;
64
+ font-size: 1em;
65
+ }
66
+ pre {
67
+ white-space: pre-wrap;
68
+ }
69
+ q {
70
+ quotes: '\201C' '\201D' '\2018' '\2019';
71
+ }
72
+ small {
73
+ font-size: 80%;
74
+ }
75
+ sub,
76
+ sup {
77
+ font-size: 75%;
78
+ line-height: 0;
79
+ position: relative;
80
+ vertical-align: baseline;
81
+ }
82
+ sup {
83
+ top: -0.5em;
84
+ }
85
+ sub {
86
+ bottom: -0.25em;
87
+ }
88
+ img {
89
+ border: 0;
90
+ }
91
+ svg:not(:root) {
92
+ overflow: hidden;
93
+ }
94
+ figure {
95
+ margin: 0;
96
+ }
97
+ audio,
98
+ video {
99
+ display: inline-block;
100
+ }
101
+ audio:not([controls]) {
102
+ display: none;
103
+ height: 0;
104
+ }
105
+ fieldset {
106
+ border: 1px solid silver;
107
+ margin: 0 2px;
108
+ padding: 0.35em 0.625em 0.75em;
109
+ }
110
+ legend {
111
+ border: 0;
112
+ padding: 0;
113
+ }
114
+ button,
115
+ input,
116
+ select,
117
+ textarea {
118
+ font-family: inherit;
119
+ font-size: 100%;
120
+ margin: 0;
121
+ }
122
+ button,
123
+ input {
124
+ line-height: normal;
125
+ }
126
+ button,
127
+ select {
128
+ text-transform: none;
129
+ }
130
+ button,
131
+ html input[type='button'],
132
+ input[type='reset'],
133
+ input[type='submit'] {
134
+ -webkit-appearance: button;
135
+ cursor: pointer;
136
+ }
137
+ button[disabled],
138
+ html input[disabled] {
139
+ cursor: default;
140
+ }
141
+ input[type='checkbox'],
142
+ input[type='radio'] {
143
+ padding: 0;
144
+ }
145
+ button::-moz-focus-inner,
146
+ input::-moz-focus-inner {
147
+ border: 0;
148
+ padding: 0;
149
+ }
150
+ textarea {
151
+ overflow: auto;
152
+ vertical-align: top;
153
+ }
154
+ table {
155
+ border-collapse: collapse;
156
+ border-spacing: 0;
157
+ }
158
+ *,
159
+ ::before,
160
+ ::after {
161
+ box-sizing: border-box;
162
+ }
163
+ html,
164
+ body {
165
+ font-size: 100%;
166
+ }
167
+ body {
168
+ background: #fff;
169
+ color: rgba(0, 0, 0, 0.8);
170
+ padding: 0;
171
+ margin: 0;
172
+ font-family: 'Noto Serif', 'DejaVu Serif', serif;
173
+ line-height: 1;
174
+ position: relative;
175
+ cursor: auto;
176
+ -moz-tab-size: 4;
177
+ -o-tab-size: 4;
178
+ tab-size: 4;
179
+ word-wrap: anywhere;
180
+ -moz-osx-font-smoothing: grayscale;
181
+ -webkit-font-smoothing: antialiased;
182
+ }
183
+ a:hover {
184
+ cursor: pointer;
185
+ }
186
+ img,
187
+ object,
188
+ embed {
189
+ max-width: 100%;
190
+ height: auto;
191
+ }
192
+ object,
193
+ embed {
194
+ height: 100%;
195
+ }
196
+ img {
197
+ -ms-interpolation-mode: bicubic;
198
+ }
199
+ .left {
200
+ float: left !important;
201
+ }
202
+ .right {
203
+ float: right !important;
204
+ }
205
+ .text-left {
206
+ text-align: left !important;
207
+ }
208
+ .text-right {
209
+ text-align: right !important;
210
+ }
211
+ .text-center {
212
+ text-align: center !important;
213
+ }
214
+ .text-justify {
215
+ text-align: justify !important;
216
+ }
217
+ .hide {
218
+ display: none;
219
+ }
220
+ img,
221
+ object,
222
+ svg {
223
+ display: inline-block;
224
+ vertical-align: middle;
225
+ }
226
+ textarea {
227
+ height: auto;
228
+ min-height: 50px;
229
+ }
230
+ select {
231
+ width: 100%;
232
+ }
233
+ .subheader,
234
+ .admonitionblock td.content > .title,
235
+ .audioblock > .title,
236
+ .exampleblock > .title,
237
+ .imageblock > .title,
238
+ .listingblock > .title,
239
+ .literalblock > .title,
240
+ .stemblock > .title,
241
+ .openblock > .title,
242
+ .paragraph > .title,
243
+ .quoteblock > .title,
244
+ table.tableblock > .title,
245
+ .verseblock > .title,
246
+ .videoblock > .title,
247
+ .dlist > .title,
248
+ .olist > .title,
249
+ .ulist > .title,
250
+ .qlist > .title,
251
+ .hdlist > .title {
252
+ line-height: 1.45;
253
+ color: #7a2518;
254
+ font-weight: 400;
255
+ margin-top: 0;
256
+ margin-bottom: 0.25em;
257
+ }
258
+ div,
259
+ dl,
260
+ dt,
261
+ dd,
262
+ ul,
263
+ ol,
264
+ li,
265
+ h1,
266
+ h2,
267
+ h3,
268
+ #toctitle,
269
+ .sidebarblock > .content > .title,
270
+ h4,
271
+ h5,
272
+ h6,
273
+ pre,
274
+ form,
275
+ p,
276
+ blockquote,
277
+ th,
278
+ td {
279
+ margin: 0;
280
+ padding: 0;
281
+ }
282
+ a {
283
+ color: #2156a5;
284
+ text-decoration: underline;
285
+ line-height: inherit;
286
+ }
287
+ a:hover,
288
+ a:focus {
289
+ color: #1d4b8f;
290
+ }
291
+ a img {
292
+ border: 0;
293
+ }
294
+ p {
295
+ line-height: 1.6;
296
+ margin-bottom: 1.25em;
297
+ text-rendering: optimizeLegibility;
298
+ }
299
+ p aside {
300
+ font-size: 0.875em;
301
+ line-height: 1.35;
302
+ font-style: italic;
303
+ }
304
+ h1,
305
+ h2,
306
+ h3,
307
+ #toctitle,
308
+ .sidebarblock > .content > .title,
309
+ h4,
310
+ h5,
311
+ h6 {
312
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
313
+ font-weight: 300;
314
+ font-style: normal;
315
+ color: #ba3925;
316
+ text-rendering: optimizeLegibility;
317
+ margin-top: 1em;
318
+ margin-bottom: 0.5em;
319
+ line-height: 1.0125em;
320
+ }
321
+ h1 small,
322
+ h2 small,
323
+ h3 small,
324
+ #toctitle small,
325
+ .sidebarblock > .content > .title small,
326
+ h4 small,
327
+ h5 small,
328
+ h6 small {
329
+ font-size: 60%;
330
+ color: #e99b8f;
331
+ line-height: 0;
332
+ }
333
+ h1 {
334
+ font-size: 2.125em;
335
+ }
336
+ h2 {
337
+ font-size: 1.6875em;
338
+ }
339
+ h3,
340
+ #toctitle,
341
+ .sidebarblock > .content > .title {
342
+ font-size: 1.375em;
343
+ }
344
+ h4,
345
+ h5 {
346
+ font-size: 1.125em;
347
+ }
348
+ h6 {
349
+ font-size: 1em;
350
+ }
351
+ hr {
352
+ border: solid #dddddf;
353
+ border-width: 1px 0 0;
354
+ clear: both;
355
+ margin: 1.25em 0 1.1875em;
356
+ }
357
+ em,
358
+ i {
359
+ font-style: italic;
360
+ line-height: inherit;
361
+ }
362
+ strong,
363
+ b {
364
+ font-weight: bold;
365
+ line-height: inherit;
366
+ }
367
+ small {
368
+ font-size: 60%;
369
+ line-height: inherit;
370
+ }
371
+ code {
372
+ font-family: 'Droid Sans Mono', 'DejaVu Sans Mono', monospace;
373
+ font-weight: 400;
374
+ color: rgba(0, 0, 0, 0.9);
375
+ }
376
+ ul,
377
+ ol,
378
+ dl {
379
+ line-height: 1.6;
380
+ margin-bottom: 1.25em;
381
+ list-style-position: outside;
382
+ font-family: inherit;
383
+ }
384
+ ul,
385
+ ol {
386
+ margin-left: 1.5em;
387
+ }
388
+ ul li ul,
389
+ ul li ol {
390
+ margin-left: 1.25em;
391
+ margin-bottom: 0;
392
+ }
393
+ ul.circle {
394
+ list-style-type: circle;
395
+ }
396
+ ul.disc {
397
+ list-style-type: disc;
398
+ }
399
+ ul.square {
400
+ list-style-type: square;
401
+ }
402
+ ul.circle ul:not([class]),
403
+ ul.disc ul:not([class]),
404
+ ul.square ul:not([class]) {
405
+ list-style: inherit;
406
+ }
407
+ ol li ul,
408
+ ol li ol {
409
+ margin-left: 1.25em;
410
+ margin-bottom: 0;
411
+ }
412
+ dl dt {
413
+ margin-bottom: 0.3125em;
414
+ font-weight: bold;
415
+ }
416
+ dl dd {
417
+ margin-bottom: 1.25em;
418
+ }
419
+ blockquote {
420
+ margin: 0 0 1.25em;
421
+ padding: 0.5625em 1.25em 0 1.1875em;
422
+ border-left: 1px solid #ddd;
423
+ }
424
+ blockquote,
425
+ blockquote p {
426
+ line-height: 1.6;
427
+ color: rgba(0, 0, 0, 0.85);
428
+ }
429
+ @media screen and (min-width: 768px) {
430
+ h1,
431
+ h2,
432
+ h3,
433
+ #toctitle,
434
+ .sidebarblock > .content > .title,
435
+ h4,
436
+ h5,
437
+ h6 {
438
+ line-height: 1.2;
439
+ }
440
+ h1 {
441
+ font-size: 2.75em;
442
+ }
443
+ h2 {
444
+ font-size: 2.3125em;
445
+ }
446
+ h3,
447
+ #toctitle,
448
+ .sidebarblock > .content > .title {
449
+ font-size: 1.6875em;
450
+ }
451
+ h4 {
452
+ font-size: 1.4375em;
453
+ }
454
+ }
455
+ table {
456
+ background: #fff;
457
+ margin-bottom: 1.25em;
458
+ border: 1px solid #dedede;
459
+ word-wrap: normal;
460
+ }
461
+ table thead,
462
+ table tfoot {
463
+ background: #f7f8f7;
464
+ }
465
+ table thead tr th,
466
+ table thead tr td,
467
+ table tfoot tr th,
468
+ table tfoot tr td {
469
+ padding: 0.5em 0.625em 0.625em;
470
+ font-size: inherit;
471
+ color: rgba(0, 0, 0, 0.8);
472
+ text-align: left;
473
+ }
474
+ table tr th,
475
+ table tr td {
476
+ padding: 0.5625em 0.625em;
477
+ font-size: inherit;
478
+ color: rgba(0, 0, 0, 0.8);
479
+ }
480
+ table tr.even,
481
+ table tr.alt {
482
+ background: #f8f8f7;
483
+ }
484
+ table thead tr th,
485
+ table tfoot tr th,
486
+ table tbody tr td,
487
+ table tr td,
488
+ table tfoot tr td {
489
+ line-height: 1.6;
490
+ }
491
+ h1,
492
+ h2,
493
+ h3,
494
+ #toctitle,
495
+ .sidebarblock > .content > .title,
496
+ h4,
497
+ h5,
498
+ h6 {
499
+ line-height: 1.2;
500
+ word-spacing: -0.05em;
501
+ }
502
+ h1 strong,
503
+ h2 strong,
504
+ h3 strong,
505
+ #toctitle strong,
506
+ .sidebarblock > .content > .title strong,
507
+ h4 strong,
508
+ h5 strong,
509
+ h6 strong {
510
+ font-weight: 400;
511
+ }
512
+ .center {
513
+ margin-left: auto;
514
+ margin-right: auto;
515
+ }
516
+ .stretch {
517
+ width: 100%;
518
+ }
519
+ .clearfix::before,
520
+ .clearfix::after,
521
+ .float-group::before,
522
+ .float-group::after {
523
+ content: ' ';
524
+ display: table;
525
+ }
526
+ .clearfix::after,
527
+ .float-group::after {
528
+ clear: both;
529
+ }
530
+ :not(pre).nobreak {
531
+ word-wrap: normal;
532
+ }
533
+ :not(pre).nowrap {
534
+ white-space: nowrap;
535
+ }
536
+ :not(pre).pre-wrap {
537
+ white-space: pre-wrap;
538
+ }
539
+ :not(pre):not([class^='L']) > code {
540
+ font-size: 0.9375em;
541
+ font-style: normal !important;
542
+ letter-spacing: 0;
543
+ padding: 0.1em 0.5ex;
544
+ word-spacing: -0.15em;
545
+ background: #f7f7f8;
546
+ border-radius: 4px;
547
+ line-height: 1.45;
548
+ text-rendering: optimizeSpeed;
549
+ }
550
+ pre {
551
+ color: rgba(0, 0, 0, 0.9);
552
+ font-family: 'Droid Sans Mono', 'DejaVu Sans Mono', monospace;
553
+ line-height: 1.45;
554
+ text-rendering: optimizeSpeed;
555
+ }
556
+ pre code,
557
+ pre pre {
558
+ color: inherit;
559
+ font-size: inherit;
560
+ line-height: inherit;
561
+ }
562
+ pre > code {
563
+ display: block;
564
+ }
565
+ pre.nowrap,
566
+ pre.nowrap pre {
567
+ white-space: pre;
568
+ word-wrap: normal;
569
+ }
570
+ em em {
571
+ font-style: normal;
572
+ }
573
+ strong strong {
574
+ font-weight: 400;
575
+ }
576
+ .keyseq {
577
+ color: rgba(51, 51, 51, 0.8);
578
+ }
579
+ kbd {
580
+ font-family: 'Droid Sans Mono', 'DejaVu Sans Mono', monospace;
581
+ display: inline-block;
582
+ color: rgba(0, 0, 0, 0.8);
583
+ font-size: 0.65em;
584
+ line-height: 1.45;
585
+ background: #f7f7f7;
586
+ border: 1px solid #ccc;
587
+ border-radius: 3px;
588
+ box-shadow:
589
+ 0 1px 0 rgba(0, 0, 0, 0.2),
590
+ inset 0 0 0 0.1em #fff;
591
+ margin: 0 0.15em;
592
+ padding: 0.2em 0.5em;
593
+ vertical-align: middle;
594
+ position: relative;
595
+ top: -0.1em;
596
+ white-space: nowrap;
597
+ }
598
+ .keyseq kbd:first-child {
599
+ margin-left: 0;
600
+ }
601
+ .keyseq kbd:last-child {
602
+ margin-right: 0;
603
+ }
604
+ .menuseq,
605
+ .menuref {
606
+ color: #000;
607
+ }
608
+ .menuseq b:not(.caret),
609
+ .menuref {
610
+ font-weight: inherit;
611
+ }
612
+ .menuseq {
613
+ word-spacing: -0.02em;
614
+ }
615
+ .menuseq b.caret {
616
+ font-size: 1.25em;
617
+ line-height: 0.8;
618
+ }
619
+ .menuseq i.caret {
620
+ font-weight: bold;
621
+ text-align: center;
622
+ width: 0.45em;
623
+ }
624
+ b.button::before,
625
+ b.button::after {
626
+ position: relative;
627
+ top: -1px;
628
+ font-weight: 400;
629
+ }
630
+ b.button::before {
631
+ content: '[';
632
+ padding: 0 3px 0 2px;
633
+ }
634
+ b.button::after {
635
+ content: ']';
636
+ padding: 0 2px 0 3px;
637
+ }
638
+ p a > code:hover {
639
+ color: rgba(0, 0, 0, 0.9);
640
+ }
641
+ #header,
642
+ #content,
643
+ #footnotes,
644
+ #footer {
645
+ width: 100%;
646
+ margin: 0 auto;
647
+ max-width: 62.5em;
648
+ *zoom: 1;
649
+ position: relative;
650
+ padding-left: 0.9375em;
651
+ padding-right: 0.9375em;
652
+ }
653
+ #header::before,
654
+ #header::after,
655
+ #content::before,
656
+ #content::after,
657
+ #footnotes::before,
658
+ #footnotes::after,
659
+ #footer::before,
660
+ #footer::after {
661
+ content: ' ';
662
+ display: table;
663
+ }
664
+ #header::after,
665
+ #content::after,
666
+ #footnotes::after,
667
+ #footer::after {
668
+ clear: both;
669
+ }
670
+ #content {
671
+ margin-top: 1.25em;
672
+ }
673
+ #content::before {
674
+ content: none;
675
+ }
676
+ #header > h1:first-child {
677
+ color: rgba(0, 0, 0, 0.85);
678
+ margin-top: 2.25rem;
679
+ margin-bottom: 0;
680
+ }
681
+ #header > h1:first-child + #toc {
682
+ margin-top: 8px;
683
+ border-top: 1px solid #dddddf;
684
+ }
685
+ #header > h1:only-child,
686
+ body.toc2 #header > h1:nth-last-child(2) {
687
+ border-bottom: 1px solid #dddddf;
688
+ padding-bottom: 8px;
689
+ }
690
+ #header .details {
691
+ border-bottom: 1px solid #dddddf;
692
+ line-height: 1.45;
693
+ padding-top: 0.25em;
694
+ padding-bottom: 0.25em;
695
+ padding-left: 0.25em;
696
+ color: rgba(0, 0, 0, 0.6);
697
+ display: flex;
698
+ flex-flow: row wrap;
699
+ }
700
+ #header .details span:first-child {
701
+ margin-left: -0.125em;
702
+ }
703
+ #header .details span.email a {
704
+ color: rgba(0, 0, 0, 0.85);
705
+ }
706
+ #header .details br {
707
+ display: none;
708
+ }
709
+ #header .details br + span::before {
710
+ content: '\00a0\2013\00a0';
711
+ }
712
+ #header .details br + span.author::before {
713
+ content: '\00a0\22c5\00a0';
714
+ color: rgba(0, 0, 0, 0.85);
715
+ }
716
+ #header .details br + span#revremark::before {
717
+ content: '\00a0|\00a0';
718
+ }
719
+ #header #revnumber {
720
+ text-transform: capitalize;
721
+ }
722
+ #header #revnumber::after {
723
+ content: '\00a0';
724
+ }
725
+ #content > h1:first-child:not([class]) {
726
+ color: rgba(0, 0, 0, 0.85);
727
+ border-bottom: 1px solid #dddddf;
728
+ padding-bottom: 8px;
729
+ margin-top: 0;
730
+ padding-top: 1rem;
731
+ margin-bottom: 1.25rem;
732
+ }
733
+ #toc {
734
+ border-bottom: 1px solid #e7e7e9;
735
+ padding-bottom: 0.5em;
736
+ }
737
+ #toc > ul {
738
+ margin-left: 0.125em;
739
+ }
740
+ #toc ul.sectlevel0 > li > a {
741
+ font-style: italic;
742
+ }
743
+ #toc ul.sectlevel0 ul.sectlevel1 {
744
+ margin: 0.5em 0;
745
+ }
746
+ #toc ul {
747
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
748
+ list-style-type: none;
749
+ }
750
+ #toc li {
751
+ line-height: 1.3334;
752
+ margin-top: 0.3334em;
753
+ }
754
+ #toc a {
755
+ text-decoration: none;
756
+ }
757
+ #toc a:active {
758
+ text-decoration: underline;
759
+ }
760
+ #toctitle {
761
+ color: #7a2518;
762
+ font-size: 1.2em;
763
+ }
764
+ @media screen and (min-width: 768px) {
765
+ #toctitle {
766
+ font-size: 1.375em;
767
+ }
768
+ body.toc2 {
769
+ padding-left: 15em;
770
+ padding-right: 0;
771
+ }
772
+ #toc.toc2 {
773
+ margin-top: 0 !important;
774
+ background: #f8f8f7;
775
+ position: fixed;
776
+ width: 15em;
777
+ left: 0;
778
+ top: 0;
779
+ border-right: 1px solid #e7e7e9;
780
+ border-top-width: 0 !important;
781
+ border-bottom-width: 0 !important;
782
+ z-index: 1000;
783
+ padding: 1.25em 1em;
784
+ height: 100%;
785
+ overflow: auto;
786
+ }
787
+ #toc.toc2 #toctitle {
788
+ margin-top: 0;
789
+ margin-bottom: 0.8rem;
790
+ font-size: 1.2em;
791
+ }
792
+ #toc.toc2 > ul {
793
+ font-size: 0.9em;
794
+ margin-bottom: 0;
795
+ }
796
+ #toc.toc2 ul ul {
797
+ margin-left: 0;
798
+ padding-left: 1em;
799
+ }
800
+ #toc.toc2 ul.sectlevel0 ul.sectlevel1 {
801
+ padding-left: 0;
802
+ margin-top: 0.5em;
803
+ margin-bottom: 0.5em;
804
+ }
805
+ body.toc2.toc-right {
806
+ padding-left: 0;
807
+ padding-right: 15em;
808
+ }
809
+ body.toc2.toc-right #toc.toc2 {
810
+ border-right-width: 0;
811
+ border-left: 1px solid #e7e7e9;
812
+ left: auto;
813
+ right: 0;
814
+ }
815
+ }
816
+ @media screen and (min-width: 1280px) {
817
+ body.toc2 {
818
+ padding-left: 20em;
819
+ padding-right: 0;
820
+ }
821
+ #toc.toc2 {
822
+ width: 20em;
823
+ }
824
+ #toc.toc2 #toctitle {
825
+ font-size: 1.375em;
826
+ }
827
+ #toc.toc2 > ul {
828
+ font-size: 0.95em;
829
+ }
830
+ #toc.toc2 ul ul {
831
+ padding-left: 1.25em;
832
+ }
833
+ body.toc2.toc-right {
834
+ padding-left: 0;
835
+ padding-right: 20em;
836
+ }
837
+ }
838
+ #content #toc {
839
+ border: 1px solid #e0e0dc;
840
+ margin-bottom: 1.25em;
841
+ padding: 1.25em;
842
+ background: #f8f8f7;
843
+ border-radius: 4px;
844
+ }
845
+ #content #toc > :first-child {
846
+ margin-top: 0;
847
+ }
848
+ #content #toc > :last-child {
849
+ margin-bottom: 0;
850
+ }
851
+ #footer {
852
+ max-width: none;
853
+ background: rgba(0, 0, 0, 0.8);
854
+ padding: 1.25em;
855
+ }
856
+ #footer-text {
857
+ color: hsla(0, 0%, 100%, 0.8);
858
+ line-height: 1.44;
859
+ }
860
+ #content {
861
+ margin-bottom: 0.625em;
862
+ }
863
+ .sect1 {
864
+ padding-bottom: 0.625em;
865
+ }
866
+ @media screen and (min-width: 768px) {
867
+ #content {
868
+ margin-bottom: 1.25em;
869
+ }
870
+ .sect1 {
871
+ padding-bottom: 1.25em;
872
+ }
873
+ }
874
+ .sect1:last-child {
875
+ padding-bottom: 0;
876
+ }
877
+ .sect1 + .sect1 {
878
+ border-top: 1px solid #e7e7e9;
879
+ }
880
+ #content h1 > a.anchor,
881
+ h2 > a.anchor,
882
+ h3 > a.anchor,
883
+ #toctitle > a.anchor,
884
+ .sidebarblock > .content > .title > a.anchor,
885
+ h4 > a.anchor,
886
+ h5 > a.anchor,
887
+ h6 > a.anchor {
888
+ position: absolute;
889
+ z-index: 1001;
890
+ width: 1.5ex;
891
+ margin-left: -1.5ex;
892
+ display: block;
893
+ text-decoration: none !important;
894
+ visibility: hidden;
895
+ text-align: center;
896
+ font-weight: 400;
897
+ }
898
+ #content h1 > a.anchor::before,
899
+ h2 > a.anchor::before,
900
+ h3 > a.anchor::before,
901
+ #toctitle > a.anchor::before,
902
+ .sidebarblock > .content > .title > a.anchor::before,
903
+ h4 > a.anchor::before,
904
+ h5 > a.anchor::before,
905
+ h6 > a.anchor::before {
906
+ content: '\00A7';
907
+ font-size: 0.85em;
908
+ display: block;
909
+ padding-top: 0.1em;
910
+ }
911
+ #content h1:hover > a.anchor,
912
+ #content h1 > a.anchor:hover,
913
+ h2:hover > a.anchor,
914
+ h2 > a.anchor:hover,
915
+ h3:hover > a.anchor,
916
+ #toctitle:hover > a.anchor,
917
+ .sidebarblock > .content > .title:hover > a.anchor,
918
+ h3 > a.anchor:hover,
919
+ #toctitle > a.anchor:hover,
920
+ .sidebarblock > .content > .title > a.anchor:hover,
921
+ h4:hover > a.anchor,
922
+ h4 > a.anchor:hover,
923
+ h5:hover > a.anchor,
924
+ h5 > a.anchor:hover,
925
+ h6:hover > a.anchor,
926
+ h6 > a.anchor:hover {
927
+ visibility: visible;
928
+ }
929
+ #content h1 > a.link,
930
+ h2 > a.link,
931
+ h3 > a.link,
932
+ #toctitle > a.link,
933
+ .sidebarblock > .content > .title > a.link,
934
+ h4 > a.link,
935
+ h5 > a.link,
936
+ h6 > a.link {
937
+ color: #ba3925;
938
+ text-decoration: none;
939
+ }
940
+ #content h1 > a.link:hover,
941
+ h2 > a.link:hover,
942
+ h3 > a.link:hover,
943
+ #toctitle > a.link:hover,
944
+ .sidebarblock > .content > .title > a.link:hover,
945
+ h4 > a.link:hover,
946
+ h5 > a.link:hover,
947
+ h6 > a.link:hover {
948
+ color: #a53221;
949
+ }
950
+ details,
951
+ .audioblock,
952
+ .imageblock,
953
+ .literalblock,
954
+ .listingblock,
955
+ .stemblock,
956
+ .videoblock {
957
+ margin-bottom: 1.25em;
958
+ }
959
+ details {
960
+ margin-left: 1.25rem;
961
+ }
962
+ details > summary {
963
+ cursor: pointer;
964
+ display: block;
965
+ position: relative;
966
+ line-height: 1.6;
967
+ margin-bottom: 0.625rem;
968
+ outline: none;
969
+ -webkit-tap-highlight-color: transparent;
970
+ }
971
+ details > summary::-webkit-details-marker {
972
+ display: none;
973
+ }
974
+ details > summary::before {
975
+ content: '';
976
+ border: solid transparent;
977
+ border-left: solid;
978
+ border-width: 0.3em 0 0.3em 0.5em;
979
+ position: absolute;
980
+ top: 0.5em;
981
+ left: -1.25rem;
982
+ transform: translateX(15%);
983
+ }
984
+ details[open] > summary::before {
985
+ border: solid transparent;
986
+ border-top: solid;
987
+ border-width: 0.5em 0.3em 0;
988
+ transform: translateY(15%);
989
+ }
990
+ details > summary::after {
991
+ content: '';
992
+ width: 1.25rem;
993
+ height: 1em;
994
+ position: absolute;
995
+ top: 0.3em;
996
+ left: -1.25rem;
997
+ }
998
+ .admonitionblock td.content > .title,
999
+ .audioblock > .title,
1000
+ .exampleblock > .title,
1001
+ .imageblock > .title,
1002
+ .listingblock > .title,
1003
+ .literalblock > .title,
1004
+ .stemblock > .title,
1005
+ .openblock > .title,
1006
+ .paragraph > .title,
1007
+ .quoteblock > .title,
1008
+ table.tableblock > .title,
1009
+ .verseblock > .title,
1010
+ .videoblock > .title,
1011
+ .dlist > .title,
1012
+ .olist > .title,
1013
+ .ulist > .title,
1014
+ .qlist > .title,
1015
+ .hdlist > .title {
1016
+ text-rendering: optimizeLegibility;
1017
+ text-align: left;
1018
+ font-family: 'Noto Serif', 'DejaVu Serif', serif;
1019
+ font-size: 1rem;
1020
+ font-style: italic;
1021
+ }
1022
+ table.tableblock.fit-content > caption.title {
1023
+ white-space: nowrap;
1024
+ width: 0;
1025
+ }
1026
+ .paragraph.lead > p,
1027
+ #preamble > .sectionbody > [class='paragraph']:first-of-type p {
1028
+ font-size: 1.21875em;
1029
+ line-height: 1.6;
1030
+ color: rgba(0, 0, 0, 0.85);
1031
+ }
1032
+ .admonitionblock > table {
1033
+ border-collapse: separate;
1034
+ border: 0;
1035
+ background: none;
1036
+ width: 100%;
1037
+ }
1038
+ .admonitionblock > table td.icon {
1039
+ text-align: center;
1040
+ width: 80px;
1041
+ }
1042
+ .admonitionblock > table td.icon img {
1043
+ max-width: none;
1044
+ }
1045
+ .admonitionblock > table td.icon .title {
1046
+ font-weight: bold;
1047
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
1048
+ text-transform: uppercase;
1049
+ }
1050
+ .admonitionblock > table td.content {
1051
+ padding-left: 1.125em;
1052
+ padding-right: 1.25em;
1053
+ border-left: 1px solid #dddddf;
1054
+ color: rgba(0, 0, 0, 0.6);
1055
+ word-wrap: anywhere;
1056
+ }
1057
+ .admonitionblock > table td.content > :last-child > :last-child {
1058
+ margin-bottom: 0;
1059
+ }
1060
+ .exampleblock > .content {
1061
+ border: 1px solid #e6e6e6;
1062
+ margin-bottom: 1.25em;
1063
+ padding: 1.25em;
1064
+ background: #fff;
1065
+ border-radius: 4px;
1066
+ }
1067
+ .sidebarblock {
1068
+ border: 1px solid #dbdbd6;
1069
+ margin-bottom: 1.25em;
1070
+ padding: 1.25em;
1071
+ background: #f3f3f2;
1072
+ border-radius: 4px;
1073
+ }
1074
+ .sidebarblock > .content > .title {
1075
+ color: #7a2518;
1076
+ margin-top: 0;
1077
+ text-align: center;
1078
+ }
1079
+ .exampleblock > .content > :first-child,
1080
+ .sidebarblock > .content > :first-child {
1081
+ margin-top: 0;
1082
+ }
1083
+ .exampleblock > .content > :last-child,
1084
+ .exampleblock > .content > :last-child > :last-child,
1085
+ .exampleblock > .content .olist > ol > li:last-child > :last-child,
1086
+ .exampleblock > .content .ulist > ul > li:last-child > :last-child,
1087
+ .exampleblock > .content .qlist > ol > li:last-child > :last-child,
1088
+ .sidebarblock > .content > :last-child,
1089
+ .sidebarblock > .content > :last-child > :last-child,
1090
+ .sidebarblock > .content .olist > ol > li:last-child > :last-child,
1091
+ .sidebarblock > .content .ulist > ul > li:last-child > :last-child,
1092
+ .sidebarblock > .content .qlist > ol > li:last-child > :last-child {
1093
+ margin-bottom: 0;
1094
+ }
1095
+ .literalblock pre,
1096
+ .listingblock > .content > pre {
1097
+ border-radius: 4px;
1098
+ overflow-x: auto;
1099
+ padding: 1em;
1100
+ font-size: 0.8125em;
1101
+ }
1102
+ @media screen and (min-width: 768px) {
1103
+ .literalblock pre,
1104
+ .listingblock > .content > pre {
1105
+ font-size: 0.90625em;
1106
+ }
1107
+ }
1108
+ @media screen and (min-width: 1280px) {
1109
+ .literalblock pre,
1110
+ .listingblock > .content > pre {
1111
+ font-size: 1em;
1112
+ }
1113
+ }
1114
+ .literalblock pre,
1115
+ .listingblock > .content > pre:not(.highlight),
1116
+ .listingblock > .content > pre[class='highlight'],
1117
+ .listingblock > .content > pre[class^='highlight '] {
1118
+ background: #f7f7f8;
1119
+ }
1120
+ .literalblock.output pre {
1121
+ color: #f7f7f8;
1122
+ background: rgba(0, 0, 0, 0.9);
1123
+ }
1124
+ .listingblock > .content {
1125
+ position: relative;
1126
+ }
1127
+ .listingblock code[data-lang]::before {
1128
+ display: none;
1129
+ content: attr(data-lang);
1130
+ position: absolute;
1131
+ font-size: 0.75em;
1132
+ top: 0.425rem;
1133
+ right: 0.5rem;
1134
+ line-height: 1;
1135
+ text-transform: uppercase;
1136
+ color: inherit;
1137
+ opacity: 0.5;
1138
+ }
1139
+ .listingblock:hover code[data-lang]::before {
1140
+ display: block;
1141
+ }
1142
+ .listingblock.terminal pre .command::before {
1143
+ content: attr(data-prompt);
1144
+ padding-right: 0.5em;
1145
+ color: inherit;
1146
+ opacity: 0.5;
1147
+ }
1148
+ .listingblock.terminal pre .command:not([data-prompt])::before {
1149
+ content: '$';
1150
+ }
1151
+ .listingblock pre.highlightjs {
1152
+ padding: 0;
1153
+ }
1154
+ .listingblock pre.highlightjs > code {
1155
+ padding: 1em;
1156
+ border-radius: 4px;
1157
+ }
1158
+ .listingblock pre.prettyprint {
1159
+ border-width: 0;
1160
+ }
1161
+ .prettyprint {
1162
+ background: #f7f7f8;
1163
+ }
1164
+ pre.prettyprint .linenums {
1165
+ line-height: 1.45;
1166
+ margin-left: 2em;
1167
+ }
1168
+ pre.prettyprint li {
1169
+ background: none;
1170
+ list-style-type: inherit;
1171
+ padding-left: 0;
1172
+ }
1173
+ pre.prettyprint li code[data-lang]::before {
1174
+ opacity: 1;
1175
+ }
1176
+ pre.prettyprint li:not(:first-child) code[data-lang]::before {
1177
+ display: none;
1178
+ }
1179
+ table.linenotable {
1180
+ border-collapse: separate;
1181
+ border: 0;
1182
+ margin-bottom: 0;
1183
+ background: none;
1184
+ }
1185
+ table.linenotable td[class] {
1186
+ color: inherit;
1187
+ vertical-align: top;
1188
+ padding: 0;
1189
+ line-height: inherit;
1190
+ white-space: normal;
1191
+ }
1192
+ table.linenotable td.code {
1193
+ padding-left: 0.75em;
1194
+ }
1195
+ table.linenotable td.linenos,
1196
+ pre.pygments .linenos {
1197
+ border-right: 1px solid;
1198
+ opacity: 0.35;
1199
+ padding-right: 0.5em;
1200
+ -webkit-user-select: none;
1201
+ -moz-user-select: none;
1202
+ -ms-user-select: none;
1203
+ user-select: none;
1204
+ }
1205
+ pre.pygments span.linenos {
1206
+ display: inline-block;
1207
+ margin-right: 0.75em;
1208
+ }
1209
+ .quoteblock {
1210
+ margin: 0 1em 1.25em 1.5em;
1211
+ display: table;
1212
+ }
1213
+ .quoteblock:not(.excerpt) > .title {
1214
+ margin-left: -1.5em;
1215
+ margin-bottom: 0.75em;
1216
+ }
1217
+ .quoteblock blockquote,
1218
+ .quoteblock p {
1219
+ color: rgba(0, 0, 0, 0.85);
1220
+ font-size: 1.15rem;
1221
+ line-height: 1.75;
1222
+ word-spacing: 0.1em;
1223
+ letter-spacing: 0;
1224
+ font-style: italic;
1225
+ text-align: justify;
1226
+ }
1227
+ .quoteblock blockquote {
1228
+ margin: 0;
1229
+ padding: 0;
1230
+ border: 0;
1231
+ }
1232
+ .quoteblock blockquote::before {
1233
+ content: '\201c';
1234
+ float: left;
1235
+ font-size: 2.75em;
1236
+ font-weight: bold;
1237
+ line-height: 0.6em;
1238
+ margin-left: -0.6em;
1239
+ color: #7a2518;
1240
+ text-shadow: 0 1px 2px rgba(0, 0, 0, 0.1);
1241
+ }
1242
+ .quoteblock blockquote > .paragraph:last-child p {
1243
+ margin-bottom: 0;
1244
+ }
1245
+ .quoteblock .attribution {
1246
+ margin-top: 0.75em;
1247
+ margin-right: 0.5ex;
1248
+ text-align: right;
1249
+ }
1250
+ .verseblock {
1251
+ margin: 0 1em 1.25em;
1252
+ }
1253
+ .verseblock pre {
1254
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
1255
+ font-size: 1.15rem;
1256
+ color: rgba(0, 0, 0, 0.85);
1257
+ font-weight: 300;
1258
+ text-rendering: optimizeLegibility;
1259
+ }
1260
+ .verseblock pre strong {
1261
+ font-weight: 400;
1262
+ }
1263
+ .verseblock .attribution {
1264
+ margin-top: 1.25rem;
1265
+ margin-left: 0.5ex;
1266
+ }
1267
+ .quoteblock .attribution,
1268
+ .verseblock .attribution {
1269
+ font-size: 0.9375em;
1270
+ line-height: 1.45;
1271
+ font-style: italic;
1272
+ }
1273
+ .quoteblock .attribution br,
1274
+ .verseblock .attribution br {
1275
+ display: none;
1276
+ }
1277
+ .quoteblock .attribution cite,
1278
+ .verseblock .attribution cite {
1279
+ display: block;
1280
+ letter-spacing: -0.025em;
1281
+ color: rgba(0, 0, 0, 0.6);
1282
+ }
1283
+ .quoteblock.abstract blockquote::before,
1284
+ .quoteblock.excerpt blockquote::before,
1285
+ .quoteblock .quoteblock blockquote::before {
1286
+ display: none;
1287
+ }
1288
+ .quoteblock.abstract blockquote,
1289
+ .quoteblock.abstract p,
1290
+ .quoteblock.excerpt blockquote,
1291
+ .quoteblock.excerpt p,
1292
+ .quoteblock .quoteblock blockquote,
1293
+ .quoteblock .quoteblock p {
1294
+ line-height: 1.6;
1295
+ word-spacing: 0;
1296
+ }
1297
+ .quoteblock.abstract {
1298
+ margin: 0 1em 1.25em;
1299
+ display: block;
1300
+ }
1301
+ .quoteblock.abstract > .title {
1302
+ margin: 0 0 0.375em;
1303
+ font-size: 1.15em;
1304
+ text-align: center;
1305
+ }
1306
+ .quoteblock.excerpt > blockquote,
1307
+ .quoteblock .quoteblock {
1308
+ padding: 0 0 0.25em 1em;
1309
+ border-left: 0.25em solid #dddddf;
1310
+ }
1311
+ .quoteblock.excerpt,
1312
+ .quoteblock .quoteblock {
1313
+ margin-left: 0;
1314
+ }
1315
+ .quoteblock.excerpt blockquote,
1316
+ .quoteblock.excerpt p,
1317
+ .quoteblock .quoteblock blockquote,
1318
+ .quoteblock .quoteblock p {
1319
+ color: inherit;
1320
+ font-size: 1.0625rem;
1321
+ }
1322
+ .quoteblock.excerpt .attribution,
1323
+ .quoteblock .quoteblock .attribution {
1324
+ color: inherit;
1325
+ font-size: 0.85rem;
1326
+ text-align: left;
1327
+ margin-right: 0;
1328
+ }
1329
+ p.tableblock:last-child {
1330
+ margin-bottom: 0;
1331
+ }
1332
+ td.tableblock > .content {
1333
+ margin-bottom: 1.25em;
1334
+ word-wrap: anywhere;
1335
+ }
1336
+ td.tableblock > .content > :last-child {
1337
+ margin-bottom: -1.25em;
1338
+ }
1339
+ table.tableblock,
1340
+ th.tableblock,
1341
+ td.tableblock {
1342
+ border: 0 solid #dedede;
1343
+ }
1344
+ table.grid-all > * > tr > * {
1345
+ border-width: 1px;
1346
+ }
1347
+ table.grid-cols > * > tr > * {
1348
+ border-width: 0 1px;
1349
+ }
1350
+ table.grid-rows > * > tr > * {
1351
+ border-width: 1px 0;
1352
+ }
1353
+ table.frame-all {
1354
+ border-width: 1px;
1355
+ }
1356
+ table.frame-ends {
1357
+ border-width: 1px 0;
1358
+ }
1359
+ table.frame-sides {
1360
+ border-width: 0 1px;
1361
+ }
1362
+ table.frame-none > colgroup + * > :first-child > *,
1363
+ table.frame-sides > colgroup + * > :first-child > * {
1364
+ border-top-width: 0;
1365
+ }
1366
+ table.frame-none > :last-child > :last-child > *,
1367
+ table.frame-sides > :last-child > :last-child > * {
1368
+ border-bottom-width: 0;
1369
+ }
1370
+ table.frame-none > * > tr > :first-child,
1371
+ table.frame-ends > * > tr > :first-child {
1372
+ border-left-width: 0;
1373
+ }
1374
+ table.frame-none > * > tr > :last-child,
1375
+ table.frame-ends > * > tr > :last-child {
1376
+ border-right-width: 0;
1377
+ }
1378
+ table.stripes-all > * > tr,
1379
+ table.stripes-odd > * > tr:nth-of-type(odd),
1380
+ table.stripes-even > * > tr:nth-of-type(even),
1381
+ table.stripes-hover > * > tr:hover {
1382
+ background: #f8f8f7;
1383
+ }
1384
+ th.halign-left,
1385
+ td.halign-left {
1386
+ text-align: left;
1387
+ }
1388
+ th.halign-right,
1389
+ td.halign-right {
1390
+ text-align: right;
1391
+ }
1392
+ th.halign-center,
1393
+ td.halign-center {
1394
+ text-align: center;
1395
+ }
1396
+ th.valign-top,
1397
+ td.valign-top {
1398
+ vertical-align: top;
1399
+ }
1400
+ th.valign-bottom,
1401
+ td.valign-bottom {
1402
+ vertical-align: bottom;
1403
+ }
1404
+ th.valign-middle,
1405
+ td.valign-middle {
1406
+ vertical-align: middle;
1407
+ }
1408
+ table thead th,
1409
+ table tfoot th {
1410
+ font-weight: bold;
1411
+ }
1412
+ tbody tr th {
1413
+ background: #f7f8f7;
1414
+ }
1415
+ tbody tr th,
1416
+ tbody tr th p,
1417
+ tfoot tr th,
1418
+ tfoot tr th p {
1419
+ color: rgba(0, 0, 0, 0.8);
1420
+ font-weight: bold;
1421
+ }
1422
+ p.tableblock > code:only-child {
1423
+ background: none;
1424
+ padding: 0;
1425
+ }
1426
+ p.tableblock {
1427
+ font-size: 1em;
1428
+ }
1429
+ ol {
1430
+ margin-left: 1.75em;
1431
+ }
1432
+ ul li ol {
1433
+ margin-left: 1.5em;
1434
+ }
1435
+ dl dd {
1436
+ margin-left: 1.125em;
1437
+ }
1438
+ dl dd:last-child,
1439
+ dl dd:last-child > :last-child {
1440
+ margin-bottom: 0;
1441
+ }
1442
+ li p,
1443
+ ul dd,
1444
+ ol dd,
1445
+ .olist .olist,
1446
+ .ulist .ulist,
1447
+ .ulist .olist,
1448
+ .olist .ulist {
1449
+ margin-bottom: 0.625em;
1450
+ }
1451
+ ul.checklist,
1452
+ ul.none,
1453
+ ol.none,
1454
+ ul.no-bullet,
1455
+ ol.no-bullet,
1456
+ ol.unnumbered,
1457
+ ul.unstyled,
1458
+ ol.unstyled {
1459
+ list-style-type: none;
1460
+ }
1461
+ ul.no-bullet,
1462
+ ol.no-bullet,
1463
+ ol.unnumbered {
1464
+ margin-left: 0.625em;
1465
+ }
1466
+ ul.unstyled,
1467
+ ol.unstyled {
1468
+ margin-left: 0;
1469
+ }
1470
+ li > p:empty:only-child::before {
1471
+ content: '';
1472
+ display: inline-block;
1473
+ }
1474
+ ul.checklist > li > p:first-child {
1475
+ margin-left: -1em;
1476
+ }
1477
+ ul.checklist > li > p:first-child > .fa-square-o:first-child,
1478
+ ul.checklist > li > p:first-child > .fa-check-square-o:first-child {
1479
+ width: 1.25em;
1480
+ font-size: 0.8em;
1481
+ position: relative;
1482
+ bottom: 0.125em;
1483
+ }
1484
+ ul.checklist > li > p:first-child > input[type='checkbox']:first-child {
1485
+ margin-right: 0.25em;
1486
+ }
1487
+ ul.inline {
1488
+ display: flex;
1489
+ flex-flow: row wrap;
1490
+ list-style: none;
1491
+ margin: 0 0 0.625em -1.25em;
1492
+ }
1493
+ ul.inline > li {
1494
+ margin-left: 1.25em;
1495
+ }
1496
+ .unstyled dl dt {
1497
+ font-weight: 400;
1498
+ font-style: normal;
1499
+ }
1500
+ ol.arabic {
1501
+ list-style-type: decimal;
1502
+ }
1503
+ ol.decimal {
1504
+ list-style-type: decimal-leading-zero;
1505
+ }
1506
+ ol.loweralpha {
1507
+ list-style-type: lower-alpha;
1508
+ }
1509
+ ol.upperalpha {
1510
+ list-style-type: upper-alpha;
1511
+ }
1512
+ ol.lowerroman {
1513
+ list-style-type: lower-roman;
1514
+ }
1515
+ ol.upperroman {
1516
+ list-style-type: upper-roman;
1517
+ }
1518
+ ol.lowergreek {
1519
+ list-style-type: lower-greek;
1520
+ }
1521
+ .hdlist > table,
1522
+ .colist > table {
1523
+ border: 0;
1524
+ background: none;
1525
+ }
1526
+ .hdlist > table > tbody > tr,
1527
+ .colist > table > tbody > tr {
1528
+ background: none;
1529
+ }
1530
+ td.hdlist1,
1531
+ td.hdlist2 {
1532
+ vertical-align: top;
1533
+ padding: 0 0.625em;
1534
+ }
1535
+ td.hdlist1 {
1536
+ font-weight: bold;
1537
+ padding-bottom: 1.25em;
1538
+ }
1539
+ td.hdlist2 {
1540
+ word-wrap: anywhere;
1541
+ }
1542
+ .literalblock + .colist,
1543
+ .listingblock + .colist {
1544
+ margin-top: -0.5em;
1545
+ }
1546
+ .colist td:not([class]):first-child {
1547
+ padding: 0.4em 0.75em 0;
1548
+ line-height: 1;
1549
+ vertical-align: top;
1550
+ }
1551
+ .colist td:not([class]):first-child img {
1552
+ max-width: none;
1553
+ }
1554
+ .colist td:not([class]):last-child {
1555
+ padding: 0.25em 0;
1556
+ }
1557
+ .thumb,
1558
+ .th {
1559
+ line-height: 0;
1560
+ display: inline-block;
1561
+ border: 4px solid #fff;
1562
+ box-shadow: 0 0 0 1px #ddd;
1563
+ }
1564
+ .imageblock.left {
1565
+ margin: 0.25em 0.625em 1.25em 0;
1566
+ }
1567
+ .imageblock.right {
1568
+ margin: 0.25em 0 1.25em 0.625em;
1569
+ }
1570
+ .imageblock > .title {
1571
+ margin-bottom: 0;
1572
+ }
1573
+ .imageblock.thumb,
1574
+ .imageblock.th {
1575
+ border-width: 6px;
1576
+ }
1577
+ .imageblock.thumb > .title,
1578
+ .imageblock.th > .title {
1579
+ padding: 0 0.125em;
1580
+ }
1581
+ .image.left,
1582
+ .image.right {
1583
+ margin-top: 0.25em;
1584
+ margin-bottom: 0.25em;
1585
+ display: inline-block;
1586
+ line-height: 0;
1587
+ }
1588
+ .image.left {
1589
+ margin-right: 0.625em;
1590
+ }
1591
+ .image.right {
1592
+ margin-left: 0.625em;
1593
+ }
1594
+ a.image {
1595
+ text-decoration: none;
1596
+ display: inline-block;
1597
+ }
1598
+ a.image object {
1599
+ pointer-events: none;
1600
+ }
1601
+ sup.footnote,
1602
+ sup.footnoteref {
1603
+ font-size: 0.875em;
1604
+ position: static;
1605
+ vertical-align: super;
1606
+ }
1607
+ sup.footnote a,
1608
+ sup.footnoteref a {
1609
+ text-decoration: none;
1610
+ }
1611
+ sup.footnote a:active,
1612
+ sup.footnoteref a:active {
1613
+ text-decoration: underline;
1614
+ }
1615
+ #footnotes {
1616
+ padding-top: 0.75em;
1617
+ padding-bottom: 0.75em;
1618
+ margin-bottom: 0.625em;
1619
+ }
1620
+ #footnotes hr {
1621
+ width: 20%;
1622
+ min-width: 6.25em;
1623
+ margin: -0.25em 0 0.75em;
1624
+ border-width: 1px 0 0;
1625
+ }
1626
+ #footnotes .footnote {
1627
+ padding: 0 0.375em 0 0.225em;
1628
+ line-height: 1.3334;
1629
+ font-size: 0.875em;
1630
+ margin-left: 1.2em;
1631
+ margin-bottom: 0.2em;
1632
+ }
1633
+ #footnotes .footnote a:first-of-type {
1634
+ font-weight: bold;
1635
+ text-decoration: none;
1636
+ margin-left: -1.05em;
1637
+ }
1638
+ #footnotes .footnote:last-of-type {
1639
+ margin-bottom: 0;
1640
+ }
1641
+ #content #footnotes {
1642
+ margin-top: -0.625em;
1643
+ margin-bottom: 0;
1644
+ padding: 0.75em 0;
1645
+ }
1646
+ div.unbreakable {
1647
+ page-break-inside: avoid;
1648
+ }
1649
+ .big {
1650
+ font-size: larger;
1651
+ }
1652
+ .small {
1653
+ font-size: smaller;
1654
+ }
1655
+ .underline {
1656
+ text-decoration: underline;
1657
+ }
1658
+ .overline {
1659
+ text-decoration: overline;
1660
+ }
1661
+ .line-through {
1662
+ text-decoration: line-through;
1663
+ }
1664
+ .aqua {
1665
+ color: #00bfbf;
1666
+ }
1667
+ .aqua-background {
1668
+ background: #00fafa;
1669
+ }
1670
+ .black {
1671
+ color: #000;
1672
+ }
1673
+ .black-background {
1674
+ background: #000;
1675
+ }
1676
+ .blue {
1677
+ color: #0000bf;
1678
+ }
1679
+ .blue-background {
1680
+ background: #0000fa;
1681
+ }
1682
+ .fuchsia {
1683
+ color: #bf00bf;
1684
+ }
1685
+ .fuchsia-background {
1686
+ background: #fa00fa;
1687
+ }
1688
+ .gray {
1689
+ color: #606060;
1690
+ }
1691
+ .gray-background {
1692
+ background: #7d7d7d;
1693
+ }
1694
+ .green {
1695
+ color: #006000;
1696
+ }
1697
+ .green-background {
1698
+ background: #007d00;
1699
+ }
1700
+ .lime {
1701
+ color: #00bf00;
1702
+ }
1703
+ .lime-background {
1704
+ background: #00fa00;
1705
+ }
1706
+ .maroon {
1707
+ color: #600000;
1708
+ }
1709
+ .maroon-background {
1710
+ background: #7d0000;
1711
+ }
1712
+ .navy {
1713
+ color: #000060;
1714
+ }
1715
+ .navy-background {
1716
+ background: #00007d;
1717
+ }
1718
+ .olive {
1719
+ color: #606000;
1720
+ }
1721
+ .olive-background {
1722
+ background: #7d7d00;
1723
+ }
1724
+ .purple {
1725
+ color: #600060;
1726
+ }
1727
+ .purple-background {
1728
+ background: #7d007d;
1729
+ }
1730
+ .red {
1731
+ color: #bf0000;
1732
+ }
1733
+ .red-background {
1734
+ background: #fa0000;
1735
+ }
1736
+ .silver {
1737
+ color: #909090;
1738
+ }
1739
+ .silver-background {
1740
+ background: #bcbcbc;
1741
+ }
1742
+ .teal {
1743
+ color: #006060;
1744
+ }
1745
+ .teal-background {
1746
+ background: #007d7d;
1747
+ }
1748
+ .white {
1749
+ color: #bfbfbf;
1750
+ }
1751
+ .white-background {
1752
+ background: #fafafa;
1753
+ }
1754
+ .yellow {
1755
+ color: #bfbf00;
1756
+ }
1757
+ .yellow-background {
1758
+ background: #fafa00;
1759
+ }
1760
+ span.icon > .fa {
1761
+ cursor: default;
1762
+ }
1763
+ a span.icon > .fa {
1764
+ cursor: inherit;
1765
+ }
1766
+ .admonitionblock td.icon [class^='fa icon-'] {
1767
+ font-size: 2.5em;
1768
+ text-shadow: 1px 1px 2px rgba(0, 0, 0, 0.5);
1769
+ cursor: default;
1770
+ }
1771
+ .admonitionblock td.icon .icon-note::before {
1772
+ content: '\f05a';
1773
+ color: #19407c;
1774
+ }
1775
+ .admonitionblock td.icon .icon-tip::before {
1776
+ content: '\f0eb';
1777
+ text-shadow: 1px 1px 2px rgba(155, 155, 0, 0.8);
1778
+ color: #111;
1779
+ }
1780
+ .admonitionblock td.icon .icon-warning::before {
1781
+ content: '\f071';
1782
+ color: #bf6900;
1783
+ }
1784
+ .admonitionblock td.icon .icon-caution::before {
1785
+ content: '\f06d';
1786
+ color: #bf3400;
1787
+ }
1788
+ .admonitionblock td.icon .icon-important::before {
1789
+ content: '\f06a';
1790
+ color: #bf0000;
1791
+ }
1792
+ .conum[data-value] {
1793
+ display: inline-block;
1794
+ color: #fff !important;
1795
+ background: rgba(0, 0, 0, 0.8);
1796
+ border-radius: 50%;
1797
+ text-align: center;
1798
+ font-size: 0.75em;
1799
+ width: 1.67em;
1800
+ height: 1.67em;
1801
+ line-height: 1.67em;
1802
+ font-family: 'Open Sans', 'DejaVu Sans', sans-serif;
1803
+ font-style: normal;
1804
+ font-weight: bold;
1805
+ }
1806
+ .conum[data-value] * {
1807
+ color: #fff !important;
1808
+ }
1809
+ .conum[data-value] + b {
1810
+ display: none;
1811
+ }
1812
+ .conum[data-value]::after {
1813
+ content: attr(data-value);
1814
+ }
1815
+ pre .conum[data-value] {
1816
+ position: relative;
1817
+ top: -0.125em;
1818
+ }
1819
+ b.conum * {
1820
+ color: inherit !important;
1821
+ }
1822
+ .conum:not([data-value]):empty {
1823
+ display: none;
1824
+ }
1825
+ dt,
1826
+ th.tableblock,
1827
+ td.content,
1828
+ div.footnote {
1829
+ text-rendering: optimizeLegibility;
1830
+ }
1831
+ h1,
1832
+ h2,
1833
+ p,
1834
+ td.content,
1835
+ span.alt,
1836
+ summary {
1837
+ letter-spacing: -0.01em;
1838
+ }
1839
+ p strong,
1840
+ td.content strong,
1841
+ div.footnote strong {
1842
+ letter-spacing: -0.005em;
1843
+ }
1844
+ p,
1845
+ blockquote,
1846
+ dt,
1847
+ td.content,
1848
+ td.hdlist1,
1849
+ span.alt,
1850
+ summary {
1851
+ font-size: 1.0625rem;
1852
+ }
1853
+ p {
1854
+ margin-bottom: 1.25rem;
1855
+ }
1856
+ .sidebarblock p,
1857
+ .sidebarblock dt,
1858
+ .sidebarblock td.content,
1859
+ p.tableblock {
1860
+ font-size: 1em;
1861
+ }
1862
+ .exampleblock > .content {
1863
+ background: #fffef7;
1864
+ border-color: #e0e0dc;
1865
+ box-shadow: 0 1px 4px #e0e0dc;
1866
+ }
1867
+ .print-only {
1868
+ display: none !important;
1869
+ }
1870
+ @page {
1871
+ margin: 1.25cm 0.75cm;
1872
+ }
1873
+ @media print {
1874
+ * {
1875
+ box-shadow: none !important;
1876
+ text-shadow: none !important;
1877
+ }
1878
+ html {
1879
+ font-size: 80%;
1880
+ }
1881
+ a {
1882
+ color: inherit !important;
1883
+ text-decoration: underline !important;
1884
+ }
1885
+ a.bare,
1886
+ a[href^='#'],
1887
+ a[href^='mailto:'] {
1888
+ text-decoration: none !important;
1889
+ }
1890
+ a[href^='http:']:not(.bare)::after,
1891
+ a[href^='https:']:not(.bare)::after {
1892
+ content: '(' attr(href) ')';
1893
+ display: inline-block;
1894
+ font-size: 0.875em;
1895
+ padding-left: 0.25em;
1896
+ }
1897
+ abbr[title] {
1898
+ border-bottom: 1px dotted;
1899
+ }
1900
+ abbr[title]::after {
1901
+ content: ' (' attr(title) ')';
1902
+ }
1903
+ pre,
1904
+ blockquote,
1905
+ tr,
1906
+ img,
1907
+ object,
1908
+ svg {
1909
+ page-break-inside: avoid;
1910
+ }
1911
+ thead {
1912
+ display: table-header-group;
1913
+ }
1914
+ svg {
1915
+ max-width: 100%;
1916
+ }
1917
+ p,
1918
+ blockquote,
1919
+ dt,
1920
+ td.content {
1921
+ font-size: 1em;
1922
+ orphans: 3;
1923
+ widows: 3;
1924
+ }
1925
+ h2,
1926
+ h3,
1927
+ #toctitle,
1928
+ .sidebarblock > .content > .title {
1929
+ page-break-after: avoid;
1930
+ }
1931
+ #header,
1932
+ #content,
1933
+ #footnotes,
1934
+ #footer {
1935
+ max-width: none;
1936
+ }
1937
+ #toc,
1938
+ .sidebarblock,
1939
+ .exampleblock > .content {
1940
+ background: none !important;
1941
+ }
1942
+ #toc {
1943
+ border-bottom: 1px solid #dddddf !important;
1944
+ padding-bottom: 0 !important;
1945
+ }
1946
+ body.book #header {
1947
+ text-align: center;
1948
+ }
1949
+ body.book #header > h1:first-child {
1950
+ border: 0 !important;
1951
+ margin: 2.5em 0 1em;
1952
+ }
1953
+ body.book #header .details {
1954
+ border: 0 !important;
1955
+ display: block;
1956
+ padding: 0 !important;
1957
+ }
1958
+ body.book #header .details span:first-child {
1959
+ margin-left: 0 !important;
1960
+ }
1961
+ body.book #header .details br {
1962
+ display: block;
1963
+ }
1964
+ body.book #header .details br + span::before {
1965
+ content: none !important;
1966
+ }
1967
+ body.book #toc {
1968
+ border: 0 !important;
1969
+ text-align: left !important;
1970
+ padding: 0 !important;
1971
+ margin: 0 !important;
1972
+ }
1973
+ body.book #toc,
1974
+ body.book #preamble,
1975
+ body.book h1.sect0,
1976
+ body.book .sect1 > h2 {
1977
+ page-break-before: always;
1978
+ }
1979
+ .listingblock code[data-lang]::before {
1980
+ display: block;
1981
+ }
1982
+ #footer {
1983
+ padding: 0 0.9375em;
1984
+ }
1985
+ .hide-on-print {
1986
+ display: none !important;
1987
+ }
1988
+ .print-only {
1989
+ display: block !important;
1990
+ }
1991
+ .hide-for-print {
1992
+ display: none !important;
1993
+ }
1994
+ .show-for-print {
1995
+ display: inherit !important;
1996
+ }
1997
+ }
1998
+ @media amzn-kf8, print {
1999
+ #header > h1:first-child {
2000
+ margin-top: 1.25rem;
2001
+ }
2002
+ .sect1 {
2003
+ padding: 0 !important;
2004
+ }
2005
+ .sect1 + .sect1 {
2006
+ border: 0;
2007
+ }
2008
+ #footer {
2009
+ background: none;
2010
+ }
2011
+ #footer-text {
2012
+ color: rgba(0, 0, 0, 0.6);
2013
+ font-size: 0.9em;
2014
+ }
2015
+ }
2016
+ @media amzn-kf8 {
2017
+ #header,
2018
+ #content,
2019
+ #footnotes,
2020
+ #footer {
2021
+ padding: 0;
2022
+ }
2023
+ }
2024
+ </style>
2025
+ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" />
2026
+ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/styles/github.min.css" />
2027
+ </head>
2028
+ <body class="article toc2 toc-left">
2029
+ <div id="header">
2030
+ <h1>GameControl Module Reference</h1>
2031
+ <div id="toc" class="toc2">
2032
+ <div id="toctitle">Table of Contents</div>
2033
+ <ul class="sectlevel1">
2034
+ <li><a href="#architectural-purpose">1. Architectural Purpose</a></li>
2035
+ <li><a href="#supported-keys-controlkey">2. Supported Keys (<code>ControlKey</code>)</a></li>
2036
+ <li>
2037
+ <a href="#api-reference">3. API Reference</a>
2038
+ <ul class="sectlevel2">
2039
+ <li>
2040
+ <a href="#subscribekey-controlkey-type-controleventtype-callback-controlcallback-void"
2041
+ >3.1. <code>subscribe(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2042
+ >
2043
+ </li>
2044
+ <li>
2045
+ <a href="#unsubscribekey-controlkey-type-controleventtype-callback-controlcallback-void"
2046
+ >3.2. <code>unsubscribe(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2047
+ >
2048
+ </li>
2049
+ <li>
2050
+ <a href="#subscribefortitlescreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2051
+ >3.3. <code>subscribeForTitleScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2052
+ >
2053
+ </li>
2054
+ <li>
2055
+ <a href="#unsubscribefortitlescreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2056
+ >3.4. <code>unsubscribeForTitleScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2057
+ >
2058
+ </li>
2059
+ <li>
2060
+ <a href="#subscribeforgameoverscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2061
+ >3.5. <code>subscribeForGameOverScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2062
+ >
2063
+ </li>
2064
+ <li>
2065
+ <a href="#unsubscribeforgameoverscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2066
+ >3.6. <code>unsubscribeForGameOverScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2067
+ >
2068
+ </li>
2069
+ <li>
2070
+ <a href="#subscribeforplayingscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2071
+ >3.7. <code>subscribeForPlayingScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2072
+ >
2073
+ </li>
2074
+ <li>
2075
+ <a href="#unsubscribeforplayingscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2076
+ >3.8. <code>unsubscribeForPlayingScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2077
+ >
2078
+ </li>
2079
+ <li>
2080
+ <a href="#subscribeforpausedscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2081
+ >3.9. <code>subscribeForPausedScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2082
+ >
2083
+ </li>
2084
+ <li>
2085
+ <a href="#unsubscribeforpausedscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2086
+ >3.10. <code>unsubscribeForPausedScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2087
+ >
2088
+ </li>
2089
+ <li>
2090
+ <a href="#bindcontrols-void">3.11. <code>bindControls(): void</code></a>
2091
+ </li>
2092
+ <li>
2093
+ <a href="#unbindcontrols-void">3.12. <code>unbindControls(): void</code></a>
2094
+ </li>
2095
+ <li>
2096
+ <a href="#notifykey-controlkey-type-controleventtype-void"
2097
+ >3.13. <code>notify(key: ControlKey, type: ControlEventType): void</code></a
2098
+ >
2099
+ </li>
2100
+ <li>
2101
+ <a href="#getdebugdata-recordstring-string-number-boolean"
2102
+ >3.14. <code>getDebugData(): Record&lt;string, string | number | boolean&gt;</code></a
2103
+ >
2104
+ </li>
2105
+ </ul>
2106
+ </li>
2107
+ </ul>
2108
+ </div>
2109
+ </div>
2110
+ <div id="content">
2111
+ <div class="sect1">
2112
+ <h2 id="architectural-purpose"><a class="link" href="#architectural-purpose">1. Architectural Purpose</a></h2>
2113
+ <div class="sectionbody">
2114
+ <div class="paragraph">
2115
+ <p>
2116
+ The <code>GameControl</code> module functions as the central event bus translating physical browser and hardware DOM inputs into
2117
+ abstract game behaviors. It encapsulates raw environment listeners so distinct module parts can effortlessly subscribe to simplified
2118
+ <code><a href="../enums/ControlKey.html">ControlKey</a></code> hooks. Vitally, it centrally gates input propagation depending
2119
+ intelligently on the global engine <code><a href="GameState.html">GameState</a></code> (e.g. blocking game keys while in modals).
2120
+ </p>
2121
+ </div>
2122
+ </div>
2123
+ </div>
2124
+ <div class="sect1">
2125
+ <h2 id="supported-keys-controlkey"><a class="link" href="#supported-keys-controlkey">2. Supported Keys (<code>ControlKey</code>)</a></h2>
2126
+ <div class="sectionbody">
2127
+ <div class="paragraph">
2128
+ <p>The engine maps physical keys to virtual engine keys:</p>
2129
+ </div>
2130
+ <div class="ulist">
2131
+ <ul>
2132
+ <li>
2133
+ <p>
2134
+ <code><a href="../enums/ControlKey.html">UP</a></code> / <code><a href="../enums/ControlKey.html">DOWN</a></code> /
2135
+ <code><a href="../enums/ControlKey.html">LEFT</a></code> / <code><a href="../enums/ControlKey.html">RIGHT</a></code
2136
+ >: Directional controls.
2137
+ </p>
2138
+ </li>
2139
+ <li>
2140
+ <p>
2141
+ <code><a href="../enums/ControlKey.html">ACTION</a></code
2142
+ >: Primary action button.
2143
+ </p>
2144
+ </li>
2145
+ <li>
2146
+ <p>
2147
+ <code><a href="../enums/ControlKey.html">START_PAUSE</a></code
2148
+ >: Toggles game start/pause.
2149
+ </p>
2150
+ </li>
2151
+ <li>
2152
+ <p>
2153
+ <code><a href="../enums/ControlKey.html">RESET</a></code
2154
+ >: Soft reset of the game session.
2155
+ </p>
2156
+ </li>
2157
+ <li>
2158
+ <p>
2159
+ <code><a href="../enums/ControlKey.html">SOUND</a></code
2160
+ >: Toggles master audio mute.
2161
+ </p>
2162
+ </li>
2163
+ <li>
2164
+ <p>
2165
+ <code><a href="../enums/ControlKey.html">COLOR</a></code
2166
+ >: Toggles theme color mode.
2167
+ </p>
2168
+ </li>
2169
+ <li>
2170
+ <p>
2171
+ <code><a href="../enums/ControlKey.html">POWER</a></code
2172
+ >: Main engine power toggle.
2173
+ </p>
2174
+ </li>
2175
+ <li>
2176
+ <p>
2177
+ <code><a href="../enums/ControlKey.html">EXIT</a></code
2178
+ >: Hard stop of the engine.
2179
+ </p>
2180
+ </li>
2181
+ </ul>
2182
+ </div>
2183
+ <hr />
2184
+ </div>
2185
+ </div>
2186
+ <div class="sect1">
2187
+ <h2 id="api-reference"><a class="link" href="#api-reference">3. API Reference</a></h2>
2188
+ <div class="sectionbody">
2189
+ <div class="sect2">
2190
+ <h3 id="subscribekey-controlkey-type-controleventtype-callback-controlcallback-void">
2191
+ <a class="link" href="#subscribekey-controlkey-type-controleventtype-callback-controlcallback-void"
2192
+ >3.1. <code>subscribe(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2193
+ >
2194
+ </h3>
2195
+ <div class="paragraph">
2196
+ <p>Registers a callback for a specific input event.</p>
2197
+ </div>
2198
+ <div class="paragraph">
2199
+ <p><strong>Parameters</strong></p>
2200
+ </div>
2201
+ <table class="tableblock frame-all grid-all stretch">
2202
+ <colgroup>
2203
+ <col style="width: 20%" />
2204
+ <col style="width: 20%" />
2205
+ <col style="width: 60%" />
2206
+ </colgroup>
2207
+ <tbody>
2208
+ <tr>
2209
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
2210
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
2211
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
2212
+ </tr>
2213
+ <tr>
2214
+ <td class="tableblock halign-left valign-top">
2215
+ <p class="tableblock"><code>key</code></p>
2216
+ </td>
2217
+ <td class="tableblock halign-left valign-top">
2218
+ <p class="tableblock">
2219
+ <code><a href="../enums/ControlKey.html">ControlKey</a></code>
2220
+ </p>
2221
+ </td>
2222
+ <td class="tableblock halign-left valign-top">
2223
+ <p class="tableblock">
2224
+ The explicit abstract virtual key string mapping to monitor cleanly (e.g., <code>ControlKey.ACTION</code>).
2225
+ </p>
2226
+ </td>
2227
+ </tr>
2228
+ <tr>
2229
+ <td class="tableblock halign-left valign-top">
2230
+ <p class="tableblock"><code>type</code></p>
2231
+ </td>
2232
+ <td class="tableblock halign-left valign-top">
2233
+ <p class="tableblock">
2234
+ <code><a href="../enums/ControlEventType.html">ControlEventType</a></code>
2235
+ </p>
2236
+ </td>
2237
+ <td class="tableblock halign-left valign-top">
2238
+ <p class="tableblock">The lifecycle trigger distinction (<code>PRESSED</code> or <code>HELD</code>).</p>
2239
+ </td>
2240
+ </tr>
2241
+ <tr>
2242
+ <td class="tableblock halign-left valign-top">
2243
+ <p class="tableblock"><code>callback</code></p>
2244
+ </td>
2245
+ <td class="tableblock halign-left valign-top">
2246
+ <p class="tableblock">
2247
+ <code><a href="../types/ControlCallback.html">ControlCallback</a></code>
2248
+ </p>
2249
+ </td>
2250
+ <td class="tableblock halign-left valign-top">
2251
+ <p class="tableblock">The injected execution sequence called securely when the payload completes.</p>
2252
+ </td>
2253
+ </tr>
2254
+ </tbody>
2255
+ </table>
2256
+ <div class="paragraph">
2257
+ <p><strong>Behavior</strong></p>
2258
+ </div>
2259
+ <div class="paragraph">
2260
+ <p>Adds the callback to the internal subscription list. Multiple callbacks can be registered for the same key/type combination.</p>
2261
+ </div>
2262
+ <div class="paragraph">
2263
+ <p><strong>Example</strong></p>
2264
+ </div>
2265
+ <div class="listingblock">
2266
+ <div class="content">
2267
+ <pre
2268
+ class="highlightjs highlight"
2269
+ ><code class="language-typescript hljs" data-lang="typescript">control.subscribe(ControlKey.ACTION, ControlEventType.PRESSED, (event) =&gt; {
567
2270
  console.log('Action button pressed!');
568
2271
  });</code></pre>
569
- </div>
570
- </div>
571
- <hr>
572
- </div>
573
- <div class="sect2">
574
- <h3 id="unsubscribekey-controlkey-type-controleventtype-callback-controlcallback-void"><a class="link" href="#unsubscribekey-controlkey-type-controleventtype-callback-controlcallback-void">3.2. <code>unsubscribe(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></h3>
575
- <div class="paragraph">
576
- <p>Removes an existing subscription.</p>
577
- </div>
578
- <div class="paragraph">
579
- <p><strong>Parameters</strong></p>
580
- </div>
581
- <table class="tableblock frame-all grid-all stretch">
582
- <colgroup>
583
- <col style="width: 20%;">
584
- <col style="width: 20%;">
585
- <col style="width: 60%;">
586
- </colgroup>
587
- <tbody>
588
- <tr>
589
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
590
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
591
- <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
592
- </tr>
593
- <tr>
594
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>key</code></p></td>
595
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/ControlKey.html">ControlKey</a></code></p></td>
596
- <td class="tableblock halign-left valign-top"><p class="tableblock">The registered virtual key name.</p></td>
597
- </tr>
598
- <tr>
599
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>type</code></p></td>
600
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/ControlEventType.html">ControlEventType</a></code></p></td>
601
- <td class="tableblock halign-left valign-top"><p class="tableblock">The exact behavior trigger.</p></td>
602
- </tr>
603
- <tr>
604
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>callback</code></p></td>
605
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../types/ControlCallback.html">ControlCallback</a></code></p></td>
606
- <td class="tableblock halign-left valign-top"><p class="tableblock">The exact memory reference mapping previously used to construct the subscription block.</p></td>
607
- </tr>
608
- </tbody>
609
- </table>
610
- <div class="paragraph">
611
- <p><strong>Behavior</strong></p>
612
- </div>
613
- <div class="paragraph">
614
- <p>Removes the specified callback from the central <code><a href="EventEmitter.html">EventEmitter</a></code>. If the callback is not found, the operation does nothing.</p>
615
- </div>
616
- <hr>
617
- </div>
618
- <div class="sect2">
619
- <h3 id="subscribefortitlescreenkey-controlkey-type-controleventtype-callback-controlcallback-void"><a class="link" href="#subscribefortitlescreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.3. <code>subscribeForTitleScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></h3>
620
- <div class="paragraph">
621
- <p>Registers a callback for a specific input event ONLY when the game is on the Title Screen.</p>
622
- </div>
623
- <div class="paragraph">
624
- <p><strong>Parameters</strong></p>
625
- </div>
626
- <table class="tableblock frame-all grid-all stretch">
627
- <colgroup>
628
- <col style="width: 20%;">
629
- <col style="width: 20%;">
630
- <col style="width: 60%;">
631
- </colgroup>
632
- <tbody>
633
- <tr>
634
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
635
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
636
- <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
637
- </tr>
638
- <tr>
639
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>key</code></p></td>
640
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/ControlKey.html">ControlKey</a></code></p></td>
641
- <td class="tableblock halign-left valign-top"><p class="tableblock">The virtual key to monitor.</p></td>
642
- </tr>
643
- <tr>
644
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>type</code></p></td>
645
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/ControlEventType.html">ControlEventType</a></code></p></td>
646
- <td class="tableblock halign-left valign-top"><p class="tableblock">The type of trigger.</p></td>
647
- </tr>
648
- <tr>
649
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>callback</code></p></td>
650
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../types/ControlCallback.html">ControlCallback</a></code></p></td>
651
- <td class="tableblock halign-left valign-top"><p class="tableblock">The function to execute.</p></td>
652
- </tr>
653
- </tbody>
654
- </table>
655
- <hr>
656
- </div>
657
- <div class="sect2">
658
- <h3 id="unsubscribefortitlescreenkey-controlkey-type-controleventtype-callback-controlcallback-void"><a class="link" href="#unsubscribefortitlescreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.4. <code>unsubscribeForTitleScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></h3>
659
- <div class="paragraph">
660
- <p>Removes an existing Title Screen subscription.</p>
661
- </div>
662
- <hr>
663
- </div>
664
- <div class="sect2">
665
- <h3 id="subscribeforgameoverscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"><a class="link" href="#subscribeforgameoverscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.5. <code>subscribeForGameOverScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></h3>
666
- <div class="paragraph">
667
- <p>Registers a callback for a specific input event ONLY when the game is on the Game Over Screen.</p>
668
- </div>
669
- <div class="paragraph">
670
- <p><strong>Parameters</strong></p>
671
- </div>
672
- <table class="tableblock frame-all grid-all stretch">
673
- <colgroup>
674
- <col style="width: 20%;">
675
- <col style="width: 20%;">
676
- <col style="width: 60%;">
677
- </colgroup>
678
- <tbody>
679
- <tr>
680
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
681
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
682
- <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
683
- </tr>
684
- <tr>
685
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>key</code></p></td>
686
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/ControlKey.html">ControlKey</a></code></p></td>
687
- <td class="tableblock halign-left valign-top"><p class="tableblock">The virtual key to monitor.</p></td>
688
- </tr>
689
- <tr>
690
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>type</code></p></td>
691
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/ControlEventType.html">ControlEventType</a></code></p></td>
692
- <td class="tableblock halign-left valign-top"><p class="tableblock">The type of trigger.</p></td>
693
- </tr>
694
- <tr>
695
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>callback</code></p></td>
696
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../types/ControlCallback.html">ControlCallback</a></code></p></td>
697
- <td class="tableblock halign-left valign-top"><p class="tableblock">The function to execute.</p></td>
698
- </tr>
699
- </tbody>
700
- </table>
701
- <hr>
702
- </div>
703
- <div class="sect2">
704
- <h3 id="unsubscribeforgameoverscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"><a class="link" href="#unsubscribeforgameoverscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.6. <code>unsubscribeForGameOverScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></h3>
705
- <div class="paragraph">
706
- <p>Removes an existing Game Over Screen subscription.</p>
707
- </div>
708
- <hr>
709
- </div>
710
- <div class="sect2">
711
- <h3 id="subscribeforplayingscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"><a class="link" href="#subscribeforplayingscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.7. <code>subscribeForPlayingScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></h3>
712
- <div class="paragraph">
713
- <p>Registers a callback for a specific input event ONLY during active gameplay. This is functionally equivalent to <code>subscribe</code> for control keys, but provides explicit intent.</p>
714
- </div>
715
- <hr>
716
- </div>
717
- <div class="sect2">
718
- <h3 id="unsubscribeforplayingscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"><a class="link" href="#unsubscribeforplayingscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.8. <code>unsubscribeForPlayingScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></h3>
719
- <div class="paragraph">
720
- <p>Removes an existing Playing Screen subscription.</p>
721
- </div>
722
- <hr>
723
- </div>
724
- <div class="sect2">
725
- <h3 id="subscribeforpausedscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"><a class="link" href="#subscribeforpausedscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.9. <code>subscribeForPausedScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></h3>
726
- <div class="paragraph">
727
- <p>Registers a callback for a specific input event ONLY when the game is in a Paused state.</p>
728
- </div>
729
- <div class="paragraph">
730
- <p><strong>Parameters</strong></p>
731
- </div>
732
- <table class="tableblock frame-all grid-all stretch">
733
- <colgroup>
734
- <col style="width: 20%;">
735
- <col style="width: 20%;">
736
- <col style="width: 60%;">
737
- </colgroup>
738
- <tbody>
739
- <tr>
740
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
741
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
742
- <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
743
- </tr>
744
- <tr>
745
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>key</code></p></td>
746
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/ControlKey.html">ControlKey</a></code></p></td>
747
- <td class="tableblock halign-left valign-top"><p class="tableblock">The virtual key to monitor.</p></td>
748
- </tr>
749
- <tr>
750
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>type</code></p></td>
751
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/ControlEventType.html">ControlEventType</a></code></p></td>
752
- <td class="tableblock halign-left valign-top"><p class="tableblock">The type of trigger.</p></td>
753
- </tr>
754
- <tr>
755
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>callback</code></p></td>
756
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../types/ControlCallback.html">ControlCallback</a></code></p></td>
757
- <td class="tableblock halign-left valign-top"><p class="tableblock">The function to execute.</p></td>
758
- </tr>
759
- </tbody>
760
- </table>
761
- <hr>
762
- </div>
763
- <div class="sect2">
764
- <h3 id="unsubscribeforpausedscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"><a class="link" href="#unsubscribeforpausedscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">3.10. <code>unsubscribeForPausedScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a></h3>
765
- <div class="paragraph">
766
- <p>Removes an existing Paused Screen subscription.</p>
767
- </div>
768
- <hr>
769
- </div>
770
- <div class="sect2">
771
- <h3 id="bindcontrols-void"><a class="link" href="#bindcontrols-void">3.11. <code>bindControls(): void</code></a></h3>
772
- <div class="paragraph">
773
- <p>Attaches low-level event listeners to the environment.</p>
774
- </div>
775
- <div class="paragraph">
776
- <p><strong>Behavior</strong></p>
777
- </div>
778
- <div class="paragraph">
779
- <p>Enables keyboard and button listeners. This is called automatically by the engine during setup.</p>
780
- </div>
781
- <hr>
782
- </div>
783
- <div class="sect2">
784
- <h3 id="unbindcontrols-void"><a class="link" href="#unbindcontrols-void">3.12. <code>unbindControls(): void</code></a></h3>
785
- <div class="paragraph">
786
- <p>Detaches all input listeners and clears subscriptions.</p>
787
- </div>
788
- <div class="paragraph">
789
- <p><strong>Behavior</strong></p>
790
- </div>
791
- <div class="paragraph">
792
- <p>Removes all low-level event listeners and wipes the internal subscription map. Called automatically during engine destruction.</p>
793
- </div>
794
- <hr>
795
- </div>
796
- <div class="sect2">
797
- <h3 id="notifykey-controlkey-type-controleventtype-void"><a class="link" href="#notifykey-controlkey-type-controleventtype-void">3.13. <code>notify(key: ControlKey, type: ControlEventType): void</code></a></h3>
798
- <div class="paragraph">
799
- <p>Manually triggers an input event.</p>
800
- </div>
801
- <div class="paragraph">
802
- <p><strong>Parameters</strong></p>
803
- </div>
804
- <table class="tableblock frame-all grid-all stretch">
805
- <colgroup>
806
- <col style="width: 20%;">
807
- <col style="width: 20%;">
808
- <col style="width: 60%;">
809
- </colgroup>
810
- <tbody>
811
- <tr>
812
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
813
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
814
- <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
815
- </tr>
816
- <tr>
817
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>key</code></p></td>
818
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/ControlKey.html">ControlKey</a></code></p></td>
819
- <td class="tableblock halign-left valign-top"><p class="tableblock">The exact abstracted key intent generating the signal.</p></td>
820
- </tr>
821
- <tr>
822
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>type</code></p></td>
823
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/ControlEventType.html">ControlEventType</a></code></p></td>
824
- <td class="tableblock halign-left valign-top"><p class="tableblock">The physical user behavior type causing the event (e.g., <code>PRESSED</code>).</p></td>
825
- </tr>
826
- </tbody>
827
- </table>
828
- <div class="paragraph">
829
- <p><strong>Behavior</strong></p>
830
- </div>
831
- <div class="paragraph">
832
- <p>Executes all callbacks associated with the given key and event type, subject to the following logic:</p>
833
- </div>
834
- <div class="ulist">
835
- <ul>
836
- <li>
837
- <p><strong>Session Modal / Unresolved (<code>isModalOpen() || !isSessionResolved()</code>)</strong>: All inputs are BLOCKED to prevent interactions while the user is making a session restoration choice via the <code><a href="../interfaces/modules/Session.html">Session</a></code> module.</p>
838
- </li>
839
- <li>
840
- <p><strong>System Off (<code>isOff()</code>)</strong>: Only the <code><a href="../enums/ControlKey.html">POWER</a></code> key is processed. All other keys are ignored.</p>
841
- </li>
842
- <li>
843
- <p><strong>Active States (<code>!isStarted() || isPlaying() || isGameOver()</code>)</strong>: All keys are processed normally.</p>
844
- </li>
845
- <li>
846
- <p><strong>Paused State (<code>isPaused()</code>)</strong>: Only system keys (e.g., <code>START_PAUSE</code>, <code>SOUND</code>, <code>COLOR</code>, <code>RESET</code>, <code>EXIT</code>) are processed. Gameplay keys are ignored.</p>
847
- </li>
848
- </ul>
849
- </div>
850
- <div class="paragraph">
851
- <p><strong>Throws an error</strong> if the game modules have not been initialized.</p>
852
- </div>
853
- <hr>
854
- </div>
855
- <div class="sect2">
856
- <h3 id="getdebugdata-recordstring-string-number-boolean"><a class="link" href="#getdebugdata-recordstring-string-number-boolean">3.14. <code>getDebugData(): Record&lt;string, string | number | boolean&gt;</code></a></h3>
857
- <div class="paragraph">
858
- <p>Returns metadata for the real-time debugger.</p>
859
- </div>
860
- <div class="paragraph">
861
- <p><strong>Returns</strong></p>
862
- </div>
863
- <div class="paragraph">
864
- <p><code>Record&lt;string, string | number | boolean&gt;</code> - Object containing the number of <code>total_subscribers</code> and <code>tracked_keys</code>.</p>
865
- </div>
866
- </div>
867
- </div>
868
- </div>
869
- </div>
870
- <div id="footer">
871
- <div id="footer-text">
872
- </div>
873
- </div>
874
- <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
875
- <script>
876
- if (!hljs.initHighlighting.called) {
877
- hljs.initHighlighting.called = true
878
- ;[].slice.call(document.querySelectorAll('pre.highlight > code[data-lang]')).forEach(function (el) { hljs.highlightBlock(el) })
879
- }
880
- </script>
881
- </body>
882
- </html>
2272
+ </div>
2273
+ </div>
2274
+ <hr />
2275
+ </div>
2276
+ <div class="sect2">
2277
+ <h3 id="unsubscribekey-controlkey-type-controleventtype-callback-controlcallback-void">
2278
+ <a class="link" href="#unsubscribekey-controlkey-type-controleventtype-callback-controlcallback-void"
2279
+ >3.2. <code>unsubscribe(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2280
+ >
2281
+ </h3>
2282
+ <div class="paragraph">
2283
+ <p>Removes an existing subscription.</p>
2284
+ </div>
2285
+ <div class="paragraph">
2286
+ <p><strong>Parameters</strong></p>
2287
+ </div>
2288
+ <table class="tableblock frame-all grid-all stretch">
2289
+ <colgroup>
2290
+ <col style="width: 20%" />
2291
+ <col style="width: 20%" />
2292
+ <col style="width: 60%" />
2293
+ </colgroup>
2294
+ <tbody>
2295
+ <tr>
2296
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
2297
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
2298
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
2299
+ </tr>
2300
+ <tr>
2301
+ <td class="tableblock halign-left valign-top">
2302
+ <p class="tableblock"><code>key</code></p>
2303
+ </td>
2304
+ <td class="tableblock halign-left valign-top">
2305
+ <p class="tableblock">
2306
+ <code><a href="../enums/ControlKey.html">ControlKey</a></code>
2307
+ </p>
2308
+ </td>
2309
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The registered virtual key name.</p></td>
2310
+ </tr>
2311
+ <tr>
2312
+ <td class="tableblock halign-left valign-top">
2313
+ <p class="tableblock"><code>type</code></p>
2314
+ </td>
2315
+ <td class="tableblock halign-left valign-top">
2316
+ <p class="tableblock">
2317
+ <code><a href="../enums/ControlEventType.html">ControlEventType</a></code>
2318
+ </p>
2319
+ </td>
2320
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The exact behavior trigger.</p></td>
2321
+ </tr>
2322
+ <tr>
2323
+ <td class="tableblock halign-left valign-top">
2324
+ <p class="tableblock"><code>callback</code></p>
2325
+ </td>
2326
+ <td class="tableblock halign-left valign-top">
2327
+ <p class="tableblock">
2328
+ <code><a href="../types/ControlCallback.html">ControlCallback</a></code>
2329
+ </p>
2330
+ </td>
2331
+ <td class="tableblock halign-left valign-top">
2332
+ <p class="tableblock">The exact memory reference mapping previously used to construct the subscription block.</p>
2333
+ </td>
2334
+ </tr>
2335
+ </tbody>
2336
+ </table>
2337
+ <div class="paragraph">
2338
+ <p><strong>Behavior</strong></p>
2339
+ </div>
2340
+ <div class="paragraph">
2341
+ <p>
2342
+ Removes the specified callback from the central <code><a href="EventEmitter.html">EventEmitter</a></code
2343
+ >. If the callback is not found, the operation does nothing.
2344
+ </p>
2345
+ </div>
2346
+ <hr />
2347
+ </div>
2348
+ <div class="sect2">
2349
+ <h3 id="subscribefortitlescreenkey-controlkey-type-controleventtype-callback-controlcallback-void">
2350
+ <a class="link" href="#subscribefortitlescreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2351
+ >3.3. <code>subscribeForTitleScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2352
+ >
2353
+ </h3>
2354
+ <div class="paragraph">
2355
+ <p>Registers a callback for a specific input event ONLY when the game is on the Title Screen.</p>
2356
+ </div>
2357
+ <div class="paragraph">
2358
+ <p><strong>Parameters</strong></p>
2359
+ </div>
2360
+ <table class="tableblock frame-all grid-all stretch">
2361
+ <colgroup>
2362
+ <col style="width: 20%" />
2363
+ <col style="width: 20%" />
2364
+ <col style="width: 60%" />
2365
+ </colgroup>
2366
+ <tbody>
2367
+ <tr>
2368
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
2369
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
2370
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
2371
+ </tr>
2372
+ <tr>
2373
+ <td class="tableblock halign-left valign-top">
2374
+ <p class="tableblock"><code>key</code></p>
2375
+ </td>
2376
+ <td class="tableblock halign-left valign-top">
2377
+ <p class="tableblock">
2378
+ <code><a href="../enums/ControlKey.html">ControlKey</a></code>
2379
+ </p>
2380
+ </td>
2381
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The virtual key to monitor.</p></td>
2382
+ </tr>
2383
+ <tr>
2384
+ <td class="tableblock halign-left valign-top">
2385
+ <p class="tableblock"><code>type</code></p>
2386
+ </td>
2387
+ <td class="tableblock halign-left valign-top">
2388
+ <p class="tableblock">
2389
+ <code><a href="../enums/ControlEventType.html">ControlEventType</a></code>
2390
+ </p>
2391
+ </td>
2392
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The type of trigger.</p></td>
2393
+ </tr>
2394
+ <tr>
2395
+ <td class="tableblock halign-left valign-top">
2396
+ <p class="tableblock"><code>callback</code></p>
2397
+ </td>
2398
+ <td class="tableblock halign-left valign-top">
2399
+ <p class="tableblock">
2400
+ <code><a href="../types/ControlCallback.html">ControlCallback</a></code>
2401
+ </p>
2402
+ </td>
2403
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The function to execute.</p></td>
2404
+ </tr>
2405
+ </tbody>
2406
+ </table>
2407
+ <hr />
2408
+ </div>
2409
+ <div class="sect2">
2410
+ <h3 id="unsubscribefortitlescreenkey-controlkey-type-controleventtype-callback-controlcallback-void">
2411
+ <a class="link" href="#unsubscribefortitlescreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2412
+ >3.4. <code>unsubscribeForTitleScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2413
+ >
2414
+ </h3>
2415
+ <div class="paragraph">
2416
+ <p>Removes an existing Title Screen subscription.</p>
2417
+ </div>
2418
+ <hr />
2419
+ </div>
2420
+ <div class="sect2">
2421
+ <h3 id="subscribeforgameoverscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">
2422
+ <a class="link" href="#subscribeforgameoverscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2423
+ >3.5. <code>subscribeForGameOverScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2424
+ >
2425
+ </h3>
2426
+ <div class="paragraph">
2427
+ <p>Registers a callback for a specific input event ONLY when the game is on the Game Over Screen.</p>
2428
+ </div>
2429
+ <div class="paragraph">
2430
+ <p><strong>Parameters</strong></p>
2431
+ </div>
2432
+ <table class="tableblock frame-all grid-all stretch">
2433
+ <colgroup>
2434
+ <col style="width: 20%" />
2435
+ <col style="width: 20%" />
2436
+ <col style="width: 60%" />
2437
+ </colgroup>
2438
+ <tbody>
2439
+ <tr>
2440
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
2441
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
2442
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
2443
+ </tr>
2444
+ <tr>
2445
+ <td class="tableblock halign-left valign-top">
2446
+ <p class="tableblock"><code>key</code></p>
2447
+ </td>
2448
+ <td class="tableblock halign-left valign-top">
2449
+ <p class="tableblock">
2450
+ <code><a href="../enums/ControlKey.html">ControlKey</a></code>
2451
+ </p>
2452
+ </td>
2453
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The virtual key to monitor.</p></td>
2454
+ </tr>
2455
+ <tr>
2456
+ <td class="tableblock halign-left valign-top">
2457
+ <p class="tableblock"><code>type</code></p>
2458
+ </td>
2459
+ <td class="tableblock halign-left valign-top">
2460
+ <p class="tableblock">
2461
+ <code><a href="../enums/ControlEventType.html">ControlEventType</a></code>
2462
+ </p>
2463
+ </td>
2464
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The type of trigger.</p></td>
2465
+ </tr>
2466
+ <tr>
2467
+ <td class="tableblock halign-left valign-top">
2468
+ <p class="tableblock"><code>callback</code></p>
2469
+ </td>
2470
+ <td class="tableblock halign-left valign-top">
2471
+ <p class="tableblock">
2472
+ <code><a href="../types/ControlCallback.html">ControlCallback</a></code>
2473
+ </p>
2474
+ </td>
2475
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The function to execute.</p></td>
2476
+ </tr>
2477
+ </tbody>
2478
+ </table>
2479
+ <hr />
2480
+ </div>
2481
+ <div class="sect2">
2482
+ <h3 id="unsubscribeforgameoverscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">
2483
+ <a class="link" href="#unsubscribeforgameoverscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2484
+ >3.6. <code>unsubscribeForGameOverScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2485
+ >
2486
+ </h3>
2487
+ <div class="paragraph">
2488
+ <p>Removes an existing Game Over Screen subscription.</p>
2489
+ </div>
2490
+ <hr />
2491
+ </div>
2492
+ <div class="sect2">
2493
+ <h3 id="subscribeforplayingscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">
2494
+ <a class="link" href="#subscribeforplayingscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2495
+ >3.7. <code>subscribeForPlayingScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2496
+ >
2497
+ </h3>
2498
+ <div class="paragraph">
2499
+ <p>
2500
+ Registers a callback for a specific input event ONLY during active gameplay. This is functionally equivalent to
2501
+ <code>subscribe</code> for control keys, but provides explicit intent.
2502
+ </p>
2503
+ </div>
2504
+ <hr />
2505
+ </div>
2506
+ <div class="sect2">
2507
+ <h3 id="unsubscribeforplayingscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">
2508
+ <a class="link" href="#unsubscribeforplayingscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2509
+ >3.8. <code>unsubscribeForPlayingScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2510
+ >
2511
+ </h3>
2512
+ <div class="paragraph">
2513
+ <p>Removes an existing Playing Screen subscription.</p>
2514
+ </div>
2515
+ <hr />
2516
+ </div>
2517
+ <div class="sect2">
2518
+ <h3 id="subscribeforpausedscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">
2519
+ <a class="link" href="#subscribeforpausedscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2520
+ >3.9. <code>subscribeForPausedScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2521
+ >
2522
+ </h3>
2523
+ <div class="paragraph">
2524
+ <p>Registers a callback for a specific input event ONLY when the game is in a Paused state.</p>
2525
+ </div>
2526
+ <div class="paragraph">
2527
+ <p><strong>Parameters</strong></p>
2528
+ </div>
2529
+ <table class="tableblock frame-all grid-all stretch">
2530
+ <colgroup>
2531
+ <col style="width: 20%" />
2532
+ <col style="width: 20%" />
2533
+ <col style="width: 60%" />
2534
+ </colgroup>
2535
+ <tbody>
2536
+ <tr>
2537
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
2538
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
2539
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
2540
+ </tr>
2541
+ <tr>
2542
+ <td class="tableblock halign-left valign-top">
2543
+ <p class="tableblock"><code>key</code></p>
2544
+ </td>
2545
+ <td class="tableblock halign-left valign-top">
2546
+ <p class="tableblock">
2547
+ <code><a href="../enums/ControlKey.html">ControlKey</a></code>
2548
+ </p>
2549
+ </td>
2550
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The virtual key to monitor.</p></td>
2551
+ </tr>
2552
+ <tr>
2553
+ <td class="tableblock halign-left valign-top">
2554
+ <p class="tableblock"><code>type</code></p>
2555
+ </td>
2556
+ <td class="tableblock halign-left valign-top">
2557
+ <p class="tableblock">
2558
+ <code><a href="../enums/ControlEventType.html">ControlEventType</a></code>
2559
+ </p>
2560
+ </td>
2561
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The type of trigger.</p></td>
2562
+ </tr>
2563
+ <tr>
2564
+ <td class="tableblock halign-left valign-top">
2565
+ <p class="tableblock"><code>callback</code></p>
2566
+ </td>
2567
+ <td class="tableblock halign-left valign-top">
2568
+ <p class="tableblock">
2569
+ <code><a href="../types/ControlCallback.html">ControlCallback</a></code>
2570
+ </p>
2571
+ </td>
2572
+ <td class="tableblock halign-left valign-top"><p class="tableblock">The function to execute.</p></td>
2573
+ </tr>
2574
+ </tbody>
2575
+ </table>
2576
+ <hr />
2577
+ </div>
2578
+ <div class="sect2">
2579
+ <h3 id="unsubscribeforpausedscreenkey-controlkey-type-controleventtype-callback-controlcallback-void">
2580
+ <a class="link" href="#unsubscribeforpausedscreenkey-controlkey-type-controleventtype-callback-controlcallback-void"
2581
+ >3.10. <code>unsubscribeForPausedScreen(key: ControlKey, type: ControlEventType, callback: ControlCallback): void</code></a
2582
+ >
2583
+ </h3>
2584
+ <div class="paragraph">
2585
+ <p>Removes an existing Paused Screen subscription.</p>
2586
+ </div>
2587
+ <hr />
2588
+ </div>
2589
+ <div class="sect2">
2590
+ <h3 id="bindcontrols-void">
2591
+ <a class="link" href="#bindcontrols-void">3.11. <code>bindControls(): void</code></a>
2592
+ </h3>
2593
+ <div class="paragraph">
2594
+ <p>Attaches low-level event listeners to the environment.</p>
2595
+ </div>
2596
+ <div class="paragraph">
2597
+ <p><strong>Behavior</strong></p>
2598
+ </div>
2599
+ <div class="paragraph">
2600
+ <p>Enables keyboard and button listeners. This is called automatically by the engine during setup.</p>
2601
+ </div>
2602
+ <hr />
2603
+ </div>
2604
+ <div class="sect2">
2605
+ <h3 id="unbindcontrols-void">
2606
+ <a class="link" href="#unbindcontrols-void">3.12. <code>unbindControls(): void</code></a>
2607
+ </h3>
2608
+ <div class="paragraph">
2609
+ <p>Detaches all input listeners and clears subscriptions.</p>
2610
+ </div>
2611
+ <div class="paragraph">
2612
+ <p><strong>Behavior</strong></p>
2613
+ </div>
2614
+ <div class="paragraph">
2615
+ <p>
2616
+ Removes all low-level event listeners and wipes the internal subscription map. Called automatically during engine destruction.
2617
+ </p>
2618
+ </div>
2619
+ <hr />
2620
+ </div>
2621
+ <div class="sect2">
2622
+ <h3 id="notifykey-controlkey-type-controleventtype-void">
2623
+ <a class="link" href="#notifykey-controlkey-type-controleventtype-void"
2624
+ >3.13. <code>notify(key: ControlKey, type: ControlEventType): void</code></a
2625
+ >
2626
+ </h3>
2627
+ <div class="paragraph">
2628
+ <p>Manually triggers an input event.</p>
2629
+ </div>
2630
+ <div class="paragraph">
2631
+ <p><strong>Parameters</strong></p>
2632
+ </div>
2633
+ <table class="tableblock frame-all grid-all stretch">
2634
+ <colgroup>
2635
+ <col style="width: 20%" />
2636
+ <col style="width: 20%" />
2637
+ <col style="width: 60%" />
2638
+ </colgroup>
2639
+ <tbody>
2640
+ <tr>
2641
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
2642
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
2643
+ <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
2644
+ </tr>
2645
+ <tr>
2646
+ <td class="tableblock halign-left valign-top">
2647
+ <p class="tableblock"><code>key</code></p>
2648
+ </td>
2649
+ <td class="tableblock halign-left valign-top">
2650
+ <p class="tableblock">
2651
+ <code><a href="../enums/ControlKey.html">ControlKey</a></code>
2652
+ </p>
2653
+ </td>
2654
+ <td class="tableblock halign-left valign-top">
2655
+ <p class="tableblock">The exact abstracted key intent generating the signal.</p>
2656
+ </td>
2657
+ </tr>
2658
+ <tr>
2659
+ <td class="tableblock halign-left valign-top">
2660
+ <p class="tableblock"><code>type</code></p>
2661
+ </td>
2662
+ <td class="tableblock halign-left valign-top">
2663
+ <p class="tableblock">
2664
+ <code><a href="../enums/ControlEventType.html">ControlEventType</a></code>
2665
+ </p>
2666
+ </td>
2667
+ <td class="tableblock halign-left valign-top">
2668
+ <p class="tableblock">The physical user behavior type causing the event (e.g., <code>PRESSED</code>).</p>
2669
+ </td>
2670
+ </tr>
2671
+ </tbody>
2672
+ </table>
2673
+ <div class="paragraph">
2674
+ <p><strong>Behavior</strong></p>
2675
+ </div>
2676
+ <div class="paragraph">
2677
+ <p>Executes all callbacks associated with the given key and event type, subject to the following logic:</p>
2678
+ </div>
2679
+ <div class="ulist">
2680
+ <ul>
2681
+ <li>
2682
+ <p>
2683
+ <strong>Session Modal / Unresolved (<code>isModalOpen() || !isSessionResolved()</code>)</strong>: All inputs are BLOCKED
2684
+ to prevent interactions while the user is making a session restoration choice via the
2685
+ <code><a href="../interfaces/modules/Session.html">Session</a></code> module.
2686
+ </p>
2687
+ </li>
2688
+ <li>
2689
+ <p>
2690
+ <strong>System Off (<code>isOff()</code>)</strong>: Only the
2691
+ <code><a href="../enums/ControlKey.html">POWER</a></code> key is processed. All other keys are ignored.
2692
+ </p>
2693
+ </li>
2694
+ <li>
2695
+ <p>
2696
+ <strong>Active States (<code>!isStarted() || isPlaying() || isGameOver()</code>)</strong>: All keys are processed
2697
+ normally.
2698
+ </p>
2699
+ </li>
2700
+ <li>
2701
+ <p>
2702
+ <strong>Paused State (<code>isPaused()</code>)</strong>: Only system keys (e.g., <code>START_PAUSE</code>,
2703
+ <code>SOUND</code>, <code>COLOR</code>, <code>RESET</code>, <code>EXIT</code>) are processed. Gameplay keys are ignored.
2704
+ </p>
2705
+ </li>
2706
+ </ul>
2707
+ </div>
2708
+ <div class="paragraph">
2709
+ <p><strong>Throws an error</strong> if the game modules have not been initialized.</p>
2710
+ </div>
2711
+ <hr />
2712
+ </div>
2713
+ <div class="sect2">
2714
+ <h3 id="getdebugdata-recordstring-string-number-boolean">
2715
+ <a class="link" href="#getdebugdata-recordstring-string-number-boolean"
2716
+ >3.14. <code>getDebugData(): Record&lt;string, string | number | boolean&gt;</code></a
2717
+ >
2718
+ </h3>
2719
+ <div class="paragraph">
2720
+ <p>Returns metadata for the real-time debugger.</p>
2721
+ </div>
2722
+ <div class="paragraph">
2723
+ <p><strong>Returns</strong></p>
2724
+ </div>
2725
+ <div class="paragraph">
2726
+ <p>
2727
+ <code>Record&lt;string, string | number | boolean&gt;</code> - Object containing the number of
2728
+ <code>total_subscribers</code> and <code>tracked_keys</code>.
2729
+ </p>
2730
+ </div>
2731
+ </div>
2732
+ </div>
2733
+ </div>
2734
+ </div>
2735
+ <div id="footer">
2736
+ <div id="footer-text"></div>
2737
+ </div>
2738
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
2739
+ <script>
2740
+ if (!hljs.initHighlighting.called) {
2741
+ hljs.initHighlighting.called = true;
2742
+ [].slice.call(document.querySelectorAll('pre.highlight > code[data-lang]')).forEach(function (el) {
2743
+ hljs.highlightBlock(el);
2744
+ });
2745
+ }
2746
+ </script>
2747
+ </body>
2748
+ </html>