@egret/engine 0.0.0-stage → 7.0.2

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 (601) hide show
  1. package/LICENSE +201 -0
  2. package/NOTICE +21 -0
  3. package/README.md +101 -2
  4. package/README.zh-CN.md +102 -0
  5. package/dist/Engine.d.ts +77 -0
  6. package/dist/Engine.js +469 -0
  7. package/dist/animation/index.d.ts +6 -0
  8. package/dist/animation/index.js +5 -0
  9. package/dist/animation/sequenceController.d.ts +22 -0
  10. package/dist/animation/sequenceController.js +618 -0
  11. package/dist/animation/sequenceCoordinator.d.ts +26 -0
  12. package/dist/animation/sequenceCoordinator.js +161 -0
  13. package/dist/animation/sequenceInput.d.ts +25 -0
  14. package/dist/animation/sequenceInput.js +108 -0
  15. package/dist/animation/sequenceMath.d.ts +35 -0
  16. package/dist/animation/sequenceMath.js +164 -0
  17. package/dist/animation/sequenceResetSlot.d.ts +7 -0
  18. package/dist/animation/sequenceResetSlot.js +367 -0
  19. package/dist/animation/sequenceResetTypes.d.ts +48 -0
  20. package/dist/animation/sequenceResetTypes.js +2 -0
  21. package/dist/animation/types.d.ts +75 -0
  22. package/dist/animation/types.js +2 -0
  23. package/dist/assetBundle.d.ts +54 -0
  24. package/dist/assetBundle.js +173 -0
  25. package/dist/assetGroup.d.ts +17 -0
  26. package/dist/assetGroup.js +332 -0
  27. package/dist/assetGroupTypes.d.ts +17 -0
  28. package/dist/assetGroupTypes.js +2 -0
  29. package/dist/audio.d.ts +4 -0
  30. package/dist/audio.js +4 -0
  31. package/dist/audioCues.d.ts +47 -0
  32. package/dist/audioCues.js +127 -0
  33. package/dist/audioMixer.d.ts +7 -0
  34. package/dist/audioMixer.js +785 -0
  35. package/dist/audioTypes.d.ts +246 -0
  36. package/dist/audioTypes.js +3 -0
  37. package/dist/bitmapBindingTicket.d.ts +24 -0
  38. package/dist/bitmapBindingTicket.js +215 -0
  39. package/dist/bitmapButton.d.ts +4 -0
  40. package/dist/bitmapButton.js +407 -0
  41. package/dist/bitmapButtonTypes.d.ts +31 -0
  42. package/dist/bitmapButtonTypes.js +2 -0
  43. package/dist/bitmapFontParse.d.ts +10 -0
  44. package/dist/bitmapFontParse.js +246 -0
  45. package/dist/bitmapFontTypes.d.ts +112 -0
  46. package/dist/bitmapFontTypes.js +2 -0
  47. package/dist/bitmapResourceSlot.d.ts +26 -0
  48. package/dist/bitmapResourceSlot.js +340 -0
  49. package/dist/bitmapText.d.ts +6 -0
  50. package/dist/bitmapText.js +320 -0
  51. package/dist/bitmapfont.d.ts +5 -0
  52. package/dist/bitmapfont.js +5 -0
  53. package/dist/camera.d.ts +4 -0
  54. package/dist/camera.js +4 -0
  55. package/dist/camera2d.d.ts +7 -0
  56. package/dist/camera2d.js +419 -0
  57. package/dist/cameraTypes.d.ts +126 -0
  58. package/dist/cameraTypes.js +2 -0
  59. package/dist/closeHost.d.ts +4 -0
  60. package/dist/closeHost.js +66 -0
  61. package/dist/contentArtifacts.d.ts +12 -0
  62. package/dist/contentArtifacts.js +153 -0
  63. package/dist/contentAtlasPages.d.ts +13 -0
  64. package/dist/contentAtlasPages.js +117 -0
  65. package/dist/contentLoader.d.ts +6 -0
  66. package/dist/contentLoader.js +327 -0
  67. package/dist/contentTypes.d.ts +35 -0
  68. package/dist/contentTypes.js +2 -0
  69. package/dist/createEngine.d.ts +7 -0
  70. package/dist/createEngine.js +25 -0
  71. package/dist/createEngineForProfile.d.ts +5 -0
  72. package/dist/createEngineForProfile.js +45 -0
  73. package/dist/displaySubtreeTicket.d.ts +25 -0
  74. package/dist/displaySubtreeTicket.js +76 -0
  75. package/dist/fontContentLoader.d.ts +6 -0
  76. package/dist/fontContentLoader.js +298 -0
  77. package/dist/fontContentTypes.d.ts +39 -0
  78. package/dist/fontContentTypes.js +2 -0
  79. package/dist/gameClock.d.ts +24 -0
  80. package/dist/gameClock.js +246 -0
  81. package/dist/gameClockTypes.d.ts +37 -0
  82. package/dist/gameClockTypes.js +2 -0
  83. package/dist/gameRun.d.ts +53 -0
  84. package/dist/gameRun.js +97 -0
  85. package/dist/gamepad.d.ts +5 -0
  86. package/dist/gamepad.js +5 -0
  87. package/dist/gamepadInput.d.ts +4 -0
  88. package/dist/gamepadInput.js +281 -0
  89. package/dist/gamepadKeys.d.ts +4 -0
  90. package/dist/gamepadKeys.js +205 -0
  91. package/dist/gamepadTypes.d.ts +142 -0
  92. package/dist/gamepadTypes.js +3 -0
  93. package/dist/hover.d.ts +4 -0
  94. package/dist/hover.js +4 -0
  95. package/dist/hoverInput.d.ts +8 -0
  96. package/dist/hoverInput.js +503 -0
  97. package/dist/hoverInputTypes.d.ts +129 -0
  98. package/dist/hoverInputTypes.js +2 -0
  99. package/dist/index.d.ts +52 -0
  100. package/dist/index.js +21 -0
  101. package/dist/input.d.ts +6 -0
  102. package/dist/input.js +5 -0
  103. package/dist/inputActions.d.ts +86 -0
  104. package/dist/inputActions.js +330 -0
  105. package/dist/internal/contentFactoryState.d.ts +19 -0
  106. package/dist/internal/contentFactoryState.js +42 -0
  107. package/dist/internal/mouseInputFactoryState.d.ts +57 -0
  108. package/dist/internal/mouseInputFactoryState.js +125 -0
  109. package/dist/internal/sequenceControllerFactoryState.d.ts +42 -0
  110. package/dist/internal/sequenceControllerFactoryState.js +98 -0
  111. package/dist/internal/textFieldFactoryState.d.ts +11 -0
  112. package/dist/internal/textFieldFactoryState.js +32 -0
  113. package/dist/internal/texturedFrameState.d.ts +4 -0
  114. package/dist/internal/texturedFrameState.js +12 -0
  115. package/dist/internal/uiFactoryState.d.ts +68 -0
  116. package/dist/internal/uiFactoryState.js +173 -0
  117. package/dist/internal/uiRootState.d.ts +67 -0
  118. package/dist/internal/uiRootState.js +103 -0
  119. package/dist/keyboardInput.d.ts +13 -0
  120. package/dist/keyboardInput.js +579 -0
  121. package/dist/keyboardInputTypes.d.ts +93 -0
  122. package/dist/keyboardInputTypes.js +2 -0
  123. package/dist/kit.d.ts +16 -0
  124. package/dist/kit.js +10 -0
  125. package/dist/layout.d.ts +5 -0
  126. package/dist/layout.js +132 -0
  127. package/dist/layoutTypes.d.ts +28 -0
  128. package/dist/layoutTypes.js +2 -0
  129. package/dist/manifestAssetGroup.d.ts +10 -0
  130. package/dist/manifestAssetGroup.js +477 -0
  131. package/dist/manifestResourceState.d.ts +17 -0
  132. package/dist/manifestResourceState.js +58 -0
  133. package/dist/manifestResourceTypes.d.ts +26 -0
  134. package/dist/manifestResourceTypes.js +2 -0
  135. package/dist/motion.d.ts +35 -0
  136. package/dist/motion.js +206 -0
  137. package/dist/mouseInput.d.ts +102 -0
  138. package/dist/mouseInput.js +562 -0
  139. package/dist/mouseInputTypes.d.ts +41 -0
  140. package/dist/mouseInputTypes.js +2 -0
  141. package/dist/paragraph.d.ts +8 -0
  142. package/dist/paragraph.js +7 -0
  143. package/dist/particleEmitter.d.ts +4 -0
  144. package/dist/particleEmitter.js +300 -0
  145. package/dist/particleTypes.d.ts +115 -0
  146. package/dist/particleTypes.js +2 -0
  147. package/dist/particles.d.ts +4 -0
  148. package/dist/particles.js +4 -0
  149. package/dist/physics2d.d.ts +4 -0
  150. package/dist/physics2d.js +4 -0
  151. package/dist/physics2dGeometry.d.ts +39 -0
  152. package/dist/physics2dGeometry.js +230 -0
  153. package/dist/physics2dTypes.d.ts +221 -0
  154. package/dist/physics2dTypes.js +2 -0
  155. package/dist/physics2dWorld.d.ts +4 -0
  156. package/dist/physics2dWorld.js +823 -0
  157. package/dist/pointerInput.d.ts +12 -0
  158. package/dist/pointerInput.js +300 -0
  159. package/dist/pointerInputTypes.d.ts +41 -0
  160. package/dist/pointerInputTypes.js +2 -0
  161. package/dist/random.d.ts +30 -0
  162. package/dist/random.js +131 -0
  163. package/dist/rendering/ownedPreparationFailure2D.d.ts +5 -0
  164. package/dist/rendering/ownedPreparationFailure2D.js +33 -0
  165. package/dist/rendering/packSharedDraws2D.d.ts +50 -0
  166. package/dist/rendering/packSharedDraws2D.js +379 -0
  167. package/dist/rendering/packedOrientation.d.ts +4 -0
  168. package/dist/rendering/packedOrientation.js +7 -0
  169. package/dist/rendering/prepareRectangles2D.d.ts +92 -0
  170. package/dist/rendering/prepareRectangles2D.js +481 -0
  171. package/dist/rendering/prepareSharedDraws2D.d.ts +90 -0
  172. package/dist/rendering/prepareSharedDraws2D.js +663 -0
  173. package/dist/rendering/preparedBatches2D.d.ts +17 -0
  174. package/dist/rendering/preparedBatches2D.js +30 -0
  175. package/dist/rendering/preparedSharedBatches2D.d.ts +44 -0
  176. package/dist/rendering/preparedSharedBatches2D.js +247 -0
  177. package/dist/rendering/sharedColor2D.d.ts +52 -0
  178. package/dist/rendering/sharedColor2D.js +191 -0
  179. package/dist/rendering/sharedEffects2D.d.ts +23 -0
  180. package/dist/rendering/sharedEffects2D.js +126 -0
  181. package/dist/rendering/sharedPreparationRetention2D.d.ts +120 -0
  182. package/dist/rendering/sharedPreparationRetention2D.js +357 -0
  183. package/dist/rendering/srgbBytes.d.ts +3 -0
  184. package/dist/rendering/srgbBytes.js +64 -0
  185. package/dist/rendering/texturedPreparationBudget2D.d.ts +31 -0
  186. package/dist/rendering/texturedPreparationBudget2D.js +81 -0
  187. package/dist/rendering/world3d/Animation3D.d.ts +104 -0
  188. package/dist/rendering/world3d/Animation3D.js +384 -0
  189. package/dist/rendering/world3d/AnimationTexture3D.d.ts +163 -0
  190. package/dist/rendering/world3d/AnimationTexture3D.js +603 -0
  191. package/dist/rendering/world3d/Batch3D.d.ts +75 -0
  192. package/dist/rendering/world3d/Batch3D.js +332 -0
  193. package/dist/rendering/world3d/Camera3D.d.ts +62 -0
  194. package/dist/rendering/world3d/Camera3D.js +132 -0
  195. package/dist/rendering/world3d/Character3D.d.ts +127 -0
  196. package/dist/rendering/world3d/Character3D.js +305 -0
  197. package/dist/rendering/world3d/Cloth3D.d.ts +130 -0
  198. package/dist/rendering/world3d/Cloth3D.js +503 -0
  199. package/dist/rendering/world3d/Compression3D.d.ts +22 -0
  200. package/dist/rendering/world3d/Compression3D.js +703 -0
  201. package/dist/rendering/world3d/Curves3D.d.ts +119 -0
  202. package/dist/rendering/world3d/Curves3D.js +460 -0
  203. package/dist/rendering/world3d/Decal3D.d.ts +43 -0
  204. package/dist/rendering/world3d/Decal3D.js +242 -0
  205. package/dist/rendering/world3d/Export3D.d.ts +13 -0
  206. package/dist/rendering/world3d/Export3D.js +263 -0
  207. package/dist/rendering/world3d/Geometry3D.d.ts +95 -0
  208. package/dist/rendering/world3d/Geometry3D.js +335 -0
  209. package/dist/rendering/world3d/GeometryBuilder3D.d.ts +53 -0
  210. package/dist/rendering/world3d/GeometryBuilder3D.js +196 -0
  211. package/dist/rendering/world3d/Gizmo3D.d.ts +80 -0
  212. package/dist/rendering/world3d/Gizmo3D.js +514 -0
  213. package/dist/rendering/world3d/Gltf3D.d.ts +73 -0
  214. package/dist/rendering/world3d/Gltf3D.js +996 -0
  215. package/dist/rendering/world3d/GpuParticles3D.d.ts +109 -0
  216. package/dist/rendering/world3d/GpuParticles3D.js +401 -0
  217. package/dist/rendering/world3d/Hdr3D.d.ts +35 -0
  218. package/dist/rendering/world3d/Hdr3D.js +191 -0
  219. package/dist/rendering/world3d/Jelly3D.d.ts +77 -0
  220. package/dist/rendering/world3d/Jelly3D.js +267 -0
  221. package/dist/rendering/world3d/Ktx23D.d.ts +30 -0
  222. package/dist/rendering/world3d/Ktx23D.js +112 -0
  223. package/dist/rendering/world3d/Light3D.d.ts +84 -0
  224. package/dist/rendering/world3d/Light3D.js +97 -0
  225. package/dist/rendering/world3d/Material3D.d.ts +253 -0
  226. package/dist/rendering/world3d/Material3D.js +269 -0
  227. package/dist/rendering/world3d/Mesh3D.d.ts +112 -0
  228. package/dist/rendering/world3d/Mesh3D.js +337 -0
  229. package/dist/rendering/world3d/Meshopt3D.d.ts +15 -0
  230. package/dist/rendering/world3d/Meshopt3D.js +276 -0
  231. package/dist/rendering/world3d/Navigation3D.d.ts +213 -0
  232. package/dist/rendering/world3d/Navigation3D.js +1043 -0
  233. package/dist/rendering/world3d/Object3D.d.ts +118 -0
  234. package/dist/rendering/world3d/Object3D.js +315 -0
  235. package/dist/rendering/world3d/Particles3D.d.ts +90 -0
  236. package/dist/rendering/world3d/Particles3D.js +277 -0
  237. package/dist/rendering/world3d/Physics3D.d.ts +430 -0
  238. package/dist/rendering/world3d/Physics3D.js +2840 -0
  239. package/dist/rendering/world3d/PhysicsHull3D.d.ts +37 -0
  240. package/dist/rendering/world3d/PhysicsHull3D.js +229 -0
  241. package/dist/rendering/world3d/PhysicsMesh3D.d.ts +41 -0
  242. package/dist/rendering/world3d/PhysicsMesh3D.js +340 -0
  243. package/dist/rendering/world3d/PhysicsQueries3D.d.ts +24 -0
  244. package/dist/rendering/world3d/PhysicsQueries3D.js +323 -0
  245. package/dist/rendering/world3d/PhysicsRemote3D.d.ts +179 -0
  246. package/dist/rendering/world3d/PhysicsRemote3D.js +536 -0
  247. package/dist/rendering/world3d/Ragdoll3D.d.ts +74 -0
  248. package/dist/rendering/world3d/Ragdoll3D.js +202 -0
  249. package/dist/rendering/world3d/Raycast3D.d.ts +40 -0
  250. package/dist/rendering/world3d/Raycast3D.js +247 -0
  251. package/dist/rendering/world3d/RenderList3D.d.ts +91 -0
  252. package/dist/rendering/world3d/RenderList3D.js +502 -0
  253. package/dist/rendering/world3d/Retarget3D.d.ts +21 -0
  254. package/dist/rendering/world3d/Retarget3D.js +185 -0
  255. package/dist/rendering/world3d/Rig3D.d.ts +57 -0
  256. package/dist/rendering/world3d/Rig3D.js +219 -0
  257. package/dist/rendering/world3d/Sdf3D.d.ts +181 -0
  258. package/dist/rendering/world3d/Sdf3D.js +1136 -0
  259. package/dist/rendering/world3d/SdfLod3D.d.ts +17 -0
  260. package/dist/rendering/world3d/SdfLod3D.js +56 -0
  261. package/dist/rendering/world3d/Serialize3D.d.ts +66 -0
  262. package/dist/rendering/world3d/Serialize3D.js +629 -0
  263. package/dist/rendering/world3d/Simplify3D.d.ts +29 -0
  264. package/dist/rendering/world3d/Simplify3D.js +426 -0
  265. package/dist/rendering/world3d/StateMachine3D.d.ts +87 -0
  266. package/dist/rendering/world3d/StateMachine3D.js +280 -0
  267. package/dist/rendering/world3d/SurfaceMaterial3D.d.ts +26 -0
  268. package/dist/rendering/world3d/SurfaceMaterial3D.js +138 -0
  269. package/dist/rendering/world3d/Terrain3D.d.ts +248 -0
  270. package/dist/rendering/world3d/Terrain3D.js +827 -0
  271. package/dist/rendering/world3d/Text3D.d.ts +95 -0
  272. package/dist/rendering/world3d/Text3D.js +560 -0
  273. package/dist/rendering/world3d/Texture3D.d.ts +148 -0
  274. package/dist/rendering/world3d/Texture3D.js +270 -0
  275. package/dist/rendering/world3d/Trail3D.d.ts +62 -0
  276. package/dist/rendering/world3d/Trail3D.js +195 -0
  277. package/dist/rendering/world3d/Vehicle3D.d.ts +102 -0
  278. package/dist/rendering/world3d/Vehicle3D.js +228 -0
  279. package/dist/rendering/world3d/VolumetricFog3D.d.ts +57 -0
  280. package/dist/rendering/world3d/VolumetricFog3D.js +230 -0
  281. package/dist/rendering/world3d/Water3D.d.ts +165 -0
  282. package/dist/rendering/world3d/Water3D.js +607 -0
  283. package/dist/rendering/world3d/core3D.d.ts +36 -0
  284. package/dist/rendering/world3d/core3D.js +99 -0
  285. package/dist/rendering/world3d/debug3D.d.ts +69 -0
  286. package/dist/rendering/world3d/debug3D.js +262 -0
  287. package/dist/rendering/world3d/decoders3D.d.ts +42 -0
  288. package/dist/rendering/world3d/decoders3D.js +133 -0
  289. package/dist/rendering/world3d/geometries3D.d.ts +111 -0
  290. package/dist/rendering/world3d/geometries3D.js +610 -0
  291. package/dist/rendering/world3d/helpers3D.d.ts +67 -0
  292. package/dist/rendering/world3d/helpers3D.js +178 -0
  293. package/dist/rendering/world3d/index.d.ts +103 -0
  294. package/dist/rendering/world3d/index.js +62 -0
  295. package/dist/rendering/world3d/math3D.d.ts +114 -0
  296. package/dist/rendering/world3d/math3D.js +675 -0
  297. package/dist/rendering/world3d/primitives3D.d.ts +67 -0
  298. package/dist/rendering/world3d/primitives3D.js +197 -0
  299. package/dist/resources.d.ts +8 -0
  300. package/dist/resources.js +6 -0
  301. package/dist/saveStore.d.ts +71 -0
  302. package/dist/saveStore.js +182 -0
  303. package/dist/semanticList.d.ts +126 -0
  304. package/dist/semanticList.js +175 -0
  305. package/dist/semanticTree.d.ts +10 -0
  306. package/dist/semanticTree.js +539 -0
  307. package/dist/semanticTypes.d.ts +175 -0
  308. package/dist/semanticTypes.js +2 -0
  309. package/dist/semantics.d.ts +6 -0
  310. package/dist/semantics.js +5 -0
  311. package/dist/sequencePlayback.d.ts +19 -0
  312. package/dist/sequencePlayback.js +391 -0
  313. package/dist/sequencePlaybackTypes.d.ts +24 -0
  314. package/dist/sequencePlaybackTypes.js +2 -0
  315. package/dist/sequenceTargetClaims.d.ts +10 -0
  316. package/dist/sequenceTargetClaims.js +31 -0
  317. package/dist/srgbBytes.d.ts +3 -0
  318. package/dist/srgbBytes.js +64 -0
  319. package/dist/startEngine.d.ts +5 -0
  320. package/dist/startEngine.js +31 -0
  321. package/dist/surfaceOwnership.d.ts +3 -0
  322. package/dist/surfaceOwnership.js +15 -0
  323. package/dist/text.d.ts +24 -0
  324. package/dist/text.js +4 -0
  325. package/dist/textField.d.ts +6 -0
  326. package/dist/textField.js +6 -0
  327. package/dist/textTable.d.ts +41 -0
  328. package/dist/textTable.js +114 -0
  329. package/dist/tileMapDraw.d.ts +7 -0
  330. package/dist/tileMapDraw.js +310 -0
  331. package/dist/tiledImport.d.ts +9 -0
  332. package/dist/tiledImport.js +357 -0
  333. package/dist/tilemap.d.ts +5 -0
  334. package/dist/tilemap.js +5 -0
  335. package/dist/tilemapTypes.d.ts +182 -0
  336. package/dist/tilemapTypes.js +2 -0
  337. package/dist/timer.d.ts +34 -0
  338. package/dist/timer.js +119 -0
  339. package/dist/tween.d.ts +15 -0
  340. package/dist/tween.js +329 -0
  341. package/dist/tweenTypes.d.ts +31 -0
  342. package/dist/tweenTypes.js +2 -0
  343. package/dist/ui/controlKeys.d.ts +113 -0
  344. package/dist/ui/controlKeys.js +250 -0
  345. package/dist/ui/controls.d.ts +58 -0
  346. package/dist/ui/controls.js +290 -0
  347. package/dist/ui/editing.d.ts +3 -0
  348. package/dist/ui/editing.js +3 -0
  349. package/dist/ui/index.d.ts +19 -0
  350. package/dist/ui/index.js +11 -0
  351. package/dist/ui/keyboardFocus.d.ts +32 -0
  352. package/dist/ui/keyboardFocus.js +146 -0
  353. package/dist/ui/layerTypes.d.ts +98 -0
  354. package/dist/ui/layerTypes.js +2 -0
  355. package/dist/ui/layers.d.ts +4 -0
  356. package/dist/ui/layers.js +586 -0
  357. package/dist/ui/leafContent.d.ts +21 -0
  358. package/dist/ui/leafContent.js +136 -0
  359. package/dist/ui/rangeControl.d.ts +53 -0
  360. package/dist/ui/rangeControl.js +168 -0
  361. package/dist/ui/scrollControl.d.ts +84 -0
  362. package/dist/ui/scrollControl.js +222 -0
  363. package/dist/ui/stateControls.d.ts +90 -0
  364. package/dist/ui/stateControls.js +331 -0
  365. package/dist/ui/textEditor.d.ts +54 -0
  366. package/dist/ui/textEditor.js +371 -0
  367. package/dist/ui/textEditorTypes.d.ts +85 -0
  368. package/dist/ui/textEditorTypes.js +2 -0
  369. package/dist/ui/textFieldControl.d.ts +100 -0
  370. package/dist/ui/textFieldControl.js +260 -0
  371. package/dist/ui/theme.d.ts +64 -0
  372. package/dist/ui/theme.js +166 -0
  373. package/dist/ui/types.d.ts +285 -0
  374. package/dist/ui/types.js +2 -0
  375. package/dist/ui/uiRoot.d.ts +4 -0
  376. package/dist/ui/uiRoot.js +1526 -0
  377. package/dist/ui/uiRootDisplay.d.ts +46 -0
  378. package/dist/ui/uiRootDisplay.js +148 -0
  379. package/dist/ui/uiRootModel.d.ts +114 -0
  380. package/dist/ui/uiRootModel.js +66 -0
  381. package/dist/ui/virtualList.d.ts +20 -0
  382. package/dist/ui/virtualList.js +105 -0
  383. package/dist/video.d.ts +4 -0
  384. package/dist/video.js +4 -0
  385. package/dist/videoPlayer.d.ts +4 -0
  386. package/dist/videoPlayer.js +215 -0
  387. package/dist/videoTypes.d.ts +77 -0
  388. package/dist/videoTypes.js +2 -0
  389. package/dist/web/BrowserAssetBundle.d.ts +41 -0
  390. package/dist/web/BrowserAssetBundle.js +136 -0
  391. package/dist/web/BrowserAudio.d.ts +74 -0
  392. package/dist/web/BrowserAudio.js +503 -0
  393. package/dist/web/BrowserFrameLoop.d.ts +69 -0
  394. package/dist/web/BrowserFrameLoop.js +125 -0
  395. package/dist/web/BrowserGame.d.ts +174 -0
  396. package/dist/web/BrowserGame.js +473 -0
  397. package/dist/web/BrowserGamepadInput.d.ts +38 -0
  398. package/dist/web/BrowserGamepadInput.js +134 -0
  399. package/dist/web/BrowserHoverInput.d.ts +25 -0
  400. package/dist/web/BrowserHoverInput.js +266 -0
  401. package/dist/web/BrowserImageTextures.d.ts +72 -0
  402. package/dist/web/BrowserImageTextures.js +169 -0
  403. package/dist/web/BrowserInputActions.d.ts +63 -0
  404. package/dist/web/BrowserInputActions.js +345 -0
  405. package/dist/web/BrowserKeyboardInput.d.ts +4 -0
  406. package/dist/web/BrowserKeyboardInput.js +223 -0
  407. package/dist/web/BrowserPlay.d.ts +417 -0
  408. package/dist/web/BrowserPlay.js +1648 -0
  409. package/dist/web/BrowserPointerInput.d.ts +4 -0
  410. package/dist/web/BrowserPointerInput.js +511 -0
  411. package/dist/web/BrowserPreferences.d.ts +10 -0
  412. package/dist/web/BrowserPreferences.js +39 -0
  413. package/dist/web/BrowserSemantics.d.ts +36 -0
  414. package/dist/web/BrowserSemantics.js +418 -0
  415. package/dist/web/BrowserStatsPanel.d.ts +56 -0
  416. package/dist/web/BrowserStatsPanel.js +143 -0
  417. package/dist/web/BrowserStorage.d.ts +35 -0
  418. package/dist/web/BrowserStorage.js +132 -0
  419. package/dist/web/BrowserTextEditor.d.ts +52 -0
  420. package/dist/web/BrowserTextEditor.js +839 -0
  421. package/dist/web/BrowserTextInput.d.ts +89 -0
  422. package/dist/web/BrowserTextInput.js +524 -0
  423. package/dist/web/BrowserTextureProvider.d.ts +58 -0
  424. package/dist/web/BrowserTextureProvider.js +935 -0
  425. package/dist/web/BrowserVideo.d.ts +40 -0
  426. package/dist/web/BrowserVideo.js +237 -0
  427. package/dist/web/CanvasKitFontSetProvider.d.ts +32 -0
  428. package/dist/web/CanvasKitFontSetProvider.js +215 -0
  429. package/dist/web/CanvasKitParagraphProvider.d.ts +173 -0
  430. package/dist/web/CanvasKitParagraphProvider.js +692 -0
  431. package/dist/web/CanvasTextRasterProvider.d.ts +4 -0
  432. package/dist/web/CanvasTextRasterProvider.js +312 -0
  433. package/dist/web/ManifestByteSource.d.ts +151 -0
  434. package/dist/web/ManifestByteSource.js +975 -0
  435. package/dist/web/ManifestFontContentLoader.d.ts +13 -0
  436. package/dist/web/ManifestFontContentLoader.js +30 -0
  437. package/dist/web/MouseInput.d.ts +4 -0
  438. package/dist/web/MouseInput.js +218 -0
  439. package/dist/web/WebGL2Host.d.ts +5 -0
  440. package/dist/web/WebGL2Host.js +2711 -0
  441. package/dist/web/WebGPUHost.d.ts +100 -0
  442. package/dist/web/WebGPUHost.js +3430 -0
  443. package/dist/web/audio.d.ts +3 -0
  444. package/dist/web/audio.js +4 -0
  445. package/dist/web/canvasKitParagraphGeometry.d.ts +27 -0
  446. package/dist/web/canvasKitParagraphGeometry.js +83 -0
  447. package/dist/web/editing.d.ts +5 -0
  448. package/dist/web/editing.js +4 -0
  449. package/dist/web/editorFonts.d.ts +54 -0
  450. package/dist/web/editorFonts.js +297 -0
  451. package/dist/web/game.d.ts +5 -0
  452. package/dist/web/game.js +6 -0
  453. package/dist/web/gamepad.d.ts +3 -0
  454. package/dist/web/gamepad.js +4 -0
  455. package/dist/web/hover.d.ts +3 -0
  456. package/dist/web/hover.js +4 -0
  457. package/dist/web/image.d.ts +4 -0
  458. package/dist/web/image.js +4 -0
  459. package/dist/web/imageProjections2D.d.ts +16 -0
  460. package/dist/web/imageProjections2D.js +2 -0
  461. package/dist/web/input.d.ts +6 -0
  462. package/dist/web/input.js +4 -0
  463. package/dist/web/keyboard.d.ts +3 -0
  464. package/dist/web/keyboard.js +3 -0
  465. package/dist/web/kit.d.ts +11 -0
  466. package/dist/web/kit.js +8 -0
  467. package/dist/web/loop.d.ts +3 -0
  468. package/dist/web/loop.js +4 -0
  469. package/dist/web/paragraph.d.ts +6 -0
  470. package/dist/web/paragraph.js +4 -0
  471. package/dist/web/play.d.ts +10 -0
  472. package/dist/web/play.js +9 -0
  473. package/dist/web/playMusic.d.ts +33 -0
  474. package/dist/web/playMusic.js +194 -0
  475. package/dist/web/playSfx.d.ts +36 -0
  476. package/dist/web/playSfx.js +112 -0
  477. package/dist/web/playTouch.d.ts +45 -0
  478. package/dist/web/playTouch.js +141 -0
  479. package/dist/web/playWidgets.d.ts +71 -0
  480. package/dist/web/playWidgets.js +431 -0
  481. package/dist/web/pointer.d.ts +3 -0
  482. package/dist/web/pointer.js +3 -0
  483. package/dist/web/prepareSharedSubmission2D.d.ts +27 -0
  484. package/dist/web/prepareSharedSubmission2D.js +63 -0
  485. package/dist/web/resources.d.ts +29 -0
  486. package/dist/web/resources.js +96 -0
  487. package/dist/web/semantics.d.ts +3 -0
  488. package/dist/web/semantics.js +4 -0
  489. package/dist/web/sharedDeviceSession.d.ts +64 -0
  490. package/dist/web/sharedDeviceSession.js +2 -0
  491. package/dist/web/sharedEffectShaders.d.ts +13 -0
  492. package/dist/web/sharedEffectShaders.js +181 -0
  493. package/dist/web/sharedFrameUpload.d.ts +25 -0
  494. package/dist/web/sharedFrameUpload.js +2 -0
  495. package/dist/web/sharedHostDeferred.d.ts +7 -0
  496. package/dist/web/sharedHostDeferred.js +12 -0
  497. package/dist/web/sharedRetentionLedger.d.ts +85 -0
  498. package/dist/web/sharedRetentionLedger.js +391 -0
  499. package/dist/web/sharedSubmissionStorage2D.d.ts +56 -0
  500. package/dist/web/sharedSubmissionStorage2D.js +73 -0
  501. package/dist/web/sharedWebGL2Arena.d.ts +40 -0
  502. package/dist/web/sharedWebGL2Arena.js +77 -0
  503. package/dist/web/sharedWebGL2Options.d.ts +33 -0
  504. package/dist/web/sharedWebGL2Options.js +102 -0
  505. package/dist/web/sharedWebGL2Shaders.d.ts +33 -0
  506. package/dist/web/sharedWebGL2Shaders.js +408 -0
  507. package/dist/web/sharedWebGPUOptions.d.ts +41 -0
  508. package/dist/web/sharedWebGPUOptions.js +130 -0
  509. package/dist/web/text.d.ts +3 -0
  510. package/dist/web/text.js +3 -0
  511. package/dist/web/textInput.d.ts +3 -0
  512. package/dist/web/textInput.js +3 -0
  513. package/dist/web/video.d.ts +3 -0
  514. package/dist/web/video.js +4 -0
  515. package/dist/web/webgl2.d.ts +7 -0
  516. package/dist/web/webgl2.js +4 -0
  517. package/dist/web/webgl2LayerState.d.ts +50 -0
  518. package/dist/web/webgl2LayerState.js +102 -0
  519. package/dist/web/webgl2Native.d.ts +72 -0
  520. package/dist/web/webgl2Native.js +572 -0
  521. package/dist/web/webgl2Types.d.ts +150 -0
  522. package/dist/web/webgl2Types.js +2 -0
  523. package/dist/web/webgpu.d.ts +6 -0
  524. package/dist/web/webgpu.js +2 -0
  525. package/dist/web/webgpuBindingCache.d.ts +26 -0
  526. package/dist/web/webgpuBindingCache.js +223 -0
  527. package/dist/web/webgpuBufferPool.d.ts +51 -0
  528. package/dist/web/webgpuBufferPool.js +58 -0
  529. package/dist/web/webgpuImageResidency.d.ts +56 -0
  530. package/dist/web/webgpuImageResidency.js +65 -0
  531. package/dist/web/webgpuLifetime.d.ts +45 -0
  532. package/dist/web/webgpuLifetime.js +64 -0
  533. package/dist/web/webgpuRetentionPool.d.ts +66 -0
  534. package/dist/web/webgpuRetentionPool.js +85 -0
  535. package/dist/web/webgpuSharedPass.d.ts +7 -0
  536. package/dist/web/webgpuSharedPass.js +293 -0
  537. package/dist/web/webgpuSharedResolvePass.d.ts +3 -0
  538. package/dist/web/webgpuSharedResolvePass.js +34 -0
  539. package/dist/web/world3d/Audio3D.d.ts +85 -0
  540. package/dist/web/world3d/Audio3D.js +271 -0
  541. package/dist/web/world3d/BrowserPlay3D.d.ts +295 -0
  542. package/dist/web/world3d/BrowserPlay3D.js +1256 -0
  543. package/dist/web/world3d/FlyControls3D.d.ts +59 -0
  544. package/dist/web/world3d/FlyControls3D.js +162 -0
  545. package/dist/web/world3d/FollowControls3D.d.ts +31 -0
  546. package/dist/web/world3d/FollowControls3D.js +119 -0
  547. package/dist/web/world3d/OrbitControls3D.d.ts +58 -0
  548. package/dist/web/world3d/OrbitControls3D.js +189 -0
  549. package/dist/web/world3d/TransformControls3D.d.ts +37 -0
  550. package/dist/web/world3d/TransformControls3D.js +128 -0
  551. package/dist/web/world3d/WebGL2Renderer3D.d.ts +136 -0
  552. package/dist/web/world3d/WebGL2Renderer3D.js +1175 -0
  553. package/dist/web/world3d/WebGPURenderer3D.d.ts +112 -0
  554. package/dist/web/world3d/WebGPURenderer3D.js +1916 -0
  555. package/dist/web/world3d/World3DView.d.ts +54 -0
  556. package/dist/web/world3d/World3DView.js +79 -0
  557. package/dist/web/world3d/app3D.d.ts +143 -0
  558. package/dist/web/world3d/app3D.js +305 -0
  559. package/dist/web/world3d/assets3D.d.ts +39 -0
  560. package/dist/web/world3d/assets3D.js +112 -0
  561. package/dist/web/world3d/atmosphere3D.d.ts +56 -0
  562. package/dist/web/world3d/atmosphere3D.js +193 -0
  563. package/dist/web/world3d/canvasFont3D.d.ts +21 -0
  564. package/dist/web/world3d/canvasFont3D.js +165 -0
  565. package/dist/web/world3d/frame3D.d.ts +144 -0
  566. package/dist/web/world3d/frame3D.js +388 -0
  567. package/dist/web/world3d/gpuResources3D.d.ts +98 -0
  568. package/dist/web/world3d/gpuResources3D.js +901 -0
  569. package/dist/web/world3d/host3D.d.ts +24 -0
  570. package/dist/web/world3d/host3D.js +61 -0
  571. package/dist/web/world3d/index.d.ts +40 -0
  572. package/dist/web/world3d/index.js +24 -0
  573. package/dist/web/world3d/loaders3D.d.ts +27 -0
  574. package/dist/web/world3d/loaders3D.js +138 -0
  575. package/dist/web/world3d/markers3D.d.ts +53 -0
  576. package/dist/web/world3d/markers3D.js +130 -0
  577. package/dist/web/world3d/materialWebGL23D.d.ts +34 -0
  578. package/dist/web/world3d/materialWebGL23D.js +218 -0
  579. package/dist/web/world3d/overlay3D.d.ts +47 -0
  580. package/dist/web/world3d/overlay3D.js +187 -0
  581. package/dist/web/world3d/post3D.d.ts +116 -0
  582. package/dist/web/world3d/post3D.js +462 -0
  583. package/dist/web/world3d/postWebGL23D.d.ts +24 -0
  584. package/dist/web/world3d/postWebGL23D.js +237 -0
  585. package/dist/web/world3d/postWebGPU3D.d.ts +23 -0
  586. package/dist/web/world3d/postWebGPU3D.js +255 -0
  587. package/dist/web/world3d/probe3D.d.ts +15 -0
  588. package/dist/web/world3d/probe3D.js +66 -0
  589. package/dist/web/world3d/shaders3D.d.ts +43 -0
  590. package/dist/web/world3d/shaders3D.js +851 -0
  591. package/dist/web/world3d/stats3D.d.ts +34 -0
  592. package/dist/web/world3d/stats3D.js +81 -0
  593. package/dist/web/world3d/webGL2FrameMetrics3D.d.ts +71 -0
  594. package/dist/web/world3d/webGL2FrameMetrics3D.js +185 -0
  595. package/dist/web/world3d/webgpu.d.ts +37 -0
  596. package/dist/web/world3d/webgpu.js +23 -0
  597. package/dist/web/world3d/webgpuPacking3D.d.ts +13 -0
  598. package/dist/web/world3d/webgpuPacking3D.js +85 -0
  599. package/dist/web/world3d/wgsl3D.d.ts +68 -0
  600. package/dist/web/world3d/wgsl3D.js +781 -0
  601. package/package.json +220 -4
