brick-engine-js 1.0.9 → 1.0.11

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 (280) hide show
  1. package/dist/app.js +1 -4952
  2. package/dist/brick-engine.js +1 -4970
  3. package/dist/css/brick-engine.bundle.css +1 -1
  4. package/dist/docs/GAME_DEVELOPER_GUIDE.html +1 -1
  5. package/dist/docs/brick-engine-guide.html +1 -1
  6. package/dist/docs/getting-started.html +1 -1
  7. package/dist/docs/jsdoc_standard.html +1 -1
  8. package/dist/docs/publishing.html +1 -1
  9. package/dist/docs/reference/interfaces/modules/Session.html +1 -1
  10. package/dist/docs/reference/modules/GameMenu.html +1 -1
  11. package/dist/docs/reference/modules/GameSession.html +1 -1
  12. package/dist/docs/reference/modules/InitialStateSnapshot.html +1 -1
  13. package/dist/docs/reference/modules/SessionModal.html +1 -1
  14. package/dist/docs/testing_best_practices.html +1 -1
  15. package/dist/index.html +1 -16
  16. package/dist/{index.d.ts → types/index.d.ts} +1 -0
  17. package/dist/vendor/p5.min.js +1 -1
  18. package/package.json +2 -4
  19. package/dist/app.js.map +0 -1
  20. package/dist/brick-engine.js.map +0 -1
  21. package/dist/css/app.bundle.css +0 -824
  22. package/dist/css/app.bundle.css.map +0 -1
  23. package/dist/css/brick-engine.bundle.css.map +0 -1
  24. package/docs/GAME_DEVELOPER_GUIDE.adoc +0 -167
  25. package/docs/brick-engine-guide.adoc +0 -87
  26. package/docs/diagrams/lifecycle.mmd +0 -19
  27. package/docs/documentation_style_guide.adoc +0 -210
  28. package/docs/getting-started.adoc +0 -147
  29. package/docs/images/lifecycle.svg +0 -1
  30. package/docs/jsdoc_standard.adoc +0 -109
  31. package/docs/publishing.adoc +0 -58
  32. package/docs/reference/enums/Color.adoc +0 -35
  33. package/docs/reference/enums/ControlEventType.adoc +0 -28
  34. package/docs/reference/enums/ControlKey.adoc +0 -34
  35. package/docs/reference/enums/FontAlignment.adoc +0 -43
  36. package/docs/reference/enums/FontSize.adoc +0 -31
  37. package/docs/reference/enums/Sound.adoc +0 -42
  38. package/docs/reference/enums/StateProperty.adoc +0 -33
  39. package/docs/reference/helpers/CellHelper.adoc +0 -37
  40. package/docs/reference/helpers/ControlInputHandlerHelper.adoc +0 -57
  41. package/docs/reference/helpers/CoordinateHelper.adoc +0 -118
  42. package/docs/reference/helpers/RelativeValuesHelper.adoc +0 -53
  43. package/docs/reference/interfaces/Debuggable.adoc +0 -29
  44. package/docs/reference/interfaces/GameModules.adoc +0 -35
  45. package/docs/reference/interfaces/Initializable.adoc +0 -24
  46. package/docs/reference/interfaces/RendererInitializable.adoc +0 -33
  47. package/docs/reference/interfaces/StateSyncable.adoc +0 -41
  48. package/docs/reference/interfaces/modules/Control.adoc +0 -98
  49. package/docs/reference/interfaces/modules/Grid.adoc +0 -411
  50. package/docs/reference/interfaces/modules/Renderer.adoc +0 -34
  51. package/docs/reference/interfaces/modules/RendererComposite.adoc +0 -57
  52. package/docs/reference/interfaces/modules/Score.adoc +0 -107
  53. package/docs/reference/interfaces/modules/Session.adoc +0 -66
  54. package/docs/reference/interfaces/modules/State.adoc +0 -290
  55. package/docs/reference/interfaces/modules/Text.adoc +0 -110
  56. package/docs/reference/interfaces/modules/Time.adoc +0 -119
  57. package/docs/reference/modules/Debugger.adoc +0 -71
  58. package/docs/reference/modules/DisplayRenderer.adoc +0 -55
  59. package/docs/reference/modules/Game.adoc +0 -256
  60. package/docs/reference/modules/GameControl.adoc +0 -139
  61. package/docs/reference/modules/GameGrid.adoc +0 -794
  62. package/docs/reference/modules/GameHudGrid.adoc +0 -38
  63. package/docs/reference/modules/GameMenu.adoc +0 -39
  64. package/docs/reference/modules/GameRenderer.adoc +0 -79
  65. package/docs/reference/modules/GameScore.adoc +0 -138
  66. package/docs/reference/modules/GameSession.adoc +0 -43
  67. package/docs/reference/modules/GameSound.adoc +0 -111
  68. package/docs/reference/modules/GameState.adoc +0 -318
  69. package/docs/reference/modules/GameText.adoc +0 -139
  70. package/docs/reference/modules/GameTime.adoc +0 -141
  71. package/docs/reference/modules/HudRenderer.adoc +0 -56
  72. package/docs/reference/modules/InitialStateSnapshot.adoc +0 -47
  73. package/docs/reference/modules/SessionModal.adoc +0 -34
  74. package/docs/reference/types/Axis.adoc +0 -28
  75. package/docs/reference/types/Cell.adoc +0 -29
  76. package/docs/reference/types/ControlCallback.adoc +0 -23
  77. package/docs/reference/types/Coordinate.adoc +0 -29
  78. package/docs/reference/types/GameEntry.adoc +0 -29
  79. package/docs/reference/types/GameEvent.adoc +0 -29
  80. package/docs/reference/types/Piece.adoc +0 -32
  81. package/docs/reference/types/RendererMetrics.adoc +0 -29
  82. package/docs/reference/types/Vector.adoc +0 -28
  83. package/docs/testing_best_practices.adoc +0 -190
  84. package/public/CNAME +0 -1
  85. package/public/docs/GAME_DEVELOPER_GUIDE.html +0 -727
  86. package/public/docs/brick-engine-guide.html +0 -610
  87. package/public/docs/diagrams/lifecycle.mmd +0 -19
  88. package/public/docs/documentation_style_guide.html +0 -994
  89. package/public/docs/getting-started.html +0 -648
  90. package/public/docs/images/lifecycle.svg +0 -1
  91. package/public/docs/index.html +0 -593
  92. package/public/docs/jsdoc_standard.html +0 -656
  93. package/public/docs/publishing.html +0 -573
  94. package/public/docs/reference/enums/Color.html +0 -533
  95. package/public/docs/reference/enums/ControlEventType.html +0 -505
  96. package/public/docs/reference/enums/ControlKey.html +0 -529
  97. package/public/docs/reference/enums/FontAlignment.html +0 -545
  98. package/public/docs/reference/enums/FontSize.html +0 -517
  99. package/public/docs/reference/enums/Sound.html +0 -558
  100. package/public/docs/reference/enums/StateProperty.html +0 -525
  101. package/public/docs/reference/helpers/CellHelper.html +0 -520
  102. package/public/docs/reference/helpers/ControlInputHandlerHelper.html +0 -569
  103. package/public/docs/reference/helpers/CoordinateHelper.html +0 -703
  104. package/public/docs/reference/helpers/RelativeValuesHelper.html +0 -560
  105. package/public/docs/reference/interfaces/Debuggable.html +0 -501
  106. package/public/docs/reference/interfaces/GameModules.html +0 -544
  107. package/public/docs/reference/interfaces/Initializable.html +0 -495
  108. package/public/docs/reference/interfaces/RendererInitializable.html +0 -517
  109. package/public/docs/reference/interfaces/StateSyncable.html +0 -542
  110. package/public/docs/reference/interfaces/modules/Control.html +0 -648
  111. package/public/docs/reference/interfaces/modules/Grid.html +0 -1256
  112. package/public/docs/reference/interfaces/modules/Renderer.html +0 -522
  113. package/public/docs/reference/interfaces/modules/RendererComposite.html +0 -577
  114. package/public/docs/reference/interfaces/modules/Score.html +0 -669
  115. package/public/docs/reference/interfaces/modules/Session.html +0 -585
  116. package/public/docs/reference/interfaces/modules/State.html +0 -897
  117. package/public/docs/reference/interfaces/modules/Text.html +0 -668
  118. package/public/docs/reference/interfaces/modules/Time.html +0 -684
  119. package/public/docs/reference/modules/Debugger.html +0 -579
  120. package/public/docs/reference/modules/DisplayRenderer.html +0 -557
  121. package/public/docs/reference/modules/Game.html +0 -909
  122. package/public/docs/reference/modules/GameControl.html +0 -716
  123. package/public/docs/reference/modules/GameGrid.html +0 -1910
  124. package/public/docs/reference/modules/GameHudGrid.html +0 -508
  125. package/public/docs/reference/modules/GameMenu.html +0 -538
  126. package/public/docs/reference/modules/GameRenderer.html +0 -589
  127. package/public/docs/reference/modules/GameScore.html +0 -664
  128. package/public/docs/reference/modules/GameSession.html +0 -533
  129. package/public/docs/reference/modules/GameSound.html +0 -636
  130. package/public/docs/reference/modules/GameState.html +0 -922
  131. package/public/docs/reference/modules/GameText.html +0 -701
  132. package/public/docs/reference/modules/GameTime.html +0 -696
  133. package/public/docs/reference/modules/HudRenderer.html +0 -568
  134. package/public/docs/reference/modules/InitialStateSnapshot.html +0 -557
  135. package/public/docs/reference/modules/SessionModal.html +0 -520
  136. package/public/docs/reference/types/Axis.html +0 -505
  137. package/public/docs/reference/types/Cell.html +0 -514
  138. package/public/docs/reference/types/ControlCallback.html +0 -488
  139. package/public/docs/reference/types/Coordinate.html +0 -510
  140. package/public/docs/reference/types/GameEntry.html +0 -514
  141. package/public/docs/reference/types/GameEvent.html +0 -514
  142. package/public/docs/reference/types/Piece.html +0 -506
  143. package/public/docs/reference/types/RendererMetrics.html +0 -514
  144. package/public/docs/reference/types/Vector.html +0 -509
  145. package/public/docs/testing_best_practices.html +0 -770
  146. package/public/favicon.ico +0 -0
  147. package/public/fonts/digital-7.monoitalic.ttf +0 -0
  148. package/public/images/cell.svg +0 -32
  149. package/public/images/close.png +0 -0
  150. package/public/images/games.png +0 -0
  151. package/public/images/github.png +0 -0
  152. package/public/images/letter-a.png +0 -0
  153. package/public/images/letter-d.png +0 -0
  154. package/public/images/letter-j.png +0 -0
  155. package/public/images/letter-s.png +0 -0
  156. package/public/images/letter-w.png +0 -0
  157. package/public/images/meta-image.png +0 -0
  158. package/public/images/number-1.png +0 -0
  159. package/public/images/number-2.png +0 -0
  160. package/public/images/number-3.png +0 -0
  161. package/public/images/number-4.png +0 -0
  162. package/public/images/number-5.png +0 -0
  163. package/public/images/number-6.png +0 -0
  164. package/public/images/splash.gif +0 -0
  165. package/public/index.html +0 -16
  166. package/public/sounds/sound_00.wav +0 -0
  167. package/public/sounds/sound_01.wav +0 -0
  168. package/public/sounds/sound_02.wav +0 -0
  169. package/public/sounds/sound_03.wav +0 -0
  170. package/public/sounds/sound_04.wav +0 -0
  171. package/public/sounds/sound_05.wav +0 -0
  172. package/public/sounds/sound_06.wav +0 -0
  173. package/public/sounds/sound_07.wav +0 -0
  174. package/public/sounds/sound_08.wav +0 -0
  175. package/public/sounds/sound_09.wav +0 -0
  176. package/public/sounds/sound_10.wav +0 -0
  177. package/public/sounds/sound_11.wav +0 -0
  178. package/public/sounds/sound_12.wav +0 -0
  179. package/public/sounds/sound_13.wav +0 -0
  180. package/public/sounds/sound_14.wav +0 -0
  181. package/public/sounds/sound_15.wav +0 -0
  182. package/public/style/body.css +0 -86
  183. package/public/style/buttons.css +0 -233
  184. package/public/style/debugger.css +0 -117
  185. package/public/style/sessionModal.css +0 -155
  186. package/public/style/sourceCodeAndCommands.css +0 -74
  187. package/public/style/splash.css +0 -13
  188. package/public/style/theme.css +0 -137
  189. /package/dist/{bootstrap.d.ts → types/bootstrap.d.ts} +0 -0
  190. /package/dist/{bootstrap.test.d.ts → types/bootstrap.test.d.ts} +0 -0
  191. /package/dist/{config → types/config}/configs.d.ts +0 -0
  192. /package/dist/{config → types/config}/configs.test.d.ts +0 -0
  193. /package/dist/{core → types/core}/Game.d.ts +0 -0
  194. /package/dist/{core → types/core}/Game.test.d.ts +0 -0
  195. /package/dist/{core → types/core}/InitialStateSnapshot.d.ts +0 -0
  196. /package/dist/{core → types/core}/InitialStateSnapshot.test.d.ts +0 -0
  197. /package/dist/{core → types/core}/helpers/CellHelper.d.ts +0 -0
  198. /package/dist/{core → types/core}/helpers/CellHelper.test.d.ts +0 -0
  199. /package/dist/{core → types/core}/helpers/ControlInputHandlerHelper.d.ts +0 -0
  200. /package/dist/{core → types/core}/helpers/ControlInputHandlerHelper.test.d.ts +0 -0
  201. /package/dist/{core → types/core}/helpers/CoordinateHelper.d.ts +0 -0
  202. /package/dist/{core → types/core}/helpers/CoordinateHelper.test.d.ts +0 -0
  203. /package/dist/{core → types/core}/helpers/InterfaceIdentifierHelper.d.ts +0 -0
  204. /package/dist/{core → types/core}/helpers/InterfaceIdentifierHelper.test.d.ts +0 -0
  205. /package/dist/{core → types/core}/helpers/RelativeValuesHelper.d.ts +0 -0
  206. /package/dist/{core → types/core}/helpers/RelativeValuesHelper.test.d.ts +0 -0
  207. /package/dist/{core → types/core}/module/control/GameControl.d.ts +0 -0
  208. /package/dist/{core → types/core}/module/control/GameControl.test.d.ts +0 -0
  209. /package/dist/{core → types/core}/module/control/GameControlKeyBinding.d.ts +0 -0
  210. /package/dist/{core → types/core}/module/control/GameControlKeyBinding.test.d.ts +0 -0
  211. /package/dist/{core → types/core}/module/grid/GameGrid.d.ts +0 -0
  212. /package/dist/{core → types/core}/module/grid/GameGrid.test.d.ts +0 -0
  213. /package/dist/{core → types/core}/module/grid/GameHudGrid.d.ts +0 -0
  214. /package/dist/{core → types/core}/module/grid/GameHudGrid.test.d.ts +0 -0
  215. /package/dist/{core → types/core}/module/grid/engines/GridAnalysisEngine.d.ts +0 -0
  216. /package/dist/{core → types/core}/module/grid/engines/GridAnalysisEngine.test.d.ts +0 -0
  217. /package/dist/{core → types/core}/module/grid/engines/GridLineEngine.d.ts +0 -0
  218. /package/dist/{core → types/core}/module/grid/engines/GridLineEngine.test.d.ts +0 -0
  219. /package/dist/{core → types/core}/module/grid/engines/GridMovementEngine.d.ts +0 -0
  220. /package/dist/{core → types/core}/module/grid/engines/GridMovementEngine.test.d.ts +0 -0
  221. /package/dist/{core → types/core}/module/grid/engines/GridRegionEngine.d.ts +0 -0
  222. /package/dist/{core → types/core}/module/grid/engines/GridRegionEngine.test.d.ts +0 -0
  223. /package/dist/{core → types/core}/module/grid/engines/GridTransformEngine.d.ts +0 -0
  224. /package/dist/{core → types/core}/module/grid/engines/GridTransformEngine.test.d.ts +0 -0
  225. /package/dist/{core → types/core}/module/renderer/DisplayRenderer.d.ts +0 -0
  226. /package/dist/{core → types/core}/module/renderer/DisplayRenderer.test.d.ts +0 -0
  227. /package/dist/{core → types/core}/module/renderer/GameRenderer.d.ts +0 -0
  228. /package/dist/{core → types/core}/module/renderer/GameRenderer.test.d.ts +0 -0
  229. /package/dist/{core → types/core}/module/renderer/HudRenderer.d.ts +0 -0
  230. /package/dist/{core → types/core}/module/renderer/HudRenderer.test.d.ts +0 -0
  231. /package/dist/{core → types/core}/module/score/GameScore.d.ts +0 -0
  232. /package/dist/{core → types/core}/module/score/GameScore.test.d.ts +0 -0
  233. /package/dist/{core → types/core}/module/session/GameSession.d.ts +0 -0
  234. /package/dist/{core → types/core}/module/session/GameSession.test.d.ts +0 -0
  235. /package/dist/{core → types/core}/module/sound/GameSound.d.ts +0 -0
  236. /package/dist/{core → types/core}/module/sound/GameSound.test.d.ts +0 -0
  237. /package/dist/{core → types/core}/module/state/GameState.d.ts +0 -0
  238. /package/dist/{core → types/core}/module/state/GameState.test.d.ts +0 -0
  239. /package/dist/{core → types/core}/module/text/GameText.d.ts +0 -0
  240. /package/dist/{core → types/core}/module/text/GameText.test.d.ts +0 -0
  241. /package/dist/{core → types/core}/module/time/GameTime.d.ts +0 -0
  242. /package/dist/{core → types/core}/module/time/GameTime.test.d.ts +0 -0
  243. /package/dist/{core → types/core}/types/Interfaces.d.ts +0 -0
  244. /package/dist/{core → types/core}/types/Types.d.ts +0 -0
  245. /package/dist/{core → types/core}/types/enums.d.ts +0 -0
  246. /package/dist/{core → types/core}/types/modules.d.ts +0 -0
  247. /package/dist/{main.d.ts → types/main.d.ts} +0 -0
  248. /package/dist/{menu → types/menu}/GameMenu.d.ts +0 -0
  249. /package/dist/{menu → types/menu}/GameMenu.test.d.ts +0 -0
  250. /package/dist/{menu → types/menu}/GameMenuSingleton.d.ts +0 -0
  251. /package/dist/{menu → types/menu}/GameMenuSingleton.test.d.ts +0 -0
  252. /package/dist/{menu → types/menu}/GameRepository.d.ts +0 -0
  253. /package/dist/{menu → types/menu}/GameRepository.test.d.ts +0 -0
  254. /package/dist/{menu → types/menu}/manager/GameManager.d.ts +0 -0
  255. /package/dist/{menu → types/menu}/manager/GameManager.test.d.ts +0 -0
  256. /package/dist/types/{interfaces.d.ts → types/interfaces.d.ts} +0 -0
  257. /package/dist/{view → types/view}/Debugger.d.ts +0 -0
  258. /package/dist/{view → types/view}/Debugger.test.d.ts +0 -0
  259. /package/dist/{view → types/view}/GameView.d.ts +0 -0
  260. /package/dist/{view → types/view}/GameView.test.d.ts +0 -0
  261. /package/dist/{view → types/view}/SessionModal.d.ts +0 -0
  262. /package/dist/{view → types/view}/SessionModal.test.d.ts +0 -0
  263. /package/dist/{view → types/view}/components/layout/ButtonLayout.d.ts +0 -0
  264. /package/dist/{view → types/view}/components/layout/ButtonLayout.test.d.ts +0 -0
  265. /package/dist/{view → types/view}/components/layout/ContainerLayout.d.ts +0 -0
  266. /package/dist/{view → types/view}/components/layout/ContainerLayout.test.d.ts +0 -0
  267. /package/dist/{view → types/view}/components/layout/FrameLayout.d.ts +0 -0
  268. /package/dist/{view → types/view}/components/layout/FrameLayout.test.d.ts +0 -0
  269. /package/dist/{view → types/view}/components/ui/BigButton.d.ts +0 -0
  270. /package/dist/{view → types/view}/components/ui/BigButton.test.d.ts +0 -0
  271. /package/dist/{view → types/view}/components/ui/Button.d.ts +0 -0
  272. /package/dist/{view → types/view}/components/ui/Button.test.d.ts +0 -0
  273. /package/dist/{view → types/view}/components/ui/Canvas.d.ts +0 -0
  274. /package/dist/{view → types/view}/components/ui/Canvas.test.d.ts +0 -0
  275. /package/dist/{view → types/view}/components/ui/SmallButton.d.ts +0 -0
  276. /package/dist/{view → types/view}/components/ui/SmallButton.test.d.ts +0 -0
  277. /package/dist/{view → types/view}/theme/applyColors.d.ts +0 -0
  278. /package/dist/{view → types/view}/theme/applyColors.test.d.ts +0 -0
  279. /package/dist/{view → types/view}/theme/dimensions.d.ts +0 -0
  280. /package/dist/{view → types/view}/theme/dimensions.test.d.ts +0 -0