@@ -0,0 +1,223 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ import { EgretError } from '@egret/runtime';
3
+ import { bindKeyboardSurface, createKeyboardInput } from '#egret-keyboard-input';
4
+ const apply = Reflect.apply, owned = new WeakSet();
5
+ function getter(prototype, name) {
6
+ const value = prototype === undefined ? undefined : Object.getOwnPropertyDescriptor(prototype, name)?.get;
7
+ if (typeof value !== 'function')
8
+ throw new EgretError('KEYBOARD_INPUT_SURFACE_INVALID');
9
+ return value;
10
+ }
11
+ function method(prototype, name) {
12
+ const value = prototype === undefined ? undefined : Object.getOwnPropertyDescriptor(prototype, name)?.value;
13
+ if (typeof value !== 'function')
14
+ throw new EgretError('KEYBOARD_INPUT_SURFACE_INVALID');
15
+ return value;
16
+ }
17
+ /** Canvas-local native keyboard bridge. Canvas focus remains application-owned. */
18
+ export function createBrowserKeyboardInput(options) {
19
+ const input = createKeyboardInput(options), bridge = bindKeyboardSurface(input), surface = bridge.surface;
20
+ const pairs = [];
21
+ let closed = false, paused = false, busy = false, claimed = false;
22
+ let removeClose = () => { }, removeInteractive = () => { }, restore = () => { };
23
+ let remove = () => { }, add = () => { };
24
+ function removePair(pair) {
25
+ if (pair.adding || pair.removed)
26
+ return;
27
+ pair.removed = true;
28
+ apply(remove, pair.target, [pair.type, pair.listener, false]);
29
+ }
30
+ function detach() {
31
+ let failure, failed = false;
32
+ for (const pair of pairs.slice().reverse())
33
+ try {
34
+ removePair(pair);
35
+ }
36
+ catch (cause) {
37
+ if (!failed) {
38
+ failed = true;
39
+ failure = cause;
40
+ }
41
+ }
42
+ if (failed)
43
+ throw failure;
44
+ }
45
+ function cleanup() {
46
+ if (closed)
47
+ return;
48
+ closed = true;
49
+ const failures = [];
50
+ for (const action of [detach, restore, removeClose, removeInteractive])
51
+ try {
52
+ action();
53
+ }
54
+ catch (cause) {
55
+ failures.push(cause);
56
+ }
57
+ if (claimed && !pairs.some(pair => pair.adding)) {
58
+ owned.delete(surface);
59
+ claimed = false;
60
+ }
61
+ for (const cause of failures)
62
+ bridge.report(cause);
63
+ }
64
+ function fail(cause) {
65
+ try {
66
+ input.dispose();
67
+ }
68
+ catch (secondary) {
69
+ bridge.report(secondary);
70
+ }
71
+ finally {
72
+ cleanup();
73
+ }
74
+ bridge.report(cause);
75
+ }
76
+ try {
77
+ removeClose = bridge.onClose(cleanup);
78
+ const win = globalThis.window, document = globalThis.document;
79
+ if (win === undefined || document === undefined)
80
+ throw new EgretError('KEYBOARD_INPUT_SURFACE_INVALID');
81
+ const canvasBrand = getter(globalThis.HTMLCanvasElement?.prototype, 'width'), ownerDocument = getter(globalThis.Node?.prototype, 'ownerDocument'), connected = getter(globalThis.Node?.prototype, 'isConnected');
82
+ const defaultView = getter(globalThis.Document?.prototype, 'defaultView'), active = getter(globalThis.Document?.prototype, 'activeElement'), visibility = getter(globalThis.Document?.prototype, 'visibilityState');
83
+ const target = getter(globalThis.Event?.prototype, 'target'), type = getter(globalThis.Event?.prototype, 'type'), prevent = method(globalThis.Event?.prototype, 'preventDefault');
84
+ const code = getter(globalThis.KeyboardEvent?.prototype, 'code'), key = getter(globalThis.KeyboardEvent?.prototype, 'key'), repeat = getter(globalThis.KeyboardEvent?.prototype, 'repeat'), composing = getter(globalThis.KeyboardEvent?.prototype, 'isComposing');
85
+ const alt = getter(globalThis.KeyboardEvent?.prototype, 'altKey'), ctrl = getter(globalThis.KeyboardEvent?.prototype, 'ctrlKey'), meta = getter(globalThis.KeyboardEvent?.prototype, 'metaKey'), shift = getter(globalThis.KeyboardEvent?.prototype, 'shiftKey');
86
+ const getAttribute = method(globalThis.Element?.prototype, 'getAttribute'), setAttribute = method(globalThis.Element?.prototype, 'setAttribute'), removeAttribute = method(globalThis.Element?.prototype, 'removeAttribute');
87
+ add = method(globalThis.EventTarget?.prototype, 'addEventListener');
88
+ remove = method(globalThis.EventTarget?.prototype, 'removeEventListener');
89
+ function authentic() {
90
+ apply(canvasBrand, surface, []);
91
+ if (apply(ownerDocument, surface, []) !== document ||
92
+ apply(defaultView, document, []) !== win ||
93
+ apply(connected, surface, []) !== true)
94
+ throw new EgretError('KEYBOARD_INPUT_SURFACE_INVALID');
95
+ }
96
+ authentic();
97
+ if (owned.has(surface))
98
+ throw new EgretError('KEYBOARD_INPUT_IN_USE');
99
+ owned.add(surface);
100
+ claimed = true;
101
+ if (apply(getAttribute, surface, ['tabindex']) === null) {
102
+ // Restore only the exact value still owned by this bridge.
103
+ restore = () => {
104
+ if (apply(getAttribute, surface, ['tabindex']) === '0')
105
+ apply(removeAttribute, surface, ['tabindex']);
106
+ };
107
+ apply(setAttribute, surface, ['tabindex', '0']);
108
+ }
109
+ function cancel(reason) {
110
+ input.cancel(reason);
111
+ }
112
+ function keyboard(event, down) {
113
+ authentic();
114
+ if (apply(active, document, []) !== surface ||
115
+ apply(target, event, []) !== surface ||
116
+ apply(visibility, document, []) !== 'visible')
117
+ return;
118
+ const physical = apply(code, event, []), logical = apply(key, event, []);
119
+ if (apply(composing, event, []) === true || logical === 'Process' || logical === 'Dead' || physical === '')
120
+ return;
121
+ const sample = {
122
+ code: physical,
123
+ key: logical,
124
+ repeat: apply(repeat, event, []),
125
+ altKey: apply(alt, event, []),
126
+ ctrlKey: apply(ctrl, event, []),
127
+ metaKey: apply(meta, event, []),
128
+ shiftKey: apply(shift, event, [])
129
+ };
130
+ const prevented = down ? input.keyDown(sample) : input.keyUp(sample);
131
+ // Prevention belongs to this original native event even if its genuine
132
+ // handler synchronously suspended, closed, or handed focus to an editor.
133
+ if (prevented)
134
+ apply(prevent, event, []);
135
+ if (closed || paused)
136
+ return;
137
+ if (apply(active, document, []) !== surface)
138
+ return;
139
+ if (!prevented && down && logical === 'Tab' && !sample.altKey && !sample.ctrlKey && !sample.metaKey) {
140
+ const next = input.moveFocus(sample.shiftKey ? 'previous' : 'next');
141
+ if (next !== undefined)
142
+ apply(prevent, event, []);
143
+ }
144
+ }
145
+ function listen(eventTarget, eventType, action) {
146
+ const listener = event => {
147
+ if (closed || paused)
148
+ return;
149
+ if (busy && (eventType === 'keydown' || eventType === 'keyup')) {
150
+ fail(new EgretError('KEYBOARD_INPUT_REENTRANT'));
151
+ return;
152
+ }
153
+ const wasBusy = busy;
154
+ busy = true;
155
+ try {
156
+ if (apply(type, event, []) === eventType)
157
+ action(event);
158
+ }
159
+ catch (cause) {
160
+ fail(cause);
161
+ }
162
+ finally {
163
+ busy = wasBusy;
164
+ }
165
+ };
166
+ pairs.push({ target: eventTarget, type: eventType, listener, adding: false, removed: true });
167
+ }
168
+ function attach() {
169
+ authentic();
170
+ for (const pair of pairs) {
171
+ if (closed || paused)
172
+ break;
173
+ if (!pair.removed)
174
+ continue;
175
+ pair.removed = false;
176
+ pair.adding = true;
177
+ try {
178
+ apply(add, pair.target, [pair.type, pair.listener, false]);
179
+ }
180
+ finally {
181
+ pair.adding = false;
182
+ if (closed || paused)
183
+ removePair(pair);
184
+ }
185
+ }
186
+ if (closed && claimed) {
187
+ owned.delete(surface);
188
+ claimed = false;
189
+ }
190
+ }
191
+ listen(surface, 'keydown', event => keyboard(event, true));
192
+ listen(win, 'keyup', event => keyboard(event, false));
193
+ listen(surface, 'blur', () => cancel('blur'));
194
+ listen(win, 'blur', () => cancel('blur'));
195
+ listen(win, 'pagehide', () => cancel('pagehide'));
196
+ listen(document, 'visibilitychange', () => {
197
+ if (apply(visibility, document, []) !== 'visible')
198
+ cancel('hidden');
199
+ });
200
+ removeInteractive = bridge.onInteractive(value => {
201
+ paused = !value;
202
+ if (paused)
203
+ detach();
204
+ else
205
+ attach();
206
+ });
207
+ attach();
208
+ if (closed || input.getSnapshot().state === 'closed')
209
+ throw new EgretError('KEYBOARD_INPUT_CLOSED');
210
+ return input;
211
+ }
212
+ catch (cause) {
213
+ cleanup();
214
+ try {
215
+ input.dispose();
216
+ }
217
+ catch (secondary) {
218
+ bridge.report(secondary);
219
+ }
220
+ throw cause;
221
+ }
222
+ }
223
+ //# sourceMappingURL=BrowserKeyboardInput.js.map
@@ -0,0 +1,417 @@
1
+ import { Sprite } from '@egret/engine';
2
+ import type { DisplayObject, Engine, Graphics, Motion, Scope } from '@egret/engine';
3
+ import type { Random } from '@egret/engine/kit';
4
+ import type { BrowserGame, BrowserGameBackend } from './game.js';
5
+ import type { SfxRecipe } from './playSfx.js';
6
+ import type { PlayStickOptions, PlayTouchButtonOptions } from './playTouch.js';
7
+ import type { MusicOptions, MusicMood } from './playMusic.js';
8
+ import type { PlayBar, PlayBarOptions, PlayMenuOptions, PlaySayOptions, PlayToastOptions } from './playWidgets.js';
9
+ /** A whole small game to start: its size and background, where it goes on the page, its setup and update, its seed, backend and save key. */
10
+ export interface PlayOptions {
11
+ /** The size of the stage, in the game's own units: whole numbers above 0. The canvas is scaled to fit. */
12
+ readonly width: number;
13
+ readonly height: number;
14
+ /** What a frame is cleared to. Black unless given. */
15
+ readonly background?: number;
16
+ /** Clears a frame to nothing, so that what the page has under the canvas shows through. `background` is then not drawn. */
17
+ readonly transparent?: boolean;
18
+ /** Where the canvas goes. Without it the game fills the window. */
19
+ readonly parent?: HTMLElement;
20
+ /** A canvas of the page to draw on, as it is placed there. Without it one is made and fitted. */
21
+ readonly canvas?: HTMLCanvasElement;
22
+ /** Set false for a silent game or an application-owned mixer. Skips the built-in context and sound preparation. */
23
+ readonly audio?: boolean;
24
+ /** Builds the game. Updates begin when it has returned, or when the promise it returns has resolved. */
25
+ readonly setup?: (game: PlayGame) => void | Promise<void>;
26
+ /** One step of the game, with the seconds since the step before. */
27
+ readonly update?: (seconds: number, game: PlayGame) => void;
28
+ /** Told of what stopped the game. Without it the failure is thrown where the console shows it. */
29
+ readonly onError?: (error: unknown) => void;
30
+ /** The seed of `game.random`. A different one each time unless given. */
31
+ readonly seed?: number | string;
32
+ /** `'auto'` unless given. */
33
+ readonly backend?: 'auto' | BrowserGameBackend;
34
+ /**
35
+ * How translucent things mix with what is under them. `'srgb'` unless given: as a 2D canvas and Egret 5 mix
36
+ * them, so a white at 10% over a dark ground is a faint white. `'linear'` mixes light as it is, as the engine
37
+ * does by default; translucent light colours then look stronger.
38
+ */
39
+ readonly blendSpace?: 'linear' | 'srgb';
40
+ /** Under what name `game.save` keeps its values in the page's storage. The page's path unless given. */
41
+ readonly saveKey?: string;
42
+ /**
43
+ * Less motion for a player who asks for it: shakes are left out and flashes are faint. The system's
44
+ * `prefers-reduced-motion` unless given, followed as the player changes it; `game.reducedMotion` changes it later.
45
+ */
46
+ readonly reducedMotion?: boolean;
47
+ }
48
+ /** Text to show: where, how large, its color and alignment, whether bold, its layer, baseline and locale. */
49
+ export interface PlayTextOptions {
50
+ readonly x?: number;
51
+ readonly y?: number;
52
+ /** The height of the letters, in stage units. 24 unless given. */
53
+ readonly size?: number;
54
+ /** White unless given. */
55
+ readonly color?: number;
56
+ /** Which part of the words `x` is: their left end (the default), their middle or their right end. */
57
+ readonly align?: 'left' | 'center' | 'right';
58
+ readonly bold?: boolean;
59
+ /**
60
+ * Where the text goes. `'ui'` (the default) stays put over the game; `'world'` moves with `game.view` and the
61
+ * shake; a sprite makes the text its child, so the two move, turn, fade and go together, and `x` and `y` are
62
+ * then measured from the sprite's own origin.
63
+ */
64
+ readonly layer?: 'ui' | 'world' | Sprite;
65
+ /** Which part of the words `y` is: their top (the default) or their middle. */
66
+ readonly baseline?: 'top' | 'middle';
67
+ /** The language of the words, as `'zh'` or `'en'`. Chosen from the words unless given. */
68
+ readonly locale?: string;
69
+ }
70
+ /** A line of text: a sprite to place, fade, tween and remove like any other, with words that can be changed. */
71
+ export declare class PlayText extends Sprite {
72
+ #private;
73
+ constructor(text: string, changed: (text: string) => void, color?: number, size?: number, styled?: (style: {
74
+ readonly color?: number;
75
+ readonly size?: number;
76
+ }) => void);
77
+ get text(): string;
78
+ set text(value: string | number);
79
+ /** The colour of the words, `0xRRGGBB`. What is not a colour is not taken. */
80
+ get color(): number;
81
+ set color(value: number);
82
+ /** The size of the words. What is not a size above 0 is not taken. */
83
+ get size(): number;
84
+ set size(value: number);
85
+ }
86
+ /** A map of tiles to make: the size of a tile, where its top left corner is, its colours, which characters are solid, and its layer. */
87
+ export interface PlayTilesOptions {
88
+ /** The width and height of one tile; 32 unless given. */
89
+ readonly size?: number;
90
+ readonly x?: number;
91
+ readonly y?: number;
92
+ /** The colour of each character's tiles; `#` is grey and the rest are not drawn unless given. */
93
+ readonly colors?: Readonly<Record<string, number>>;
94
+ /** The characters that are solid; `'#'` unless given. */
95
+ readonly solid?: string;
96
+ readonly layer?: Sprite;
97
+ }
98
+ /** A map of tiles: read and change its cells, and push a sprite out of its solid ones. */
99
+ export interface PlayTiles {
100
+ /** The sprite the tiles are drawn in. */
101
+ readonly sprite: Sprite;
102
+ readonly columns: number;
103
+ readonly rows: number;
104
+ readonly size: number;
105
+ /** The character of a cell, or `''` outside the map. */
106
+ at(column: number, row: number): string;
107
+ /** Changes the character of a cell and draws the map again. */
108
+ set(column: number, row: number, character: string): void;
109
+ /** The cell under a point of the layer the map is in: `{ column, row }`. */
110
+ cellAt(x: number, y: number): {
111
+ column: number;
112
+ row: number;
113
+ };
114
+ /** Whether a point of the layer the map is in is on a solid tile. */
115
+ solidAt(x: number, y: number): boolean;
116
+ /** How far to move `a` out of the solid tiles it overlaps, `{ x, y }`, or `undefined` when it overlaps none. */
117
+ pushOut(a: DisplayObject): {
118
+ x: number;
119
+ y: number;
120
+ } | undefined;
121
+ }
122
+ /** The keyboard of a play game: what is held, pressed and released, and axes from the arrow and WASD keys. */
123
+ export interface PlayKeys {
124
+ /** Whether any of the keys is held. A key is `'left'`, `'right'`, `'up'`, `'down'`, `'space'`, `'enter'`, `'escape'`, `'shift'`, a letter, a digit, or a `KeyboardEvent.code`. */
125
+ down(...keys: string[]): boolean;
126
+ /** Whether any of the keys went down since the last update. */
127
+ pressed(...keys: string[]): boolean;
128
+ /** Whether any of the keys came up since the last update. */
129
+ released(...keys: string[]): boolean;
130
+ /**
131
+ * The arrows and WASD as a direction: x and y from -1 to 1, y down, of length 1 at most. The left stick of a
132
+ * gamepad counts as well, as far as it is pushed.
133
+ */
134
+ axis(): {
135
+ x: number;
136
+ y: number;
137
+ };
138
+ /** The right stick of a gamepad, for looking or aiming: x and y from -1 to 1, y down; 0 and 0 without one. */
139
+ look(): {
140
+ x: number;
141
+ y: number;
142
+ };
143
+ }
144
+ /** The pointer of a play game: where it is, what it pressed, swipes, wheel and pointer lock. */
145
+ export interface PlayPointer {
146
+ /** Where the mouse, pen or finger is, on the stage. It follows the mouse whether or not a button is held. */
147
+ readonly x: number;
148
+ readonly y: number;
149
+ /** Whether a button or a finger is down. */
150
+ readonly down: boolean;
151
+ /** Whether it went down, or came up, since the last update. */
152
+ readonly pressed: boolean;
153
+ readonly released: boolean;
154
+ /** The way of a swipe that ended since the last update. */
155
+ readonly swipe: 'left' | 'right' | 'up' | 'down' | undefined;
156
+ /** Whether the pointer is over what a sprite draws, taken as an upright box. */
157
+ over(node: DisplayObject): boolean;
158
+ /**
159
+ * How far the mouse moved since the last update, in pixels of the screen: for looking about with the mouse. It
160
+ * goes on counting at the edge of the screen while the pointer is locked.
161
+ */
162
+ readonly dx: number;
163
+ readonly dy: number;
164
+ /**
165
+ * Hides the cursor and keeps the mouse to the game, for looking about. A browser allows it only after a click, so
166
+ * call it from a tap or from an update where `pressed` is true; Escape gives the mouse back.
167
+ */
168
+ lock(): void;
169
+ /** Gives the mouse back. */
170
+ unlock(): void;
171
+ /** Whether the pointer is locked to the game. */
172
+ readonly locked: boolean;
173
+ /** The turn of the mouse wheel since the last update: above 0 towards the user. */
174
+ readonly wheel: number;
175
+ }
176
+ /** A tween of `game.tween`: a motion that can be waited for. */
177
+ export type PlayMotion<T extends object> = Motion<T> & {
178
+ /** Resolves when the motion has finished or been stopped: `await game.tween(s).to({ x: 9 }, 0.2).done`. */
179
+ readonly done: Promise<void>;
180
+ };
181
+ /** An image to show: where, how large, whether smoothed, and its layer. */
182
+ export interface PlayImageOptions {
183
+ readonly x?: number;
184
+ readonly y?: number;
185
+ readonly width?: number;
186
+ readonly height?: number;
187
+ readonly smooth?: boolean;
188
+ readonly layer?: 'ui' | 'world' | Sprite;
189
+ }
190
+ /** A button to show: where, how large, its colors, text size and layer. */
191
+ export interface PlayButtonOptions {
192
+ readonly x: number;
193
+ readonly y: number;
194
+ /** 160 by 44 unless given. */
195
+ readonly width?: number;
196
+ readonly height?: number;
197
+ readonly color?: number;
198
+ readonly textColor?: number;
199
+ /** The height of the letters; 0.45 of the button's height unless given. */
200
+ readonly size?: number;
201
+ /** `game.ui` unless given. */
202
+ readonly layer?: Sprite;
203
+ }
204
+ /** A button: a sprite whose middle is at (x, y), with its words in `label`. */
205
+ export type PlayButton = Sprite & {
206
+ readonly label: PlayText;
207
+ };
208
+ /** A sound that goes on until it is stopped: music, an engine, the wind. Change it while it plays. */
209
+ export interface PlayLoop {
210
+ /** 0 to 1. */
211
+ volume: number;
212
+ /** 1 as written, 2 an octave up, from 0.25 to 4: an engine's pitch follows its speed. */
213
+ pitch: number;
214
+ /** -1 the left side alone, 1 the right alone. */
215
+ pan: number;
216
+ /** Ends it, over `seconds` of fading, 0.1 unless given. Stopping it twice does nothing. */
217
+ stop(seconds?: number): void;
218
+ readonly stopped: boolean;
219
+ }
220
+ /** The music of a play game: play or stop it, and set its intensity, volume and mood. */
221
+ export interface PlayMusic {
222
+ /**
223
+ * Writes a piece in a mood (`'calm'`, `'mystery'`, `'tense'`, `'battle'` or `'triumph'`), or from
224
+ * `{ mood, seed, tempo, bars }`, and loops it; a piece already playing fades out. It is heard once the page has had
225
+ * its first key or click. A restart stops it.
226
+ */
227
+ play(mood?: MusicMood | MusicOptions): Promise<void>;
228
+ /** Fades the music out over `seconds`, 1 unless given. */
229
+ stop(seconds?: number): void;
230
+ /**
231
+ * 0 to 1, 0.5 unless set: how much of the piece plays. The pad of held chords always; the bass from about 0.2, the
232
+ * drums from about 0.5, the tune from about 0.75. A change is heard over a second or so.
233
+ */
234
+ intensity: number;
235
+ /** 0 to 1, 0.6 unless set; the volume and the mute of the sound effects apply too. */
236
+ volume: number;
237
+ readonly mood: MusicMood | undefined;
238
+ }
239
+ /** The sound effects of a play game: play or loop one by name, define new ones, and set the volume. */
240
+ export interface PlaySfx {
241
+ /** Plays an effect by name: one of `names`. `pitch` is 1 as written, 2 an octave up. */
242
+ play(name: string, options?: {
243
+ readonly volume?: number;
244
+ readonly pitch?: number;
245
+ readonly pan?: number;
246
+ }): void;
247
+ /**
248
+ * Plays an effect again and again until it is stopped: `hum` and `wind` are made to be looped, and a list of tones
249
+ * defined with `define` loops as a tune. `restart` and `dispose` stop every loop; a pause holds them.
250
+ */
251
+ loop(name: string, options?: {
252
+ readonly volume?: number;
253
+ readonly pitch?: number;
254
+ readonly pan?: number;
255
+ readonly fadeIn?: number;
256
+ }): PlayLoop;
257
+ /** Adds an effect, or replaces one. It can be played from the next update on. */
258
+ define(name: string, recipe: SfxRecipe): void;
259
+ /** The names that can be played. */
260
+ readonly names: readonly string[];
261
+ /** 0 to 1, for every effect. */
262
+ volume: number;
263
+ muted: boolean;
264
+ }
265
+ /** A burst of particles: its color and count, how fast and how long they fly, their size and gravity. */
266
+ export interface PlayBurstOptions {
267
+ readonly color?: number;
268
+ /** How many pieces; 12 unless given. */
269
+ readonly count?: number;
270
+ /** How fast they fly, in units a second; 160 unless given. */
271
+ readonly speed?: number;
272
+ /** How long they last, in seconds; 0.5 unless given. */
273
+ readonly life?: number;
274
+ /** Their radius; 3 unless given. */
275
+ readonly size?: number;
276
+ /** How hard they fall, in units a second each second; 0 unless given. */
277
+ readonly gravity?: number;
278
+ }
279
+ /**
280
+ * The listener the Engine is given for a tap. A listener of the Engine runs to its end and returns nothing, and one
281
+ * that returns a promise is refused, which ends pointer input; so what the game's function returns is not handed on.
282
+ * When it is a promise, as an `async` function returns, its failure is told as the function's own would be.
283
+ */
284
+ export declare function tapListener(callback: () => unknown, fail: (cause: unknown) => void): () => void;
285
+ /** Everything a small game is given: its world, UI and view, keys and pointer, sound and random numbers, and calls that make, move, test and time things. */
286
+ export interface PlayGame {
287
+ readonly width: number;
288
+ readonly height: number;
289
+ /** Seconds of play so far: it stands still while the game is paused or stopped by `hitStop`. */
290
+ readonly time: number;
291
+ /** The layer the game is drawn in. It moves with `view` and shakes. */
292
+ readonly world: Sprite;
293
+ /** A layer over the world that stays put: scores, buttons, messages. */
294
+ readonly ui: Sprite;
295
+ /** Which part of the world is seen: the world's point (`view.x`, `view.y`) is drawn at the stage's corner. */
296
+ readonly view: {
297
+ x: number;
298
+ y: number;
299
+ };
300
+ readonly keys: PlayKeys;
301
+ readonly pointer: PlayPointer;
302
+ readonly sfx: PlaySfx;
303
+ /** Random numbers that repeat for the same `seed`: `int(1, 6)`, `range(0, 1)`, `chance(0.25)`, `pick(list)`. */
304
+ readonly random: Random;
305
+ /** 1 as played; 0.5 is slow motion. */
306
+ timeScale: number;
307
+ /** A new sprite in the world (or in `layer`), with what `draw` draws in it. */
308
+ sprite(draw?: (graphics: Graphics) => void, layer?: Sprite): Sprite;
309
+ /** A filled rectangle whose middle is at (x, y), in the world or in `layer`. */
310
+ rect(x: number, y: number, width: number, height: number, color: number, layer?: Sprite): Sprite;
311
+ /** A filled circle whose middle is at (x, y), in the world or in `layer`. */
312
+ circle(x: number, y: number, radius: number, color: number, layer?: Sprite): Sprite;
313
+ /** A button with words on it, in the `ui` layer. `onTap` is called when it is tapped or clicked. */
314
+ button(words: string, options: PlayButtonOptions, onTap: () => void): PlayButton;
315
+ /** Puts a sprite in front of the others of its layer. Sprites are otherwise drawn in the order they were made. */
316
+ toFront(node: DisplayObject): void;
317
+ /** A line of text. It appears a moment after it is made; nothing has to wait for it. */
318
+ text(text: string | number, options?: PlayTextOptions): PlayText;
319
+ /** Takes a sprite off the stage and ends it. */
320
+ remove(node: DisplayObject): void;
321
+ /** Calls a function when the sprite is tapped or clicked. */
322
+ onTap(node: DisplayObject, callback: () => void): void;
323
+ /** Whether what two sprites draw overlaps, taken as upright boxes. `shrink` takes that much off every side of both. */
324
+ overlaps(a: DisplayObject, b: DisplayObject, shrink?: number): boolean;
325
+ /** The first of the sprites that overlaps `a`, or undefined. */
326
+ hits<T extends DisplayObject>(a: DisplayObject, others: readonly T[], shrink?: number): T | undefined;
327
+ /** Every one of the sprites that overlaps `a`. */
328
+ hitsAll<T extends DisplayObject>(a: DisplayObject, others: readonly T[], shrink?: number): T[];
329
+ /**
330
+ * How far to move `a` so that it no longer overlaps `b`, by the shorter way out: `{ x, y }`, one of them 0, or
331
+ * undefined when they do not overlap. A `y` below 0 means `a` was pushed up, onto `b`.
332
+ */
333
+ pushOut(a: DisplayObject, b: DisplayObject): {
334
+ x: number;
335
+ y: number;
336
+ } | undefined;
337
+ /** Whether the middles of what two sprites draw are within `distance` of each other: a test of circles. */
338
+ near(a: DisplayObject, b: DisplayObject, distance: number): boolean;
339
+ /**
340
+ * A map of tiles from rows of characters, drawn as one sprite: `game.tiles(['#####', '#...#', '#####'], { size: 32 })`.
341
+ * `#` is solid unless `solid` says which characters are; `colors` gives each character its colour.
342
+ */
343
+ tiles(rows: readonly string[], options?: PlayTilesOptions): PlayTiles;
344
+ /** The colour a fraction `t` of the way from `a` to `b`, both `0xRRGGBB`: `game.mix(0x000000, 0xffffff, 0.5)`. */
345
+ mix(a: number, b: number, t: number): number;
346
+ /** Moves numbers of an object over time: `game.tween(s).to({ x: 100, alpha: 0 }, 0.3, 'quadOut')`. It starts by itself. */
347
+ tween<T extends object>(target: T): PlayMotion<T>;
348
+ /** Calls a function once, after seconds of play. The function returned calls it off. */
349
+ after(seconds: number, callback: () => void): () => void;
350
+ /** A promise that resolves after seconds of play: `await game.wait(0.3)`. */
351
+ wait(seconds: number): Promise<void>;
352
+ /** Calls a function again and again, seconds of play apart. The function returned ends it. */
353
+ every(seconds: number, callback: () => void): () => void;
354
+ /** Whether shakes are left out and flashes faint, for a player who asks for less motion. A settings menu may change it. */
355
+ reducedMotion: boolean;
356
+ /** Shakes the world by up to `amount` units for `seconds`. Nothing while `reducedMotion` is on. */
357
+ shake(amount?: number, seconds?: number): void;
358
+ /** Covers the stage with a colour that fades away over `seconds`; faintly while `reducedMotion` is on. */
359
+ flash(color?: number, seconds?: number): void;
360
+ /** Stops play for a moment, as a hard hit does: no updates and no timers for `seconds`. */
361
+ hitStop(seconds?: number): void;
362
+ /** Throws pieces out from a point of the world. */
363
+ burst(x: number, y: number, options?: PlayBurstOptions): void;
364
+ /** Keeps a value in the page's storage, as JSON, and reads one back. */
365
+ save(key: string, value: unknown): void;
366
+ load<T>(key: string, fallback: T): T;
367
+ /** Stops updates and timers; `update` is not called while paused. The keys and the pointer can still be asked from a tap or a timer of the page. */
368
+ pause(): void;
369
+ resume(): void;
370
+ readonly paused: boolean;
371
+ /**
372
+ * Starts the game again: everything in the world and the `ui` layer is removed, timers and tweens are called
373
+ * off, and `setup` runs again. Concurrent requests share one promise. Updates resume on success; a failed setup can be retried.
374
+ */
375
+ restart(): Promise<void>;
376
+ /**
377
+ * A picture from an address (a PNG beside the page, say), its middle at `x`, `y`, scaled to `width` and `height`.
378
+ * Given one of the two, it keeps its shape; given neither, its own size. It is smooth, and drawn from its smaller
379
+ * copies when small, unless `smooth: false`, which keeps every texel sharp, for pixel art. It goes on the world
380
+ * layer unless given another, and is a sprite to move, turn, fade and remove.
381
+ */
382
+ image(url: string, options?: PlayImageOptions): Promise<Sprite>;
383
+ /** A bar of health, time or power, on the ui layer unless given another; set its `value` and it slides there. */
384
+ bar(options: PlayBarOptions): PlayBar;
385
+ /** A short notice at the top of the stage that fades after `seconds`; several stack. */
386
+ toast(words: string, options?: PlayToastOptions): void;
387
+ /**
388
+ * A box of words at the bottom of the stage, shown letter by letter, with a name above it when `who` is given. A
389
+ * press of Space, Enter or Z or a tap shows the rest, and another closes it. With `choices` it gives the index of
390
+ * the answer chosen by the arrows and Enter or by a tap; without, it gives undefined. Boxes asked for while one is
391
+ * open wait their turn. A restart closes it, and the promise is then not answered.
392
+ */
393
+ say(words: string, options?: PlaySayOptions): Promise<number | undefined>;
394
+ /** A list to choose from in the middle of the stage, with a title when given; it gives the index chosen. */
395
+ menu(items: readonly string[], options?: PlayMenuOptions): Promise<number>;
396
+ /** Whether a box of words or a menu is open: an update can then leave the game alone. */
397
+ readonly asking: boolean;
398
+ /**
399
+ * A stick on the glass, near the bottom left unless placed, that counts in `keys.axis()`. It is shown once a finger
400
+ * has touched the stage, or at once with `always`.
401
+ */
402
+ touchStick(options?: PlayStickOptions): Sprite;
403
+ /** A round button on the glass that holds a key while a finger is on it: `keys.down('space')` sees it. */
404
+ touchButton(words: string, options: PlayTouchButtonOptions): Sprite;
405
+ /** Music made in code, in a mood, whose parts come in as `intensity` rises. */
406
+ readonly music: PlayMusic;
407
+ /** The game `play` is built on: its Engine, scope, loop and input, for what this entry does not cover. */
408
+ readonly browser: BrowserGame;
409
+ readonly engine: Engine;
410
+ readonly scope: Scope;
411
+ readonly canvas: HTMLCanvasElement;
412
+ /** Ends the game and takes away the canvas `play` made. */
413
+ dispose(): Promise<void>;
414
+ }
415
+ /** Starts a game in the page. See the guide `play.md`. */
416
+ export declare function play(options: PlayOptions): Promise<PlayGame>;
417
+ //# sourceMappingURL=BrowserPlay.d.ts.map