@@ -1,922 +0,0 @@
1
- <!DOCTYPE html>
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="Single source of truth for the game lifecycle and persistent user preferences.">
9
- <meta name="keywords" content="state, lifecycle, persistence, localstorage">
10
- <title>GameState 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>GameState 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="#centralized-persistence">1. Centralized Persistence</a></li>
447
- <li><a href="#persistence-vs-session">2. Persistence vs. Session</a></li>
448
- <li><a href="#api-reference">3. API Reference</a>
449
- <ul class="sectlevel2">
450
- <li><a href="#ison-boolean">3.1. <code>isOn(): boolean</code></a></li>
451
- <li><a href="#isoff-boolean">3.2. <code>isOff(): boolean</code></a></li>
452
- <li><a href="#isstarted-boolean">3.3. <code>isStarted(): boolean</code></a></li>
453
- <li><a href="#isplaying-boolean">3.4. <code>isPlaying(): boolean</code></a></li>
454
- <li><a href="#ispaused-boolean">3.5. <code>isPaused(): boolean</code></a></li>
455
- <li><a href="#isgameover-boolean">3.6. <code>isGameOver(): boolean</code></a></li>
456
- <li><a href="#turnon-void">3.7. <code>turnOn(): void</code></a></li>
457
- <li><a href="#turnoff-void">3.8. <code>turnOff(): void</code></a></li>
458
- <li><a href="#startgame-void">3.9. <code>startGame(): void</code></a></li>
459
- <li><a href="#exitgame-void">3.10. <code>exitGame(): void</code></a></li>
460
- <li><a href="#pause-void">3.11. <code>pause(): void</code></a></li>
461
- <li><a href="#resume-void">3.12. <code>resume(): void</code></a></li>
462
- <li><a href="#triggergameover-void">3.13. <code>triggerGameOver(): void</code></a></li>
463
- <li><a href="#resetgame-void">3.14. <code>resetGame(): void</code></a></li>
464
- <li><a href="#resetgameover-void">3.15. <code>resetGameOver(): void</code></a></li>
465
- <li><a href="#iscolorenabled-boolean">3.16. <code>isColorEnabled(): boolean</code></a></li>
466
- <li><a href="#setcolorenabledvalue-boolean-void">3.17. <code>setColorEnabled(value: boolean): void</code></a></li>
467
- <li><a href="#togglecolorenabled-void">3.18. <code>toggleColorEnabled(): void</code></a></li>
468
- <li><a href="#ismuted-boolean">3.19. <code>isMuted(): boolean</code></a></li>
469
- <li><a href="#setmutedvalue-boolean-void">3.20. <code>setMuted(value: boolean): void</code></a></li>
470
- <li><a href="#togglemuted-void">3.21. <code>toggleMuted(): void</code></a></li>
471
- <li><a href="#subscribeproperty-stateproperty-callback-value-boolean-number-void-void">3.22. <code>subscribe(property: StateProperty, callback: (value: boolean | number) &#8658; void): void</code></a></li>
472
- <li><a href="#unsubscribeproperty-stateproperty-callback-value-boolean-number-void-void">3.23. <code>unsubscribe(property: StateProperty, callback: (value: boolean | number) &#8658; void): void</code></a></li>
473
- <li><a href="#getdebugdata-recordstring-string-number-boolean">3.24. <code>getDebugData(): Record&lt;string, string | number | boolean&gt;</code></a></li>
474
- </ul>
475
- </li>
476
- </ul>
477
- </div>
478
- </div>
479
- <div id="content">
480
- <div id="preamble">
481
- <div class="sectionbody">
482
- <div class="paragraph">
483
- <p>The <code>GameState</code> module acts as the central, single source of truth for the game&#8217;s lifecycle and user preferences. It handles persistence to <code>LocalStorage</code> for settings and high scores.</p>
484
- </div>
485
- </div>
486
- </div>
487
- <div class="sect1">
488
- <h2 id="centralized-persistence"><a class="link" href="#centralized-persistence">1. Centralized Persistence</a></h2>
489
- <div class="sectionbody">
490
- <div class="paragraph">
491
- <p>As defined in the Architectural Patterns, <code>GameState</code> is responsible for all <code>LocalStorage</code> logic. Other modules (like <code><a href="GameSound.html">GameSound</a></code>) must sync their internal state with this module via the <code><a href="../interfaces/StateSyncable.html">StateSyncable</a></code> interface.</p>
492
- </div>
493
- </div>
494
- </div>
495
- <div class="sect1">
496
- <h2 id="persistence-vs-session"><a class="link" href="#persistence-vs-session">2. Persistence vs. Session</a></h2>
497
- <div class="sectionbody">
498
- <div class="paragraph">
499
- <p>It is important to understand the boundary between <code>GameState</code> persistence and the <code>Game</code> Session management:</p>
500
- </div>
501
- <div class="ulist">
502
- <ul>
503
- <li>
504
- <p><strong>GameState Persistence</strong>: Manages <strong>long-term, cross-session</strong> data. It persists user preferences (like <code>muted</code>, <code>colorEnabled</code>) to <code>LocalStorage</code>. This data remains even after a Game Over or when completely restarting the engine.</p>
505
- </li>
506
- <li>
507
- <p><strong>Game Session</strong>: Managed by the <code><a href="Game.html">Game</a></code> class utilizing a <code>SessionManager</code> and <code>Serializable</code> modules. A Session saves the <strong>transient, intra-session</strong> progress (e.g., the active grid layout, the current score, the current level). Session data is automatically cleared when the game reaches a <code>GAME_OVER</code> state, when the <code>RESET</code> button is pressed, or when the player manually uses the <code>EXIT</code> control.</p>
508
- </li>
509
- </ul>
510
- </div>
511
- </div>
512
- </div>
513
- <div class="sect1">
514
- <h2 id="api-reference"><a class="link" href="#api-reference">3. API Reference</a></h2>
515
- <div class="sectionbody">
516
- <div class="sect2">
517
- <h3 id="ison-boolean"><a class="link" href="#ison-boolean">3.1. <code>isOn(): boolean</code></a></h3>
518
- <div class="paragraph">
519
- <p>Checks if the game system is powered up.</p>
520
- </div>
521
- <div class="paragraph">
522
- <p><strong>Returns</strong></p>
523
- </div>
524
- <div class="paragraph">
525
- <p><code>boolean</code> - <code>true</code> if system is on.</p>
526
- </div>
527
- <hr>
528
- </div>
529
- <div class="sect2">
530
- <h3 id="isoff-boolean"><a class="link" href="#isoff-boolean">3.2. <code>isOff(): boolean</code></a></h3>
531
- <div class="paragraph">
532
- <p>Checks if the game system is powered down.</p>
533
- </div>
534
- <div class="paragraph">
535
- <p><strong>Returns</strong></p>
536
- </div>
537
- <div class="paragraph">
538
- <p><code>boolean</code> - <code>true</code> if system is off.</p>
539
- </div>
540
- <hr>
541
- </div>
542
- <div class="sect2">
543
- <h3 id="isstarted-boolean"><a class="link" href="#isstarted-boolean">3.3. <code>isStarted(): boolean</code></a></h3>
544
- <div class="paragraph">
545
- <p>Checks if a game session is active (passed the title screen).</p>
546
- </div>
547
- <div class="paragraph">
548
- <p><strong>Returns</strong></p>
549
- </div>
550
- <div class="paragraph">
551
- <p><code>boolean</code> - <code>true</code> if the game has started.</p>
552
- </div>
553
- <hr>
554
- </div>
555
- <div class="sect2">
556
- <h3 id="isplaying-boolean"><a class="link" href="#isplaying-boolean">3.4. <code>isPlaying(): boolean</code></a></h3>
557
- <div class="paragraph">
558
- <p>Checks if the game loop is actively updating logic.</p>
559
- </div>
560
- <div class="paragraph">
561
- <p><strong>Returns</strong></p>
562
- </div>
563
- <div class="paragraph">
564
- <p><code>boolean</code> - <code>true</code> if gameplay is active and not paused.</p>
565
- </div>
566
- <hr>
567
- </div>
568
- <div class="sect2">
569
- <h3 id="ispaused-boolean"><a class="link" href="#ispaused-boolean">3.5. <code>isPaused(): boolean</code></a></h3>
570
- <div class="paragraph">
571
- <p>Checks if the game is currently paused.</p>
572
- </div>
573
- <div class="paragraph">
574
- <p><strong>Returns</strong></p>
575
- </div>
576
- <div class="paragraph">
577
- <p><code>boolean</code> - <code>true</code> if the game is started but halted.</p>
578
- </div>
579
- <hr>
580
- </div>
581
- <div class="sect2">
582
- <h3 id="isgameover-boolean"><a class="link" href="#isgameover-boolean">3.6. <code>isGameOver(): boolean</code></a></h3>
583
- <div class="paragraph">
584
- <p>Checks if the current session has ended in a Game Over.</p>
585
- </div>
586
- <div class="paragraph">
587
- <p><strong>Returns</strong></p>
588
- </div>
589
- <div class="paragraph">
590
- <p><code>boolean</code> - <code>true</code> if player has lost.</p>
591
- </div>
592
- <hr>
593
- </div>
594
- <div class="sect2">
595
- <h3 id="turnon-void"><a class="link" href="#turnon-void">3.7. <code>turnOn(): void</code></a></h3>
596
- <div class="paragraph">
597
- <p>Powers on the game system.</p>
598
- </div>
599
- <div class="paragraph">
600
- <p><strong>Behavior</strong></p>
601
- </div>
602
- <div class="paragraph">
603
- <p>Sets the <code>on</code> property to true and ensures <code>start</code>, <code>playing</code>, and <code>gameOver</code> are initialized to false.</p>
604
- </div>
605
- <hr>
606
- </div>
607
- <div class="sect2">
608
- <h3 id="turnoff-void"><a class="link" href="#turnoff-void">3.8. <code>turnOff(): void</code></a></h3>
609
- <div class="paragraph">
610
- <p>Powers off the game system.</p>
611
- </div>
612
- <div class="paragraph">
613
- <p><strong>Behavior</strong></p>
614
- </div>
615
- <div class="paragraph">
616
- <p>Sets the <code>on</code> property to false and wipes transient state.</p>
617
- </div>
618
- <hr>
619
- </div>
620
- <div class="sect2">
621
- <h3 id="startgame-void"><a class="link" href="#startgame-void">3.9. <code>startGame(): void</code></a></h3>
622
- <div class="paragraph">
623
- <p>Initiates gameplay from the title screen.</p>
624
- </div>
625
- <div class="paragraph">
626
- <p><strong>Behavior</strong></p>
627
- </div>
628
- <div class="paragraph">
629
- <p>Sets <code>start</code> and <code>playing</code> to true. This method only has effect if the system is already <code>on</code>.</p>
630
- </div>
631
- <hr>
632
- </div>
633
- <div class="sect2">
634
- <h3 id="exitgame-void"><a class="link" href="#exitgame-void">3.10. <code>exitGame(): void</code></a></h3>
635
- <div class="paragraph">
636
- <p>Ends the session and returns to the title screen.</p>
637
- </div>
638
- <div class="paragraph">
639
- <p><strong>Behavior</strong></p>
640
- </div>
641
- <div class="paragraph">
642
- <p>Resets <code>start</code>, <code>playing</code>, and <code>gameOver</code> to false.</p>
643
- </div>
644
- <hr>
645
- </div>
646
- <div class="sect2">
647
- <h3 id="pause-void"><a class="link" href="#pause-void">3.11. <code>pause(): void</code></a></h3>
648
- <div class="paragraph">
649
- <p>Halts gameplay logic.</p>
650
- </div>
651
- <div class="paragraph">
652
- <p><strong>Behavior</strong></p>
653
- </div>
654
- <div class="paragraph">
655
- <p>Sets <code>playing</code> to false. Only works if the game is already started.</p>
656
- </div>
657
- <hr>
658
- </div>
659
- <div class="sect2">
660
- <h3 id="resume-void"><a class="link" href="#resume-void">3.12. <code>resume(): void</code></a></h3>
661
- <div class="paragraph">
662
- <p>Restarts gameplay logic from a paused state.</p>
663
- </div>
664
- <div class="paragraph">
665
- <p><strong>Behavior</strong></p>
666
- </div>
667
- <div class="paragraph">
668
- <p>Sets <code>playing</code> to true.</p>
669
- </div>
670
- <hr>
671
- </div>
672
- <div class="sect2">
673
- <h3 id="triggergameover-void"><a class="link" href="#triggergameover-void">3.13. <code>triggerGameOver(): void</code></a></h3>
674
- <div class="paragraph">
675
- <p>Forces the game into a Game Over state.</p>
676
- </div>
677
- <div class="paragraph">
678
- <p><strong>Behavior</strong></p>
679
- </div>
680
- <div class="paragraph">
681
- <p>Sets <code>playing</code> to false and <code>gameOver</code> to true.</p>
682
- </div>
683
- <hr>
684
- </div>
685
- <div class="sect2">
686
- <h3 id="resetgame-void"><a class="link" href="#resetgame-void">3.14. <code>resetGame(): void</code></a></h3>
687
- <div class="paragraph">
688
- <p>Prepares the state for a new round (hard restart).</p>
689
- </div>
690
- <div class="paragraph">
691
- <p><strong>Behavior</strong></p>
692
- </div>
693
- <div class="paragraph">
694
- <p>Clears the <code>gameOver</code> flag and resumes <code>playing</code> status. Unlike <code>resetGameOver</code>, this is intended for a complete session reset from any state.</p>
695
- </div>
696
- <hr>
697
- </div>
698
- <div class="sect2">
699
- <h3 id="resetgameover-void"><a class="link" href="#resetgameover-void">3.15. <code>resetGameOver(): void</code></a></h3>
700
- <div class="paragraph">
701
- <p>Resets the state specifically after a Game Over to allow immediate restart.</p>
702
- </div>
703
- <div class="paragraph">
704
- <p><strong>Behavior</strong></p>
705
- </div>
706
- <div class="paragraph">
707
- <p>Sets <code>gameOver</code> to false and <code>playing</code> to true. This is the recommended way to handle "Try Again" scenarios.</p>
708
- </div>
709
- <hr>
710
- </div>
711
- <div class="sect2">
712
- <h3 id="iscolorenabled-boolean"><a class="link" href="#iscolorenabled-boolean">3.16. <code>isColorEnabled(): boolean</code></a></h3>
713
- <div class="paragraph">
714
- <p>Checks if theme color mode is active.</p>
715
- </div>
716
- <div class="paragraph">
717
- <p><strong>Returns</strong></p>
718
- </div>
719
- <div class="paragraph">
720
- <p><code>boolean</code> - <code>true</code> if color mode is on.</p>
721
- </div>
722
- <hr>
723
- </div>
724
- <div class="sect2">
725
- <h3 id="setcolorenabledvalue-boolean-void"><a class="link" href="#setcolorenabledvalue-boolean-void">3.17. <code>setColorEnabled(value: boolean): void</code></a></h3>
726
- <div class="paragraph">
727
- <p>Sets the color mode preference.</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>value</code></p></td>
746
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean</code></p></td>
747
- <td class="tableblock halign-left valign-top"><p class="tableblock">New color mode status.</p></td>
748
- </tr>
749
- </tbody>
750
- </table>
751
- <div class="paragraph">
752
- <p><strong>Behavior</strong></p>
753
- </div>
754
- <div class="paragraph">
755
- <p>Updates the property and automatically persists the value to <code>LocalStorage</code>.</p>
756
- </div>
757
- <hr>
758
- </div>
759
- <div class="sect2">
760
- <h3 id="togglecolorenabled-void"><a class="link" href="#togglecolorenabled-void">3.18. <code>toggleColorEnabled(): void</code></a></h3>
761
- <div class="paragraph">
762
- <p>Toggles the current color mode.</p>
763
- </div>
764
- <hr>
765
- </div>
766
- <div class="sect2">
767
- <h3 id="ismuted-boolean"><a class="link" href="#ismuted-boolean">3.19. <code>isMuted(): boolean</code></a></h3>
768
- <div class="paragraph">
769
- <p>Checks if master audio is muted.</p>
770
- </div>
771
- <div class="paragraph">
772
- <p><strong>Returns</strong></p>
773
- </div>
774
- <div class="paragraph">
775
- <p><code>boolean</code> - <code>true</code> if sound is disabled.</p>
776
- </div>
777
- <hr>
778
- </div>
779
- <div class="sect2">
780
- <h3 id="setmutedvalue-boolean-void"><a class="link" href="#setmutedvalue-boolean-void">3.20. <code>setMuted(value: boolean): void</code></a></h3>
781
- <div class="paragraph">
782
- <p>Sets the master mute status.</p>
783
- </div>
784
- <div class="paragraph">
785
- <p><strong>Parameters</strong></p>
786
- </div>
787
- <table class="tableblock frame-all grid-all stretch">
788
- <colgroup>
789
- <col style="width: 20%;">
790
- <col style="width: 20%;">
791
- <col style="width: 60%;">
792
- </colgroup>
793
- <tbody>
794
- <tr>
795
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
796
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
797
- <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
798
- </tr>
799
- <tr>
800
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td>
801
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean</code></p></td>
802
- <td class="tableblock halign-left valign-top"><p class="tableblock">New mute status.</p></td>
803
- </tr>
804
- </tbody>
805
- </table>
806
- <div class="paragraph">
807
- <p><strong>Behavior</strong></p>
808
- </div>
809
- <div class="paragraph">
810
- <p>Updates the property and persists it to <code>LocalStorage</code>.</p>
811
- </div>
812
- <hr>
813
- </div>
814
- <div class="sect2">
815
- <h3 id="togglemuted-void"><a class="link" href="#togglemuted-void">3.21. <code>toggleMuted(): void</code></a></h3>
816
- <div class="paragraph">
817
- <p>Toggles the master mute status.</p>
818
- </div>
819
- <hr>
820
- </div>
821
- <div class="sect2">
822
- <h3 id="subscribeproperty-stateproperty-callback-value-boolean-number-void-void"><a class="link" href="#subscribeproperty-stateproperty-callback-value-boolean-number-void-void">3.22. <code>subscribe(property: StateProperty, callback: (value: boolean | number) &#8658; void): void</code></a></h3>
823
- <div class="paragraph">
824
- <p>Registers a listener for state changes.</p>
825
- </div>
826
- <div class="paragraph">
827
- <p><strong>Parameters</strong></p>
828
- </div>
829
- <table class="tableblock frame-all grid-all stretch">
830
- <colgroup>
831
- <col style="width: 20%;">
832
- <col style="width: 20%;">
833
- <col style="width: 60%;">
834
- </colgroup>
835
- <tbody>
836
- <tr>
837
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
838
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
839
- <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
840
- </tr>
841
- <tr>
842
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>property</code></p></td>
843
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/StateProperty.html">StateProperty</a></code></p></td>
844
- <td class="tableblock halign-left valign-top"><p class="tableblock">The specific property to monitor.</p></td>
845
- </tr>
846
- <tr>
847
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>callback</code></p></td>
848
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Function</code></p></td>
849
- <td class="tableblock halign-left valign-top"><p class="tableblock">The function to execute on change.</p></td>
850
- </tr>
851
- </tbody>
852
- </table>
853
- <div class="paragraph">
854
- <p><strong>Example</strong></p>
855
- </div>
856
- <div class="listingblock">
857
- <div class="content">
858
- <pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">state.subscribe(StateProperty.GAME_OVER, (isOver) =&gt; {
859
- if (isOver) {
860
- this.modules.sound.play(Sound.GAMEOVER);
861
- }
862
- });</code></pre>
863
- </div>
864
- </div>
865
- <hr>
866
- </div>
867
- <div class="sect2">
868
- <h3 id="unsubscribeproperty-stateproperty-callback-value-boolean-number-void-void"><a class="link" href="#unsubscribeproperty-stateproperty-callback-value-boolean-number-void-void">3.23. <code>unsubscribe(property: StateProperty, callback: (value: boolean | number) &#8658; void): void</code></a></h3>
869
- <div class="paragraph">
870
- <p>Removes a state change listener.</p>
871
- </div>
872
- <div class="paragraph">
873
- <p><strong>Parameters</strong></p>
874
- </div>
875
- <table class="tableblock frame-all grid-all stretch">
876
- <colgroup>
877
- <col style="width: 20%;">
878
- <col style="width: 20%;">
879
- <col style="width: 60%;">
880
- </colgroup>
881
- <tbody>
882
- <tr>
883
- <td class="tableblock halign-left valign-top"><p class="tableblock">Name</p></td>
884
- <td class="tableblock halign-left valign-top"><p class="tableblock">Type</p></td>
885
- <td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
886
- </tr>
887
- <tr>
888
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>property</code></p></td>
889
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="../enums/StateProperty.html">StateProperty</a></code></p></td>
890
- <td class="tableblock halign-left valign-top"><p class="tableblock">The property being monitored.</p></td>
891
- </tr>
892
- <tr>
893
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>callback</code></p></td>
894
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Function</code></p></td>
895
- <td class="tableblock halign-left valign-top"><p class="tableblock">The reference to the callback to remove.</p></td>
896
- </tr>
897
- </tbody>
898
- </table>
899
- <hr>
900
- </div>
901
- <div class="sect2">
902
- <h3 id="getdebugdata-recordstring-string-number-boolean"><a class="link" href="#getdebugdata-recordstring-string-number-boolean">3.24. <code>getDebugData(): Record&lt;string, string | number | boolean&gt;</code></a></h3>
903
- <div class="paragraph">
904
- <p>Returns metadata for the real-time debugger.</p>
905
- </div>
906
- </div>
907
- </div>
908
- </div>
909
- </div>
910
- <div id="footer">
911
- <div id="footer-text">
912
- </div>
913
- </div>
914
- <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
915
- <script>
916
- if (!hljs.initHighlighting.called) {
917
- hljs.initHighlighting.called = true
918
- ;[].slice.call(document.querySelectorAll('pre.highlight > code[data-lang]')).forEach(function (el) { hljs.highlightBlock(el) })
919
- }
920
- </script>
921
- </body>
922
- </html>