@needle-tools/engine 4.6.2 → 4.7.0-alpha

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 (1069) hide show
  1. package/CHANGELOG.md +3768 -3768
  2. package/LICENSE.md +10 -10
  3. package/README.md +64 -64
  4. package/components.needle.json +1 -1
  5. package/dist/generateMeshBVH.worker-Cdfpaq5W.js +25 -0
  6. package/dist/{gltf-progressive-Bl4okF1b.min.js → gltf-progressive-Bm9eEfgu.min.js} +1 -1
  7. package/dist/{gltf-progressive-P8b8a0qY.umd.cjs → gltf-progressive-Dn6o99rH.umd.cjs} +1 -1
  8. package/dist/{gltf-progressive-DSpdn0QT.js → gltf-progressive-GjIqwSG3.js} +2 -2
  9. package/dist/needle-engine.bundle-BEUFTdl6.min.js +1603 -0
  10. package/dist/{needle-engine.bundle-DmYMLdWP.umd.cjs → needle-engine.bundle-CK8cQ3FX.umd.cjs} +212 -184
  11. package/dist/{needle-engine.bundle-DGcStTA7.js → needle-engine.bundle-CXtflnL6.js} +8714 -8451
  12. package/dist/needle-engine.d.ts +129 -130
  13. package/dist/needle-engine.js +4 -4
  14. package/dist/needle-engine.min.js +1 -1
  15. package/dist/needle-engine.umd.cjs +1 -1
  16. package/dist/{postprocessing-CjW23fio.umd.cjs → postprocessing-8AQTeZsr.umd.cjs} +2 -2
  17. package/dist/{postprocessing-xYQWCHFu.min.js → postprocessing-BDScN9yu.min.js} +2 -2
  18. package/dist/{postprocessing-DYLNOL3W.js → postprocessing-BkxN_08g.js} +3 -3
  19. package/dist/{three-DuDKwKB8.min.js → three-Boa-jOq-.min.js} +33 -33
  20. package/dist/{three-DrqIzZTH.js → three-Bz6X1mrw.js} +4198 -4198
  21. package/dist/{three-B_hneGZr.umd.cjs → three-DMrv-4ar.umd.cjs} +4 -4
  22. package/dist/{three-examples-X3OadjXB.umd.cjs → three-examples-C7ryg8vN.umd.cjs} +3 -3
  23. package/dist/{three-examples-DaDLBuy6.min.js → three-examples-DuVhxqft.min.js} +14 -14
  24. package/dist/{three-examples-B50TT3Iu.js → three-examples-GggCDHv0.js} +5 -5
  25. package/dist/{three-mesh-ui-CxuWt7m-.js → three-mesh-ui-CLNOfsWn.js} +1 -1
  26. package/dist/{three-mesh-ui-B3p3gyUz.min.js → three-mesh-ui-CY6Izc7C.min.js} +1 -1
  27. package/dist/{three-mesh-ui-CQiIQIlA.umd.cjs → three-mesh-ui-CwlN0FUC.umd.cjs} +1 -1
  28. package/dist/{vendor-BmYIgaS1.js → vendor-BSD1RQIh.js} +3 -3
  29. package/dist/{vendor-Cavtu3CP.umd.cjs → vendor-DHr4aqIZ.umd.cjs} +3 -3
  30. package/dist/{vendor-BlSxe9JJ.min.js → vendor-zxXa3Dmr.min.js} +3 -3
  31. package/lib/asap/needle-asap.d.ts +1 -1
  32. package/lib/asap/needle-asap.js +95 -95
  33. package/lib/asap/sessiongranted.d.ts +3 -3
  34. package/lib/asap/sessiongranted.js +65 -65
  35. package/lib/asap/utils.d.ts +1 -1
  36. package/lib/asap/utils.js +3 -3
  37. package/lib/engine/analytics/index.d.ts +6 -6
  38. package/lib/engine/analytics/index.js +12 -12
  39. package/lib/engine/analytics/lcp.d.ts +3 -3
  40. package/lib/engine/analytics/lcp.js +34 -34
  41. package/lib/engine/api.d.ts +82 -82
  42. package/lib/engine/api.js +81 -81
  43. package/lib/engine/assets/index.d.ts +11 -11
  44. package/lib/engine/assets/index.js +47 -47
  45. package/lib/engine/assets/static.d.ts +1 -1
  46. package/lib/engine/assets/static.js +4 -4
  47. package/lib/engine/codegen/register_types.d.ts +1 -1
  48. package/lib/engine/codegen/register_types.js +300 -300
  49. package/lib/engine/debug/debug.d.ts +15 -15
  50. package/lib/engine/debug/debug.js +44 -44
  51. package/lib/engine/debug/debug_console.d.ts +2 -2
  52. package/lib/engine/debug/debug_console.js +307 -307
  53. package/lib/engine/debug/debug_overlay.d.ts +22 -22
  54. package/lib/engine/debug/debug_overlay.js +316 -316
  55. package/lib/engine/debug/debug_spatial_console.d.ts +2 -2
  56. package/lib/engine/debug/debug_spatial_console.js +390 -390
  57. package/lib/engine/debug/index.d.ts +2 -2
  58. package/lib/engine/debug/index.js +2 -2
  59. package/lib/engine/engine_addressables.d.ts +166 -166
  60. package/lib/engine/engine_addressables.js +608 -608
  61. package/lib/engine/engine_animation.d.ts +43 -43
  62. package/lib/engine/engine_animation.js +133 -133
  63. package/lib/engine/engine_application.d.ts +45 -45
  64. package/lib/engine/engine_application.js +104 -104
  65. package/lib/engine/engine_assetdatabase.d.ts +25 -25
  66. package/lib/engine/engine_assetdatabase.js +346 -346
  67. package/lib/engine/engine_audio.d.ts +4 -4
  68. package/lib/engine/engine_audio.js +23 -23
  69. package/lib/engine/engine_camera.d.ts +13 -13
  70. package/lib/engine/engine_camera.js +30 -30
  71. package/lib/engine/engine_components.d.ts +110 -110
  72. package/lib/engine/engine_components.js +374 -374
  73. package/lib/engine/engine_components_internal.d.ts +9 -9
  74. package/lib/engine/engine_components_internal.js +36 -36
  75. package/lib/engine/engine_constants.d.ts +10 -10
  76. package/lib/engine/engine_constants.js +41 -41
  77. package/lib/engine/engine_context.d.ts +475 -475
  78. package/lib/engine/engine_context.js +1672 -1672
  79. package/lib/engine/engine_context_registry.d.ts +71 -71
  80. package/lib/engine/engine_context_registry.js +117 -117
  81. package/lib/engine/engine_coroutine.d.ts +35 -35
  82. package/lib/engine/engine_coroutine.js +52 -52
  83. package/lib/engine/engine_create_objects.d.ts +119 -119
  84. package/lib/engine/engine_create_objects.js +320 -320
  85. package/lib/engine/engine_default_parameters.d.ts +2 -2
  86. package/lib/engine/engine_default_parameters.js +3 -3
  87. package/lib/engine/engine_editor-sync.d.ts +21 -21
  88. package/lib/engine/engine_editor-sync.js +4 -4
  89. package/lib/engine/engine_fileloader.d.ts +2 -2
  90. package/lib/engine/engine_fileloader.js +8 -8
  91. package/lib/engine/engine_gameobject.d.ts +68 -68
  92. package/lib/engine/engine_gameobject.js +619 -619
  93. package/lib/engine/engine_generic_utils.d.ts +1 -1
  94. package/lib/engine/engine_generic_utils.js +13 -13
  95. package/lib/engine/engine_gizmos.d.ts +149 -149
  96. package/lib/engine/engine_gizmos.js +530 -530
  97. package/lib/engine/engine_gltf.d.ts +12 -12
  98. package/lib/engine/engine_gltf.js +15 -15
  99. package/lib/engine/engine_gltf_builtin_components.d.ts +11 -11
  100. package/lib/engine/engine_gltf_builtin_components.js +341 -341
  101. package/lib/engine/engine_hot_reload.d.ts +8 -8
  102. package/lib/engine/engine_hot_reload.js +197 -197
  103. package/lib/engine/engine_input.d.ts +362 -362
  104. package/lib/engine/engine_input.js +1294 -1294
  105. package/lib/engine/engine_input_utils.d.ts +2 -2
  106. package/lib/engine/engine_input_utils.js +22 -22
  107. package/lib/engine/engine_instancing.d.ts +19 -19
  108. package/lib/engine/engine_instancing.js +39 -39
  109. package/lib/engine/engine_license.d.ts +11 -11
  110. package/lib/engine/engine_license.js +369 -369
  111. package/lib/engine/engine_lifecycle_api.d.ts +83 -83
  112. package/lib/engine/engine_lifecycle_api.js +106 -106
  113. package/lib/engine/engine_lifecycle_functions_internal.d.ts +32 -32
  114. package/lib/engine/engine_lifecycle_functions_internal.js +146 -146
  115. package/lib/engine/engine_lightdata.d.ts +23 -23
  116. package/lib/engine/engine_lightdata.js +91 -91
  117. package/lib/engine/engine_loaders.callbacks.d.ts +97 -97
  118. package/lib/engine/engine_loaders.callbacks.js +86 -86
  119. package/lib/engine/engine_loaders.d.ts +48 -48
  120. package/lib/engine/engine_loaders.gltf.d.ts +13 -13
  121. package/lib/engine/engine_loaders.gltf.js +62 -62
  122. package/lib/engine/engine_loaders.js +337 -337
  123. package/lib/engine/engine_lods.d.ts +31 -31
  124. package/lib/engine/engine_lods.js +146 -146
  125. package/lib/engine/engine_mainloop_utils.d.ts +32 -32
  126. package/lib/engine/engine_mainloop_utils.js +466 -466
  127. package/lib/engine/engine_math.d.ts +114 -114
  128. package/lib/engine/engine_math.js +247 -247
  129. package/lib/engine/engine_modules.d.ts +36 -36
  130. package/lib/engine/engine_modules.js +85 -85
  131. package/lib/engine/engine_networking.d.ts +260 -260
  132. package/lib/engine/engine_networking.js +764 -764
  133. package/lib/engine/engine_networking_auto.d.ts +24 -24
  134. package/lib/engine/engine_networking_auto.js +310 -310
  135. package/lib/engine/engine_networking_blob.d.ts +48 -48
  136. package/lib/engine/engine_networking_blob.js +228 -228
  137. package/lib/engine/engine_networking_files.d.ts +35 -35
  138. package/lib/engine/engine_networking_files.js +172 -172
  139. package/lib/engine/engine_networking_files_default_components.d.ts +6 -6
  140. package/lib/engine/engine_networking_files_default_components.js +42 -42
  141. package/lib/engine/engine_networking_instantiate.d.ts +100 -100
  142. package/lib/engine/engine_networking_instantiate.js +345 -345
  143. package/lib/engine/engine_networking_peer.d.ts +15 -15
  144. package/lib/engine/engine_networking_peer.js +132 -132
  145. package/lib/engine/engine_networking_streams.d.ts +123 -123
  146. package/lib/engine/engine_networking_streams.js +645 -645
  147. package/lib/engine/engine_networking_types.d.ts +22 -22
  148. package/lib/engine/engine_networking_types.js +7 -7
  149. package/lib/engine/engine_networking_utils.d.ts +2 -2
  150. package/lib/engine/engine_networking_utils.js +20 -20
  151. package/lib/engine/engine_networking_websocket.d.ts +1 -1
  152. package/lib/engine/engine_networking_websocket.js +2 -2
  153. package/lib/engine/engine_patcher.d.ts +10 -10
  154. package/lib/engine/engine_patcher.js +142 -142
  155. package/lib/engine/engine_physics.d.ts +152 -152
  156. package/lib/engine/engine_physics.js +645 -645
  157. package/lib/engine/engine_physics.types.d.ts +40 -40
  158. package/lib/engine/engine_physics.types.js +33 -33
  159. package/lib/engine/engine_physics_rapier.d.ts +147 -147
  160. package/lib/engine/engine_physics_rapier.js +1433 -1433
  161. package/lib/engine/engine_playerview.d.ts +26 -26
  162. package/lib/engine/engine_playerview.js +64 -64
  163. package/lib/engine/engine_scenelighting.d.ts +71 -71
  164. package/lib/engine/engine_scenelighting.js +226 -226
  165. package/lib/engine/engine_serialization.d.ts +3 -3
  166. package/lib/engine/engine_serialization.js +3 -3
  167. package/lib/engine/engine_serialization_builtin_serializer.d.ts +72 -72
  168. package/lib/engine/engine_serialization_builtin_serializer.js +403 -403
  169. package/lib/engine/engine_serialization_core.d.ts +94 -94
  170. package/lib/engine/engine_serialization_core.js +607 -607
  171. package/lib/engine/engine_serialization_decorator.d.ts +23 -23
  172. package/lib/engine/engine_serialization_decorator.js +66 -66
  173. package/lib/engine/engine_setup.d.ts +1 -1
  174. package/lib/engine/engine_setup.js +2 -2
  175. package/lib/engine/engine_shaders.d.ts +53 -53
  176. package/lib/engine/engine_shaders.js +252 -252
  177. package/lib/engine/engine_shims.d.ts +4 -4
  178. package/lib/engine/engine_shims.js +24 -24
  179. package/lib/engine/engine_test_utils.d.ts +39 -39
  180. package/lib/engine/engine_test_utils.js +83 -83
  181. package/lib/engine/engine_texture.d.ts +28 -28
  182. package/lib/engine/engine_texture.js +64 -64
  183. package/lib/engine/engine_three_utils.d.ts +204 -204
  184. package/lib/engine/engine_three_utils.js +784 -784
  185. package/lib/engine/engine_time.d.ts +51 -51
  186. package/lib/engine/engine_time.js +82 -82
  187. package/lib/engine/engine_time_utils.d.ts +88 -88
  188. package/lib/engine/engine_time_utils.js +215 -215
  189. package/lib/engine/engine_tonemapping.d.ts +6 -6
  190. package/lib/engine/engine_tonemapping.js +197 -197
  191. package/lib/engine/engine_types.d.ts +578 -578
  192. package/lib/engine/engine_types.js +95 -95
  193. package/lib/engine/engine_typestore.d.ts +28 -28
  194. package/lib/engine/engine_typestore.js +55 -55
  195. package/lib/engine/engine_util_decorator.d.ts +13 -13
  196. package/lib/engine/engine_util_decorator.js +116 -116
  197. package/lib/engine/engine_utils.d.ts +248 -248
  198. package/lib/engine/engine_utils.js +1012 -1012
  199. package/lib/engine/engine_utils_format.d.ts +24 -24
  200. package/lib/engine/engine_utils_format.js +239 -239
  201. package/lib/engine/engine_utils_screenshot.d.ts +159 -159
  202. package/lib/engine/engine_utils_screenshot.js +522 -522
  203. package/lib/engine/engine_utils_screenshot.xr.d.ts +5 -5
  204. package/lib/engine/engine_utils_screenshot.xr.js +90 -90
  205. package/lib/engine/engine_xr.d.ts +1 -1
  206. package/lib/engine/engine_xr.js +1 -1
  207. package/lib/engine/export/gltf/Writers.d.ts +19 -19
  208. package/lib/engine/export/gltf/Writers.js +24 -24
  209. package/lib/engine/export/gltf/index.d.ts +11 -11
  210. package/lib/engine/export/gltf/index.js +123 -123
  211. package/lib/engine/export/index.d.ts +2 -2
  212. package/lib/engine/export/index.js +2 -2
  213. package/lib/engine/export/state.d.ts +7 -7
  214. package/lib/engine/export/state.js +17 -17
  215. package/lib/engine/export/utils.d.ts +2 -2
  216. package/lib/engine/export/utils.js +7 -7
  217. package/lib/engine/extensions/EXT_texture_exr.d.ts +8 -8
  218. package/lib/engine/extensions/EXT_texture_exr.js +32 -32
  219. package/lib/engine/extensions/NEEDLE_animator_controller_model.d.ts +122 -122
  220. package/lib/engine/extensions/NEEDLE_animator_controller_model.js +95 -95
  221. package/lib/engine/extensions/NEEDLE_components.d.ts +35 -35
  222. package/lib/engine/extensions/NEEDLE_components.js +220 -220
  223. package/lib/engine/extensions/NEEDLE_gameobject_data.d.ts +10 -10
  224. package/lib/engine/extensions/NEEDLE_gameobject_data.js +57 -57
  225. package/lib/engine/extensions/NEEDLE_lighting_settings.d.ts +37 -37
  226. package/lib/engine/extensions/NEEDLE_lighting_settings.js +157 -157
  227. package/lib/engine/extensions/NEEDLE_lightmaps.d.ts +18 -18
  228. package/lib/engine/extensions/NEEDLE_lightmaps.js +99 -99
  229. package/lib/engine/extensions/NEEDLE_persistent_assets.d.ts +11 -11
  230. package/lib/engine/extensions/NEEDLE_persistent_assets.js +63 -63
  231. package/lib/engine/extensions/NEEDLE_progressive.d.ts +1 -1
  232. package/lib/engine/extensions/NEEDLE_progressive.js +1 -1
  233. package/lib/engine/extensions/NEEDLE_render_objects.d.ts +13 -13
  234. package/lib/engine/extensions/NEEDLE_render_objects.js +159 -159
  235. package/lib/engine/extensions/NEEDLE_techniques_webgl.d.ts +38 -38
  236. package/lib/engine/extensions/NEEDLE_techniques_webgl.js +564 -564
  237. package/lib/engine/extensions/extension_resolver.d.ts +4 -4
  238. package/lib/engine/extensions/extension_resolver.js +1 -1
  239. package/lib/engine/extensions/extension_utils.d.ts +12 -12
  240. package/lib/engine/extensions/extension_utils.js +152 -152
  241. package/lib/engine/extensions/extensions.d.ts +32 -32
  242. package/lib/engine/extensions/extensions.js +107 -107
  243. package/lib/engine/extensions/index.d.ts +6 -6
  244. package/lib/engine/extensions/index.js +6 -6
  245. package/lib/engine/extensions/usage_tracker.d.ts +13 -13
  246. package/lib/engine/extensions/usage_tracker.js +65 -65
  247. package/lib/engine/js-extensions/Camera.d.ts +1 -1
  248. package/lib/engine/js-extensions/Camera.js +39 -39
  249. package/lib/engine/js-extensions/ExtensionUtils.d.ts +9 -9
  250. package/lib/engine/js-extensions/ExtensionUtils.js +67 -67
  251. package/lib/engine/js-extensions/Layers.d.ts +6 -6
  252. package/lib/engine/js-extensions/Layers.js +22 -22
  253. package/lib/engine/js-extensions/Object3D.d.ts +120 -120
  254. package/lib/engine/js-extensions/Object3D.js +136 -136
  255. package/lib/engine/js-extensions/RGBAColor.d.ts +23 -23
  256. package/lib/engine/js-extensions/RGBAColor.js +111 -111
  257. package/lib/engine/js-extensions/Vector.d.ts +3 -3
  258. package/lib/engine/js-extensions/Vector.js +13 -13
  259. package/lib/engine/js-extensions/index.d.ts +5 -5
  260. package/lib/engine/js-extensions/index.js +5 -5
  261. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.d.ts +4 -4
  262. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +79 -79
  263. package/lib/engine/shaders/shaderData.d.ts +55 -55
  264. package/lib/engine/shaders/shaderData.js +58 -58
  265. package/lib/engine/tests/test_utils.d.ts +2 -2
  266. package/lib/engine/tests/test_utils.js +53 -53
  267. package/lib/engine/webcomponents/WebXRButtons.d.ts +56 -56
  268. package/lib/engine/webcomponents/WebXRButtons.js +230 -230
  269. package/lib/engine/webcomponents/api.d.ts +5 -5
  270. package/lib/engine/webcomponents/api.js +4 -4
  271. package/lib/engine/webcomponents/buttons.d.ts +51 -51
  272. package/lib/engine/webcomponents/buttons.js +264 -264
  273. package/lib/engine/webcomponents/fonts.d.ts +9 -9
  274. package/lib/engine/webcomponents/fonts.js +32 -32
  275. package/lib/engine/webcomponents/icons.d.ts +9 -9
  276. package/lib/engine/webcomponents/icons.js +52 -52
  277. package/lib/engine/webcomponents/index.d.ts +1 -1
  278. package/lib/engine/webcomponents/index.js +1 -1
  279. package/lib/engine/webcomponents/logo-element.d.ts +10 -10
  280. package/lib/engine/webcomponents/logo-element.js +67 -67
  281. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.d.ts +37 -37
  282. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.js +513 -513
  283. package/lib/engine/webcomponents/needle menu/needle-menu.d.ts +155 -155
  284. package/lib/engine/webcomponents/needle menu/needle-menu.js +1029 -1029
  285. package/lib/engine/webcomponents/needle-button.d.ts +34 -34
  286. package/lib/engine/webcomponents/needle-button.js +161 -161
  287. package/lib/engine/webcomponents/needle-engine.ar-overlay.d.ts +21 -21
  288. package/lib/engine/webcomponents/needle-engine.ar-overlay.js +166 -166
  289. package/lib/engine/webcomponents/needle-engine.attributes.d.ts +69 -69
  290. package/lib/engine/webcomponents/needle-engine.attributes.js +1 -1
  291. package/lib/engine/webcomponents/needle-engine.d.ts +116 -116
  292. package/lib/engine/webcomponents/needle-engine.extras.d.ts +6 -6
  293. package/lib/engine/webcomponents/needle-engine.extras.js +13 -13
  294. package/lib/engine/webcomponents/needle-engine.js +821 -821
  295. package/lib/engine/webcomponents/needle-engine.loading.d.ts +44 -44
  296. package/lib/engine/webcomponents/needle-engine.loading.js +341 -341
  297. package/lib/engine/xr/NeedleXRController.d.ts +313 -313
  298. package/lib/engine/xr/NeedleXRController.js +1007 -1007
  299. package/lib/engine/xr/NeedleXRSession.d.ts +340 -340
  300. package/lib/engine/xr/NeedleXRSession.js +1463 -1463
  301. package/lib/engine/xr/NeedleXRSync.d.ts +22 -22
  302. package/lib/engine/xr/NeedleXRSync.js +188 -188
  303. package/lib/engine/xr/SceneTransition.d.ts +18 -18
  304. package/lib/engine/xr/SceneTransition.js +69 -69
  305. package/lib/engine/xr/TempXRContext.d.ts +34 -34
  306. package/lib/engine/xr/TempXRContext.js +187 -187
  307. package/lib/engine/xr/XRRig.d.ts +7 -7
  308. package/lib/engine/xr/XRRig.js +1 -1
  309. package/lib/engine/xr/api.d.ts +6 -6
  310. package/lib/engine/xr/api.js +6 -6
  311. package/lib/engine/xr/events.d.ts +66 -66
  312. package/lib/engine/xr/events.js +93 -93
  313. package/lib/engine/xr/internal.d.ts +12 -12
  314. package/lib/engine/xr/internal.js +25 -25
  315. package/lib/engine/xr/usdz.d.ts +12 -12
  316. package/lib/engine/xr/usdz.js +29 -29
  317. package/lib/engine/xr/utils.d.ts +11 -11
  318. package/lib/engine/xr/utils.js +34 -34
  319. package/lib/engine-components/AlignmentConstraint.d.ts +10 -10
  320. package/lib/engine-components/AlignmentConstraint.js +39 -39
  321. package/lib/engine-components/Animation.d.ts +156 -156
  322. package/lib/engine-components/Animation.js +508 -508
  323. package/lib/engine-components/AnimationCurve.d.ts +40 -40
  324. package/lib/engine-components/AnimationCurve.js +159 -159
  325. package/lib/engine-components/AnimationUtils.d.ts +8 -8
  326. package/lib/engine-components/AnimationUtils.js +27 -27
  327. package/lib/engine-components/AnimationUtilsAutoplay.d.ts +1 -1
  328. package/lib/engine-components/AnimationUtilsAutoplay.js +39 -39
  329. package/lib/engine-components/Animator.d.ts +217 -217
  330. package/lib/engine-components/Animator.js +354 -354
  331. package/lib/engine-components/AnimatorController.d.ts +227 -227
  332. package/lib/engine-components/AnimatorController.js +1152 -1152
  333. package/lib/engine-components/AudioListener.d.ts +33 -33
  334. package/lib/engine-components/AudioListener.js +86 -86
  335. package/lib/engine-components/AudioSource.d.ts +217 -217
  336. package/lib/engine-components/AudioSource.js +635 -635
  337. package/lib/engine-components/AvatarLoader.d.ts +80 -80
  338. package/lib/engine-components/AvatarLoader.js +231 -231
  339. package/lib/engine-components/AxesHelper.d.ts +32 -32
  340. package/lib/engine-components/AxesHelper.js +67 -67
  341. package/lib/engine-components/BasicIKConstraint.d.ts +9 -9
  342. package/lib/engine-components/BasicIKConstraint.js +43 -43
  343. package/lib/engine-components/BoxCollider.d.ts +2 -2
  344. package/lib/engine-components/BoxCollider.js +2 -2
  345. package/lib/engine-components/BoxHelperComponent.d.ts +47 -47
  346. package/lib/engine-components/BoxHelperComponent.js +102 -102
  347. package/lib/engine-components/Camera.d.ts +231 -231
  348. package/lib/engine-components/Camera.js +700 -700
  349. package/lib/engine-components/CameraUtils.d.ts +1 -1
  350. package/lib/engine-components/CameraUtils.js +121 -121
  351. package/lib/engine-components/CharacterController.d.ts +55 -55
  352. package/lib/engine-components/CharacterController.js +236 -236
  353. package/lib/engine-components/Collider.d.ts +188 -188
  354. package/lib/engine-components/Collider.js +369 -369
  355. package/lib/engine-components/Component.d.ts +792 -792
  356. package/lib/engine-components/Component.js +920 -920
  357. package/lib/engine-components/ContactShadows.d.ts +94 -94
  358. package/lib/engine-components/ContactShadows.js +453 -453
  359. package/lib/engine-components/DeleteBox.d.ts +19 -19
  360. package/lib/engine-components/DeleteBox.js +58 -58
  361. package/lib/engine-components/DeviceFlag.d.ts +16 -16
  362. package/lib/engine-components/DeviceFlag.js +47 -47
  363. package/lib/engine-components/DragControls.d.ts +170 -170
  364. package/lib/engine-components/DragControls.js +1421 -1421
  365. package/lib/engine-components/DropListener.d.ts +215 -215
  366. package/lib/engine-components/DropListener.js +642 -642
  367. package/lib/engine-components/Duplicatable.d.ts +35 -35
  368. package/lib/engine-components/Duplicatable.js +202 -202
  369. package/lib/engine-components/EventList.d.ts +54 -54
  370. package/lib/engine-components/EventList.js +232 -232
  371. package/lib/engine-components/EventTrigger.d.ts +33 -33
  372. package/lib/engine-components/EventTrigger.js +75 -75
  373. package/lib/engine-components/EventType.d.ts +22 -22
  374. package/lib/engine-components/EventType.js +23 -23
  375. package/lib/engine-components/Fog.d.ts +22 -22
  376. package/lib/engine-components/Fog.js +61 -61
  377. package/lib/engine-components/Gizmos.d.ts +17 -17
  378. package/lib/engine-components/Gizmos.js +64 -64
  379. package/lib/engine-components/GridHelper.d.ts +20 -20
  380. package/lib/engine-components/GridHelper.js +54 -54
  381. package/lib/engine-components/GroundProjection.d.ts +67 -67
  382. package/lib/engine-components/GroundProjection.js +343 -343
  383. package/lib/engine-components/Interactable.d.ts +12 -12
  384. package/lib/engine-components/Interactable.js +12 -12
  385. package/lib/engine-components/Joints.d.ts +19 -19
  386. package/lib/engine-components/Joints.js +51 -51
  387. package/lib/engine-components/LODGroup.d.ts +35 -35
  388. package/lib/engine-components/LODGroup.js +152 -152
  389. package/lib/engine-components/Light.d.ts +180 -180
  390. package/lib/engine-components/Light.js +535 -535
  391. package/lib/engine-components/LookAtConstraint.d.ts +19 -19
  392. package/lib/engine-components/LookAtConstraint.js +35 -35
  393. package/lib/engine-components/NeedleMenu.d.ts +50 -50
  394. package/lib/engine-components/NeedleMenu.js +92 -92
  395. package/lib/engine-components/NestedGltf.d.ts +25 -25
  396. package/lib/engine-components/NestedGltf.js +88 -88
  397. package/lib/engine-components/Networking.d.ts +54 -54
  398. package/lib/engine-components/Networking.js +112 -112
  399. package/lib/engine-components/OffsetConstraint.d.ts +14 -14
  400. package/lib/engine-components/OffsetConstraint.js +65 -65
  401. package/lib/engine-components/OrbitControls.d.ts +268 -268
  402. package/lib/engine-components/OrbitControls.js +1015 -1015
  403. package/lib/engine-components/PlayerColor.d.ts +19 -19
  404. package/lib/engine-components/PlayerColor.js +94 -94
  405. package/lib/engine-components/ReflectionProbe.d.ts +28 -28
  406. package/lib/engine-components/ReflectionProbe.js +204 -204
  407. package/lib/engine-components/Renderer.d.ts +153 -153
  408. package/lib/engine-components/Renderer.js +834 -834
  409. package/lib/engine-components/RendererInstancing.d.ts +140 -140
  410. package/lib/engine-components/RendererInstancing.js +744 -744
  411. package/lib/engine-components/RendererLightmap.d.ts +24 -24
  412. package/lib/engine-components/RendererLightmap.js +182 -182
  413. package/lib/engine-components/RigidBody.d.ts +155 -155
  414. package/lib/engine-components/RigidBody.js +517 -517
  415. package/lib/engine-components/SceneSwitcher.d.ts +263 -263
  416. package/lib/engine-components/SceneSwitcher.js +971 -971
  417. package/lib/engine-components/ScreenCapture.d.ts +144 -144
  418. package/lib/engine-components/ScreenCapture.js +547 -547
  419. package/lib/engine-components/ShadowCatcher.d.ts +33 -33
  420. package/lib/engine-components/ShadowCatcher.js +166 -166
  421. package/lib/engine-components/Skybox.d.ts +88 -88
  422. package/lib/engine-components/Skybox.js +469 -469
  423. package/lib/engine-components/SmoothFollow.d.ts +34 -34
  424. package/lib/engine-components/SmoothFollow.js +82 -82
  425. package/lib/engine-components/SpatialTrigger.d.ts +102 -102
  426. package/lib/engine-components/SpatialTrigger.js +225 -225
  427. package/lib/engine-components/SpectatorCamera.d.ts +111 -111
  428. package/lib/engine-components/SpectatorCamera.js +715 -715
  429. package/lib/engine-components/SphereCollider.d.ts +2 -2
  430. package/lib/engine-components/SphereCollider.js +2 -2
  431. package/lib/engine-components/SpriteRenderer.d.ts +132 -132
  432. package/lib/engine-components/SpriteRenderer.js +472 -472
  433. package/lib/engine-components/SyncedCamera.d.ts +41 -41
  434. package/lib/engine-components/SyncedCamera.js +199 -199
  435. package/lib/engine-components/SyncedRoom.d.ts +106 -106
  436. package/lib/engine-components/SyncedRoom.js +371 -371
  437. package/lib/engine-components/SyncedTransform.d.ts +94 -94
  438. package/lib/engine-components/SyncedTransform.js +331 -331
  439. package/lib/engine-components/TestRunner.d.ts +16 -16
  440. package/lib/engine-components/TestRunner.js +102 -102
  441. package/lib/engine-components/TransformGizmo.d.ts +75 -75
  442. package/lib/engine-components/TransformGizmo.js +209 -209
  443. package/lib/engine-components/VideoPlayer.d.ts +184 -184
  444. package/lib/engine-components/VideoPlayer.js +978 -978
  445. package/lib/engine-components/Voip.d.ts +67 -67
  446. package/lib/engine-components/Voip.js +360 -360
  447. package/lib/engine-components/api.d.ts +51 -51
  448. package/lib/engine-components/api.js +50 -50
  449. package/lib/engine-components/avatar/AvatarBlink_Simple.d.ts +11 -11
  450. package/lib/engine-components/avatar/AvatarBlink_Simple.js +76 -76
  451. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.d.ts +14 -14
  452. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.js +68 -68
  453. package/lib/engine-components/avatar/Avatar_Brain_LookAt.d.ts +29 -29
  454. package/lib/engine-components/avatar/Avatar_Brain_LookAt.js +121 -121
  455. package/lib/engine-components/avatar/Avatar_MouthShapes.d.ts +15 -15
  456. package/lib/engine-components/avatar/Avatar_MouthShapes.js +79 -79
  457. package/lib/engine-components/avatar/Avatar_MustacheShake.d.ts +9 -9
  458. package/lib/engine-components/avatar/Avatar_MustacheShake.js +29 -29
  459. package/lib/engine-components/codegen/components.d.ts +216 -216
  460. package/lib/engine-components/codegen/components.js +218 -218
  461. package/lib/engine-components/debug/LogStats.d.ts +5 -5
  462. package/lib/engine-components/debug/LogStats.js +18 -18
  463. package/lib/engine-components/export/gltf/GltfExport.d.ts +30 -30
  464. package/lib/engine-components/export/gltf/GltfExport.js +246 -246
  465. package/lib/engine-components/export/gltf/index.d.ts +1 -1
  466. package/lib/engine-components/export/gltf/index.js +1 -1
  467. package/lib/engine-components/export/index.d.ts +1 -1
  468. package/lib/engine-components/export/index.js +1 -1
  469. package/lib/engine-components/export/usdz/Extension.d.ts +22 -22
  470. package/lib/engine-components/export/usdz/Extension.js +1 -1
  471. package/lib/engine-components/export/usdz/ThreeUSDZExporter.d.ts +162 -160
  472. package/lib/engine-components/export/usdz/ThreeUSDZExporter.js +1789 -1782
  473. package/lib/engine-components/export/usdz/ThreeUSDZExporter.js.map +1 -1
  474. package/lib/engine-components/export/usdz/USDZExporter.d.ts +130 -130
  475. package/lib/engine-components/export/usdz/USDZExporter.js +663 -663
  476. package/lib/engine-components/export/usdz/extensions/Animation.d.ts +106 -106
  477. package/lib/engine-components/export/usdz/extensions/Animation.js +1071 -1071
  478. package/lib/engine-components/export/usdz/extensions/DocumentExtension.d.ts +5 -5
  479. package/lib/engine-components/export/usdz/extensions/DocumentExtension.js +6 -6
  480. package/lib/engine-components/export/usdz/extensions/NodeMaterialConverter.d.ts +10 -0
  481. package/lib/engine-components/export/usdz/extensions/NodeMaterialConverter.js +452 -0
  482. package/lib/engine-components/export/usdz/extensions/NodeMaterialConverter.js.map +1 -0
  483. package/lib/engine-components/export/usdz/extensions/USDZText.d.ts +54 -54
  484. package/lib/engine-components/export/usdz/extensions/USDZText.js +203 -203
  485. package/lib/engine-components/export/usdz/extensions/USDZUI.d.ts +8 -8
  486. package/lib/engine-components/export/usdz/extensions/USDZUI.js +158 -158
  487. package/lib/engine-components/export/usdz/extensions/behavior/Actions.d.ts +30 -30
  488. package/lib/engine-components/export/usdz/extensions/behavior/Actions.js +88 -88
  489. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.d.ts +10 -10
  490. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.js +86 -86
  491. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.d.ts +28 -28
  492. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.js +290 -290
  493. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.d.ts +190 -190
  494. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.js +1060 -1060
  495. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.d.ts +135 -135
  496. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.js +548 -548
  497. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.d.ts +7 -7
  498. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.js +115 -115
  499. package/lib/engine-components/export/usdz/index.d.ts +3 -3
  500. package/lib/engine-components/export/usdz/index.js +2 -2
  501. package/lib/engine-components/export/usdz/utils/animationutils.d.ts +7 -7
  502. package/lib/engine-components/export/usdz/utils/animationutils.js +163 -163
  503. package/lib/engine-components/export/usdz/utils/quicklook.d.ts +2 -2
  504. package/lib/engine-components/export/usdz/utils/quicklook.js +43 -43
  505. package/lib/engine-components/particlesystem/ParticleSystem.d.ts +177 -177
  506. package/lib/engine-components/particlesystem/ParticleSystem.js +1176 -1176
  507. package/lib/engine-components/particlesystem/ParticleSystemModules.d.ts +526 -526
  508. package/lib/engine-components/particlesystem/ParticleSystemModules.js +1930 -1930
  509. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.d.ts +25 -25
  510. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.js +87 -87
  511. package/lib/engine-components/particlesystem/api.d.ts +2 -2
  512. package/lib/engine-components/particlesystem/api.js +2 -2
  513. package/lib/engine-components/postprocessing/Effects/Antialiasing.d.ts +17 -17
  514. package/lib/engine-components/postprocessing/Effects/Antialiasing.js +52 -52
  515. package/lib/engine-components/postprocessing/Effects/BloomEffect.d.ts +46 -46
  516. package/lib/engine-components/postprocessing/Effects/BloomEffect.js +113 -116
  517. package/lib/engine-components/postprocessing/Effects/BloomEffect.js.map +1 -1
  518. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.d.ts +11 -11
  519. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.js +39 -39
  520. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.d.ts +23 -23
  521. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.js +111 -111
  522. package/lib/engine-components/postprocessing/Effects/DepthOfField.d.ts +25 -25
  523. package/lib/engine-components/postprocessing/Effects/DepthOfField.js +104 -104
  524. package/lib/engine-components/postprocessing/Effects/EffectWrapper.d.ts +12 -12
  525. package/lib/engine-components/postprocessing/Effects/EffectWrapper.js +18 -18
  526. package/lib/engine-components/postprocessing/Effects/Pixelation.d.ts +11 -11
  527. package/lib/engine-components/postprocessing/Effects/Pixelation.js +32 -32
  528. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.d.ts +18 -18
  529. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.js +91 -91
  530. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.d.ts +70 -70
  531. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.js +176 -176
  532. package/lib/engine-components/postprocessing/Effects/Sharpening.d.ts +18 -18
  533. package/lib/engine-components/postprocessing/Effects/Sharpening.js +127 -127
  534. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.d.ts +17 -17
  535. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.js +70 -70
  536. package/lib/engine-components/postprocessing/Effects/Tonemapping.d.ts +19 -19
  537. package/lib/engine-components/postprocessing/Effects/Tonemapping.js +94 -94
  538. package/lib/engine-components/postprocessing/Effects/Tonemapping.utils.d.ts +13 -13
  539. package/lib/engine-components/postprocessing/Effects/Tonemapping.utils.js +51 -51
  540. package/lib/engine-components/postprocessing/Effects/Vignette.d.ts +15 -15
  541. package/lib/engine-components/postprocessing/Effects/Vignette.js +60 -60
  542. package/lib/engine-components/postprocessing/PostProcessingEffect.d.ts +90 -90
  543. package/lib/engine-components/postprocessing/PostProcessingEffect.js +168 -168
  544. package/lib/engine-components/postprocessing/PostProcessingHandler.d.ts +42 -42
  545. package/lib/engine-components/postprocessing/PostProcessingHandler.js +480 -462
  546. package/lib/engine-components/postprocessing/PostProcessingHandler.js.map +1 -1
  547. package/lib/engine-components/postprocessing/Volume.d.ts +90 -90
  548. package/lib/engine-components/postprocessing/Volume.js +385 -385
  549. package/lib/engine-components/postprocessing/VolumeParameter.d.ts +26 -26
  550. package/lib/engine-components/postprocessing/VolumeParameter.js +136 -136
  551. package/lib/engine-components/postprocessing/VolumeProfile.d.ts +15 -15
  552. package/lib/engine-components/postprocessing/VolumeProfile.js +60 -60
  553. package/lib/engine-components/postprocessing/index.d.ts +6 -6
  554. package/lib/engine-components/postprocessing/index.js +6 -6
  555. package/lib/engine-components/postprocessing/utils.d.ts +55 -54
  556. package/lib/engine-components/postprocessing/utils.js +119 -119
  557. package/lib/engine-components/postprocessing/utils.js.map +1 -1
  558. package/lib/engine-components/timeline/PlayableDirector.d.ts +163 -163
  559. package/lib/engine-components/timeline/PlayableDirector.js +686 -686
  560. package/lib/engine-components/timeline/SignalAsset.d.ts +24 -24
  561. package/lib/engine-components/timeline/SignalAsset.js +130 -130
  562. package/lib/engine-components/timeline/TimelineModels.d.ts +89 -89
  563. package/lib/engine-components/timeline/TimelineModels.js +22 -22
  564. package/lib/engine-components/timeline/TimelineTracks.d.ts +110 -110
  565. package/lib/engine-components/timeline/TimelineTracks.js +879 -879
  566. package/lib/engine-components/timeline/index.d.ts +4 -4
  567. package/lib/engine-components/timeline/index.js +3 -3
  568. package/lib/engine-components/ui/BaseUIComponent.d.ts +48 -48
  569. package/lib/engine-components/ui/BaseUIComponent.js +170 -170
  570. package/lib/engine-components/ui/Button.d.ts +64 -64
  571. package/lib/engine-components/ui/Button.js +315 -315
  572. package/lib/engine-components/ui/Canvas.d.ts +74 -74
  573. package/lib/engine-components/ui/Canvas.js +407 -407
  574. package/lib/engine-components/ui/CanvasGroup.d.ts +19 -19
  575. package/lib/engine-components/ui/CanvasGroup.js +58 -58
  576. package/lib/engine-components/ui/EventSystem.d.ts +125 -125
  577. package/lib/engine-components/ui/EventSystem.js +765 -765
  578. package/lib/engine-components/ui/Graphic.d.ts +55 -55
  579. package/lib/engine-components/ui/Graphic.js +255 -255
  580. package/lib/engine-components/ui/Image.d.ts +35 -35
  581. package/lib/engine-components/ui/Image.js +116 -116
  582. package/lib/engine-components/ui/InputField.d.ts +42 -42
  583. package/lib/engine-components/ui/InputField.js +268 -268
  584. package/lib/engine-components/ui/Interfaces.d.ts +38 -38
  585. package/lib/engine-components/ui/Interfaces.js +12 -12
  586. package/lib/engine-components/ui/Layout.d.ts +84 -84
  587. package/lib/engine-components/ui/Layout.js +330 -330
  588. package/lib/engine-components/ui/Outline.d.ts +7 -7
  589. package/lib/engine-components/ui/Outline.js +20 -20
  590. package/lib/engine-components/ui/PointerEvents.d.ts +115 -115
  591. package/lib/engine-components/ui/PointerEvents.js +145 -145
  592. package/lib/engine-components/ui/RaycastUtils.d.ts +11 -11
  593. package/lib/engine-components/ui/RaycastUtils.js +67 -67
  594. package/lib/engine-components/ui/Raycaster.d.ts +30 -30
  595. package/lib/engine-components/ui/Raycaster.js +95 -95
  596. package/lib/engine-components/ui/RectTransform.d.ts +61 -61
  597. package/lib/engine-components/ui/RectTransform.js +356 -356
  598. package/lib/engine-components/ui/SpatialHtml.d.ts +8 -8
  599. package/lib/engine-components/ui/SpatialHtml.js +79 -79
  600. package/lib/engine-components/ui/Symbols.d.ts +1 -1
  601. package/lib/engine-components/ui/Symbols.js +1 -1
  602. package/lib/engine-components/ui/Text.d.ts +78 -78
  603. package/lib/engine-components/ui/Text.js +539 -539
  604. package/lib/engine-components/ui/Utils.d.ts +24 -24
  605. package/lib/engine-components/ui/Utils.js +90 -90
  606. package/lib/engine-components/ui/index.d.ts +1 -1
  607. package/lib/engine-components/ui/index.js +1 -1
  608. package/lib/engine-components/utils/EnvironmentScene.d.ts +5 -5
  609. package/lib/engine-components/utils/EnvironmentScene.js +205 -205
  610. package/lib/engine-components/utils/LookAt.d.ts +31 -31
  611. package/lib/engine-components/utils/LookAt.js +82 -82
  612. package/lib/engine-components/utils/OpenURL.d.ts +42 -42
  613. package/lib/engine-components/utils/OpenURL.js +119 -119
  614. package/lib/engine-components/webxr/Avatar.d.ts +25 -25
  615. package/lib/engine-components/webxr/Avatar.js +255 -255
  616. package/lib/engine-components/webxr/TeleportTarget.d.ts +7 -7
  617. package/lib/engine-components/webxr/TeleportTarget.js +7 -7
  618. package/lib/engine-components/webxr/WebARCameraBackground.d.ts +30 -30
  619. package/lib/engine-components/webxr/WebARCameraBackground.js +155 -155
  620. package/lib/engine-components/webxr/WebARSessionRoot.d.ts +98 -98
  621. package/lib/engine-components/webxr/WebARSessionRoot.js +770 -770
  622. package/lib/engine-components/webxr/WebXR.d.ts +232 -232
  623. package/lib/engine-components/webxr/WebXR.js +561 -561
  624. package/lib/engine-components/webxr/WebXRAvatar.d.ts +27 -27
  625. package/lib/engine-components/webxr/WebXRAvatar.js +44 -44
  626. package/lib/engine-components/webxr/WebXRImageTracking.d.ts +86 -86
  627. package/lib/engine-components/webxr/WebXRImageTracking.js +471 -471
  628. package/lib/engine-components/webxr/WebXRPlaneTracking.d.ts +92 -92
  629. package/lib/engine-components/webxr/WebXRPlaneTracking.js +500 -500
  630. package/lib/engine-components/webxr/WebXRRig.d.ts +32 -32
  631. package/lib/engine-components/webxr/WebXRRig.js +72 -72
  632. package/lib/engine-components/webxr/XRFlag.d.ts +38 -38
  633. package/lib/engine-components/webxr/XRFlag.js +139 -139
  634. package/lib/engine-components/webxr/controllers/XRControllerFollow.d.ts +47 -47
  635. package/lib/engine-components/webxr/controllers/XRControllerFollow.js +120 -120
  636. package/lib/engine-components/webxr/controllers/XRControllerModel.d.ts +43 -43
  637. package/lib/engine-components/webxr/controllers/XRControllerModel.js +352 -352
  638. package/lib/engine-components/webxr/controllers/XRControllerMovement.d.ts +78 -78
  639. package/lib/engine-components/webxr/controllers/XRControllerMovement.js +506 -506
  640. package/lib/engine-components/webxr/index.d.ts +3 -3
  641. package/lib/engine-components/webxr/index.js +3 -3
  642. package/lib/engine-components/webxr/types.d.ts +3 -3
  643. package/lib/engine-components/webxr/types.js +1 -1
  644. package/lib/engine-components-experimental/Presentation.d.ts +6 -6
  645. package/lib/engine-components-experimental/Presentation.js +9 -9
  646. package/lib/engine-components-experimental/api.d.ts +4 -4
  647. package/lib/engine-components-experimental/api.js +4 -4
  648. package/lib/engine-components-experimental/networking/PlayerSync.d.ts +156 -156
  649. package/lib/engine-components-experimental/networking/PlayerSync.js +377 -377
  650. package/lib/engine-schemes/api.d.ts +12 -12
  651. package/lib/engine-schemes/api.js +12 -12
  652. package/lib/engine-schemes/schemes.d.ts +7 -7
  653. package/lib/engine-schemes/schemes.js +19 -19
  654. package/lib/engine-schemes/synced-camera-model.d.ts +25 -25
  655. package/lib/engine-schemes/synced-camera-model.js +67 -67
  656. package/lib/engine-schemes/synced-transform-model.d.ts +31 -31
  657. package/lib/engine-schemes/synced-transform-model.js +66 -66
  658. package/lib/engine-schemes/transform.d.ts +12 -12
  659. package/lib/engine-schemes/transform.js +39 -39
  660. package/lib/engine-schemes/vec2.d.ts +10 -10
  661. package/lib/engine-schemes/vec2.js +25 -25
  662. package/lib/engine-schemes/vec3.d.ts +11 -11
  663. package/lib/engine-schemes/vec3.js +29 -29
  664. package/lib/engine-schemes/vec4.d.ts +12 -12
  665. package/lib/engine-schemes/vec4.js +33 -33
  666. package/lib/engine-schemes/vr-user-state-buffer.d.ts +37 -37
  667. package/lib/engine-schemes/vr-user-state-buffer.js +110 -110
  668. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.d.ts +6 -6
  669. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.js +45 -45
  670. package/lib/needle-engine.d.ts +7 -7
  671. package/lib/needle-engine.js +64 -64
  672. package/package.json +1 -1
  673. package/plugins/common/buildinfo.js +64 -64
  674. package/plugins/common/cloud.js +1 -1
  675. package/plugins/common/config.cjs +31 -31
  676. package/plugins/common/config.js +35 -35
  677. package/plugins/common/files.js +31 -31
  678. package/plugins/common/generator.js +10 -10
  679. package/plugins/common/license.js +452 -452
  680. package/plugins/common/npm.js +15 -15
  681. package/plugins/common/timers.js +7 -7
  682. package/plugins/common/version.js +37 -37
  683. package/plugins/gltf-packer.mjs +1 -1
  684. package/plugins/next/alias.cjs +39 -39
  685. package/plugins/next/license.cjs +24 -24
  686. package/plugins/next/meshbvhworker.cjs +18 -18
  687. package/plugins/next/next.js +141 -141
  688. package/plugins/types/index.d.ts +2 -2
  689. package/plugins/types/license.d.ts +24 -24
  690. package/plugins/types/needleConfig.d.ts +27 -27
  691. package/plugins/types/next.d.ts +2 -2
  692. package/plugins/types/userconfig.d.ts +120 -120
  693. package/plugins/types/vite.d.ts +13 -13
  694. package/plugins/types/webmanifest.d.ts +32 -32
  695. package/plugins/vite/alias.js +174 -174
  696. package/plugins/vite/asap.js +251 -251
  697. package/plugins/vite/build-pipeline.js +371 -371
  698. package/plugins/vite/build.js +19 -19
  699. package/plugins/vite/buildinfo.js +41 -41
  700. package/plugins/vite/config.js +106 -106
  701. package/plugins/vite/copyfiles.js +138 -138
  702. package/plugins/vite/defines.js +70 -70
  703. package/plugins/vite/dependencies.js +232 -232
  704. package/plugins/vite/dependency-watcher.js +237 -237
  705. package/plugins/vite/drop-client.js +76 -76
  706. package/plugins/vite/drop.js +87 -87
  707. package/plugins/vite/editor-connection.js +124 -124
  708. package/plugins/vite/facebook-instant-games.js +102 -102
  709. package/plugins/vite/gzip.js +5 -5
  710. package/plugins/vite/imports-logger.js +143 -143
  711. package/plugins/vite/index.js +143 -143
  712. package/plugins/vite/license.js +56 -56
  713. package/plugins/vite/local-files.js +440 -440
  714. package/plugins/vite/meta.js +163 -163
  715. package/plugins/vite/npm.js +7 -7
  716. package/plugins/vite/peer.js +29 -29
  717. package/plugins/vite/poster-client.js +73 -73
  718. package/plugins/vite/poster.js +79 -79
  719. package/plugins/vite/pwa.js +604 -604
  720. package/plugins/vite/reload-client.js +15 -15
  721. package/plugins/vite/reload.js +351 -351
  722. package/plugins/vite/server.js +66 -66
  723. package/plugins/vite/transform-codegen.js +55 -55
  724. package/plugins/vite/transform.js +31 -31
  725. package/plugins/vite/vite-4.4-hack.js +31 -31
  726. package/src/asap/needle-asap.ts +111 -111
  727. package/src/asap/sessiongranted.ts +75 -75
  728. package/src/asap/utils.ts +4 -4
  729. package/src/engine/analytics/index.ts +10 -10
  730. package/src/engine/analytics/lcp.ts +35 -35
  731. package/src/engine/api.ts +82 -82
  732. package/src/engine/assets/index.ts +59 -59
  733. package/src/engine/assets/static.js +5 -5
  734. package/src/engine/codegen/register_types.ts +300 -300
  735. package/src/engine/debug/debug.ts +51 -51
  736. package/src/engine/debug/debug_console.ts +333 -333
  737. package/src/engine/debug/debug_overlay.ts +332 -332
  738. package/src/engine/debug/debug_spatial_console.ts +429 -429
  739. package/src/engine/debug/index.ts +1 -1
  740. package/src/engine/engine_addressables.ts +680 -680
  741. package/src/engine/engine_animation.ts +145 -145
  742. package/src/engine/engine_application.ts +113 -113
  743. package/src/engine/engine_assetdatabase.ts +389 -389
  744. package/src/engine/engine_audio.ts +24 -24
  745. package/src/engine/engine_camera.ts +39 -39
  746. package/src/engine/engine_components.ts +366 -366
  747. package/src/engine/engine_components_internal.ts +40 -40
  748. package/src/engine/engine_constants.ts +52 -52
  749. package/src/engine/engine_context.ts +1823 -1823
  750. package/src/engine/engine_context_registry.ts +129 -129
  751. package/src/engine/engine_coroutine.ts +54 -54
  752. package/src/engine/engine_create_objects.ts +411 -411
  753. package/src/engine/engine_default_parameters.ts +3 -3
  754. package/src/engine/engine_editor-sync.ts +28 -28
  755. package/src/engine/engine_fileloader.js +9 -9
  756. package/src/engine/engine_gameobject.ts +712 -712
  757. package/src/engine/engine_generic_utils.js +13 -13
  758. package/src/engine/engine_gizmos.ts +577 -577
  759. package/src/engine/engine_gltf.ts +29 -29
  760. package/src/engine/engine_gltf_builtin_components.ts +403 -403
  761. package/src/engine/engine_hot_reload.ts +210 -210
  762. package/src/engine/engine_input.ts +1500 -1500
  763. package/src/engine/engine_input_utils.ts +23 -23
  764. package/src/engine/engine_instancing.ts +45 -45
  765. package/src/engine/engine_license.ts +386 -386
  766. package/src/engine/engine_lifecycle_api.ts +113 -113
  767. package/src/engine/engine_lifecycle_functions_internal.ts +193 -193
  768. package/src/engine/engine_lightdata.ts +117 -117
  769. package/src/engine/engine_loaders.callbacks.ts +136 -136
  770. package/src/engine/engine_loaders.gltf.ts +82 -82
  771. package/src/engine/engine_loaders.ts +378 -378
  772. package/src/engine/engine_lods.ts +168 -168
  773. package/src/engine/engine_mainloop_utils.ts +472 -472
  774. package/src/engine/engine_math.ts +282 -282
  775. package/src/engine/engine_modules.ts +83 -83
  776. package/src/engine/engine_networking.ts +862 -862
  777. package/src/engine/engine_networking_auto.ts +352 -352
  778. package/src/engine/engine_networking_blob.ts +275 -275
  779. package/src/engine/engine_networking_files.ts +217 -217
  780. package/src/engine/engine_networking_files_default_components.ts +58 -58
  781. package/src/engine/engine_networking_instantiate.ts +419 -419
  782. package/src/engine/engine_networking_peer.ts +159 -159
  783. package/src/engine/engine_networking_streams.ts +713 -713
  784. package/src/engine/engine_networking_types.ts +24 -24
  785. package/src/engine/engine_networking_utils.ts +23 -23
  786. package/src/engine/engine_networking_websocket.ts +2 -2
  787. package/src/engine/engine_patcher.ts +199 -199
  788. package/src/engine/engine_physics.ts +783 -783
  789. package/src/engine/engine_physics.types.ts +46 -46
  790. package/src/engine/engine_physics_rapier.ts +1577 -1577
  791. package/src/engine/engine_playerview.ts +80 -80
  792. package/src/engine/engine_scenelighting.ts +294 -294
  793. package/src/engine/engine_serialization.ts +2 -2
  794. package/src/engine/engine_serialization_builtin_serializer.ts +473 -473
  795. package/src/engine/engine_serialization_core.ts +720 -720
  796. package/src/engine/engine_serialization_decorator.ts +80 -80
  797. package/src/engine/engine_setup.ts +1 -1
  798. package/src/engine/engine_shaders.ts +267 -267
  799. package/src/engine/engine_shims.ts +32 -32
  800. package/src/engine/engine_test_utils.ts +109 -109
  801. package/src/engine/engine_texture.ts +82 -82
  802. package/src/engine/engine_three_utils.ts +925 -925
  803. package/src/engine/engine_time.ts +94 -94
  804. package/src/engine/engine_time_utils.ts +237 -237
  805. package/src/engine/engine_tonemapping.ts +208 -208
  806. package/src/engine/engine_types.ts +730 -730
  807. package/src/engine/engine_typestore.ts +63 -63
  808. package/src/engine/engine_util_decorator.ts +136 -136
  809. package/src/engine/engine_utils.ts +1115 -1115
  810. package/src/engine/engine_utils_format.ts +273 -273
  811. package/src/engine/engine_utils_screenshot.ts +708 -708
  812. package/src/engine/engine_utils_screenshot.xr.ts +103 -103
  813. package/src/engine/export/gltf/Writers.ts +34 -34
  814. package/src/engine/export/gltf/index.ts +158 -158
  815. package/src/engine/export/index.ts +2 -2
  816. package/src/engine/export/state.ts +19 -19
  817. package/src/engine/export/utils.ts +9 -9
  818. package/src/engine/extensions/EXT_texture_exr.ts +50 -50
  819. package/src/engine/extensions/NEEDLE_animator_controller_model.ts +195 -195
  820. package/src/engine/extensions/NEEDLE_components.ts +268 -268
  821. package/src/engine/extensions/NEEDLE_gameobject_data.ts +81 -81
  822. package/src/engine/extensions/NEEDLE_lighting_settings.ts +185 -185
  823. package/src/engine/extensions/NEEDLE_lightmaps.ts +119 -119
  824. package/src/engine/extensions/NEEDLE_persistent_assets.ts +76 -76
  825. package/src/engine/extensions/NEEDLE_render_objects.ts +209 -209
  826. package/src/engine/extensions/NEEDLE_techniques_webgl.ts +640 -640
  827. package/src/engine/extensions/extension_resolver.ts +4 -4
  828. package/src/engine/extensions/extension_utils.ts +166 -166
  829. package/src/engine/extensions/extensions.ts +140 -140
  830. package/src/engine/extensions/index.ts +5 -5
  831. package/src/engine/extensions/usage_tracker.ts +100 -100
  832. package/src/engine/js-extensions/Camera.ts +37 -37
  833. package/src/engine/js-extensions/ExtensionUtils.ts +85 -85
  834. package/src/engine/js-extensions/Layers.ts +23 -23
  835. package/src/engine/js-extensions/Object3D.ts +296 -296
  836. package/src/engine/js-extensions/RGBAColor.ts +126 -126
  837. package/src/engine/js-extensions/Vector.ts +18 -18
  838. package/src/engine/js-extensions/index.ts +4 -4
  839. package/src/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +125 -125
  840. package/src/engine/shaders/shaderData.ts +67 -67
  841. package/src/engine/tests/test_utils.ts +63 -63
  842. package/src/engine/webcomponents/WebXRButtons.ts +260 -260
  843. package/src/engine/webcomponents/api.ts +6 -6
  844. package/src/engine/webcomponents/buttons.ts +292 -292
  845. package/src/engine/webcomponents/fonts.ts +41 -41
  846. package/src/engine/webcomponents/icons.ts +57 -57
  847. package/src/engine/webcomponents/index.ts +1 -1
  848. package/src/engine/webcomponents/logo-element.ts +78 -78
  849. package/src/engine/webcomponents/needle menu/needle-menu-spatial.ts +573 -573
  850. package/src/engine/webcomponents/needle menu/needle-menu.ts +1118 -1118
  851. package/src/engine/webcomponents/needle-button.ts +181 -181
  852. package/src/engine/webcomponents/needle-engine.ar-overlay.ts +186 -186
  853. package/src/engine/webcomponents/needle-engine.attributes.ts +82 -82
  854. package/src/engine/webcomponents/needle-engine.extras.ts +16 -16
  855. package/src/engine/webcomponents/needle-engine.loading.ts +373 -373
  856. package/src/engine/webcomponents/needle-engine.ts +860 -860
  857. package/src/engine/xr/NeedleXRController.ts +1125 -1125
  858. package/src/engine/xr/NeedleXRSession.ts +1624 -1624
  859. package/src/engine/xr/NeedleXRSync.ts +220 -220
  860. package/src/engine/xr/SceneTransition.ts +78 -78
  861. package/src/engine/xr/TempXRContext.ts +216 -216
  862. package/src/engine/xr/XRRig.ts +9 -9
  863. package/src/engine/xr/api.ts +5 -5
  864. package/src/engine/xr/events.ts +102 -102
  865. package/src/engine/xr/internal.ts +34 -34
  866. package/src/engine/xr/usdz.ts +30 -30
  867. package/src/engine/xr/utils.ts +39 -39
  868. package/src/engine-components/AlignmentConstraint.ts +36 -36
  869. package/src/engine-components/Animation.ts +557 -557
  870. package/src/engine-components/AnimationCurve.ts +150 -150
  871. package/src/engine-components/AnimationUtils.ts +28 -28
  872. package/src/engine-components/AnimationUtilsAutoplay.ts +43 -43
  873. package/src/engine-components/Animator.ts +397 -397
  874. package/src/engine-components/AnimatorController.ts +1293 -1293
  875. package/src/engine-components/AudioListener.ts +92 -92
  876. package/src/engine-components/AudioSource.ts +644 -644
  877. package/src/engine-components/AvatarLoader.ts +263 -263
  878. package/src/engine-components/AxesHelper.ts +59 -59
  879. package/src/engine-components/BasicIKConstraint.ts +54 -54
  880. package/src/engine-components/BoxCollider.ts +1 -1
  881. package/src/engine-components/BoxHelperComponent.ts +114 -114
  882. package/src/engine-components/Camera.ts +719 -719
  883. package/src/engine-components/CameraUtils.ts +136 -136
  884. package/src/engine-components/CharacterController.ts +253 -253
  885. package/src/engine-components/Collider.ts +374 -374
  886. package/src/engine-components/Component.ts +1297 -1297
  887. package/src/engine-components/ContactShadows.ts +506 -506
  888. package/src/engine-components/DeleteBox.ts +62 -62
  889. package/src/engine-components/DeviceFlag.ts +46 -46
  890. package/src/engine-components/DragControls.ts +1623 -1623
  891. package/src/engine-components/DropListener.ts +713 -713
  892. package/src/engine-components/Duplicatable.ts +198 -198
  893. package/src/engine-components/EventList.ts +266 -266
  894. package/src/engine-components/EventTrigger.ts +74 -74
  895. package/src/engine-components/EventType.ts +22 -22
  896. package/src/engine-components/Fog.ts +60 -60
  897. package/src/engine-components/Gizmos.ts +56 -56
  898. package/src/engine-components/GridHelper.ts +48 -48
  899. package/src/engine-components/GroundProjection.ts +356 -356
  900. package/src/engine-components/Interactable.ts +14 -14
  901. package/src/engine-components/Joints.ts +52 -52
  902. package/src/engine-components/LODGroup.ts +153 -153
  903. package/src/engine-components/Light.ts +558 -558
  904. package/src/engine-components/LookAtConstraint.ts +25 -25
  905. package/src/engine-components/NeedleMenu.ts +84 -84
  906. package/src/engine-components/NestedGltf.ts +86 -86
  907. package/src/engine-components/Networking.ts +114 -114
  908. package/src/engine-components/OffsetConstraint.ts +60 -60
  909. package/src/engine-components/OrbitControls.ts +1074 -1074
  910. package/src/engine-components/PlayerColor.ts +103 -103
  911. package/src/engine-components/ReflectionProbe.ts +220 -220
  912. package/src/engine-components/Renderer.ts +903 -903
  913. package/src/engine-components/RendererInstancing.ts +855 -855
  914. package/src/engine-components/RendererLightmap.ts +198 -198
  915. package/src/engine-components/RigidBody.ts +526 -526
  916. package/src/engine-components/SceneSwitcher.ts +1030 -1030
  917. package/src/engine-components/ScreenCapture.ts +592 -592
  918. package/src/engine-components/ShadowCatcher.ts +172 -172
  919. package/src/engine-components/Skybox.ts +475 -475
  920. package/src/engine-components/SmoothFollow.ts +76 -76
  921. package/src/engine-components/SpatialTrigger.ts +229 -229
  922. package/src/engine-components/SpectatorCamera.ts +787 -787
  923. package/src/engine-components/SphereCollider.ts +1 -1
  924. package/src/engine-components/SpriteRenderer.ts +468 -468
  925. package/src/engine-components/SyncedCamera.ts +220 -220
  926. package/src/engine-components/SyncedRoom.ts +380 -380
  927. package/src/engine-components/SyncedTransform.ts +383 -383
  928. package/src/engine-components/TestRunner.ts +118 -118
  929. package/src/engine-components/TransformGizmo.ts +219 -219
  930. package/src/engine-components/VideoPlayer.ts +1025 -1025
  931. package/src/engine-components/Voip.ts +363 -363
  932. package/src/engine-components/api.ts +60 -60
  933. package/src/engine-components/avatar/AvatarBlink_Simple.ts +69 -69
  934. package/src/engine-components/avatar/AvatarEyeLook_Rotation.ts +63 -63
  935. package/src/engine-components/avatar/Avatar_Brain_LookAt.ts +139 -139
  936. package/src/engine-components/avatar/Avatar_MouthShapes.ts +83 -83
  937. package/src/engine-components/avatar/Avatar_MustacheShake.ts +31 -31
  938. package/src/engine-components/codegen/components.ts +217 -217
  939. package/src/engine-components/debug/LogStats.ts +21 -21
  940. package/src/engine-components/export/gltf/GltfExport.ts +265 -265
  941. package/src/engine-components/export/usdz/Extension.ts +24 -24
  942. package/src/engine-components/export/usdz/ThreeUSDZExporter.ts +2426 -2413
  943. package/src/engine-components/export/usdz/USDZExporter.ts +705 -705
  944. package/src/engine-components/export/usdz/extensions/Animation.ts +1204 -1204
  945. package/src/engine-components/export/usdz/extensions/DocumentExtension.ts +9 -9
  946. package/src/engine-components/export/usdz/extensions/NodeMaterialConverter.ts +532 -0
  947. package/src/engine-components/export/usdz/extensions/USDZText.ts +240 -240
  948. package/src/engine-components/export/usdz/extensions/USDZUI.ts +189 -189
  949. package/src/engine-components/export/usdz/extensions/behavior/Actions.ts +99 -99
  950. package/src/engine-components/export/usdz/extensions/behavior/AudioExtension.ts +102 -102
  951. package/src/engine-components/export/usdz/extensions/behavior/Behaviour.ts +320 -320
  952. package/src/engine-components/export/usdz/extensions/behavior/BehaviourComponents.ts +1225 -1225
  953. package/src/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.ts +646 -646
  954. package/src/engine-components/export/usdz/extensions/behavior/PhysicsExtension.ts +132 -132
  955. package/src/engine-components/export/usdz/index.ts +2 -2
  956. package/src/engine-components/export/usdz/utils/animationutils.ts +191 -191
  957. package/src/engine-components/export/usdz/utils/quicklook.ts +50 -50
  958. package/src/engine-components/particlesystem/ParticleSystem.ts +1287 -1287
  959. package/src/engine-components/particlesystem/ParticleSystemModules.ts +1765 -1765
  960. package/src/engine-components/particlesystem/ParticleSystemSubEmitter.ts +111 -111
  961. package/src/engine-components/particlesystem/api.ts +1 -1
  962. package/src/engine-components/postprocessing/Effects/Antialiasing.ts +57 -57
  963. package/src/engine-components/postprocessing/Effects/BloomEffect.ts +116 -118
  964. package/src/engine-components/postprocessing/Effects/ChromaticAberration.ts +37 -37
  965. package/src/engine-components/postprocessing/Effects/ColorAdjustments.ts +106 -106
  966. package/src/engine-components/postprocessing/Effects/DepthOfField.ts +103 -103
  967. package/src/engine-components/postprocessing/Effects/EffectWrapper.ts +25 -25
  968. package/src/engine-components/postprocessing/Effects/Pixelation.ts +32 -32
  969. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.ts +90 -90
  970. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts +192 -192
  971. package/src/engine-components/postprocessing/Effects/Sharpening.ts +143 -143
  972. package/src/engine-components/postprocessing/Effects/TiltShiftEffect.ts +61 -61
  973. package/src/engine-components/postprocessing/Effects/Tonemapping.ts +103 -103
  974. package/src/engine-components/postprocessing/Effects/Tonemapping.utils.ts +60 -60
  975. package/src/engine-components/postprocessing/Effects/Vignette.ts +59 -59
  976. package/src/engine-components/postprocessing/PostProcessingEffect.ts +192 -192
  977. package/src/engine-components/postprocessing/PostProcessingHandler.ts +560 -535
  978. package/src/engine-components/postprocessing/Volume.ts +426 -426
  979. package/src/engine-components/postprocessing/VolumeParameter.ts +158 -158
  980. package/src/engine-components/postprocessing/VolumeProfile.ts +61 -61
  981. package/src/engine-components/postprocessing/index.ts +5 -5
  982. package/src/engine-components/postprocessing/utils.ts +154 -153
  983. package/src/engine-components/timeline/PlayableDirector.ts +722 -722
  984. package/src/engine-components/timeline/SignalAsset.ts +144 -144
  985. package/src/engine-components/timeline/TimelineModels.ts +92 -92
  986. package/src/engine-components/timeline/TimelineTracks.ts +967 -967
  987. package/src/engine-components/timeline/index.ts +3 -3
  988. package/src/engine-components/ui/BaseUIComponent.ts +203 -203
  989. package/src/engine-components/ui/Button.ts +307 -307
  990. package/src/engine-components/ui/Canvas.ts +419 -419
  991. package/src/engine-components/ui/CanvasGroup.ts +54 -54
  992. package/src/engine-components/ui/EventSystem.ts +854 -854
  993. package/src/engine-components/ui/Graphic.ts +275 -275
  994. package/src/engine-components/ui/Image.ts +112 -112
  995. package/src/engine-components/ui/InputField.ts +321 -321
  996. package/src/engine-components/ui/Interfaces.ts +57 -57
  997. package/src/engine-components/ui/Layout.ts +334 -334
  998. package/src/engine-components/ui/Outline.ts +13 -13
  999. package/src/engine-components/ui/PointerEvents.ts +206 -206
  1000. package/src/engine-components/ui/RaycastUtils.ts +69 -69
  1001. package/src/engine-components/ui/Raycaster.ts +102 -102
  1002. package/src/engine-components/ui/RectTransform.ts +375 -375
  1003. package/src/engine-components/ui/SpatialHtml.ts +79 -79
  1004. package/src/engine-components/ui/Symbols.ts +1 -1
  1005. package/src/engine-components/ui/Text.ts +578 -578
  1006. package/src/engine-components/ui/Utils.ts +113 -113
  1007. package/src/engine-components/utils/EnvironmentScene.ts +245 -245
  1008. package/src/engine-components/utils/LookAt.ts +88 -88
  1009. package/src/engine-components/utils/OpenURL.ts +114 -114
  1010. package/src/engine-components/webxr/Avatar.ts +265 -265
  1011. package/src/engine-components/webxr/TeleportTarget.ts +9 -9
  1012. package/src/engine-components/webxr/WebARCameraBackground.ts +175 -175
  1013. package/src/engine-components/webxr/WebARSessionRoot.ts +880 -880
  1014. package/src/engine-components/webxr/WebXR.ts +585 -585
  1015. package/src/engine-components/webxr/WebXRAvatar.ts +66 -66
  1016. package/src/engine-components/webxr/WebXRImageTracking.ts +519 -519
  1017. package/src/engine-components/webxr/WebXRPlaneTracking.ts +570 -570
  1018. package/src/engine-components/webxr/WebXRRig.ts +77 -77
  1019. package/src/engine-components/webxr/XRFlag.ts +147 -147
  1020. package/src/engine-components/webxr/controllers/XRControllerFollow.ts +118 -118
  1021. package/src/engine-components/webxr/controllers/XRControllerModel.ts +373 -373
  1022. package/src/engine-components/webxr/controllers/XRControllerMovement.ts +550 -550
  1023. package/src/engine-components/webxr/index.ts +2 -2
  1024. package/src/engine-components/webxr/types.ts +3 -3
  1025. package/src/engine-components-experimental/Presentation.ts +12 -12
  1026. package/src/engine-components-experimental/api.ts +4 -4
  1027. package/src/engine-components-experimental/networking/PlayerSync.ts +401 -401
  1028. package/src/engine-schemes/COMPILE_SCHEMES.bat +3 -3
  1029. package/src/engine-schemes/COMPILE_TS.bat +11 -11
  1030. package/src/engine-schemes/README.md +1 -1
  1031. package/src/engine-schemes/api.ts +12 -12
  1032. package/src/engine-schemes/dist/api.js +17 -0
  1033. package/src/engine-schemes/dist/api.js.meta +7 -0
  1034. package/src/engine-schemes/dist/schemes.js +25 -0
  1035. package/src/engine-schemes/dist/schemes.js.meta +7 -0
  1036. package/src/engine-schemes/dist/synced-camera-model.js +74 -0
  1037. package/src/engine-schemes/dist/synced-camera-model.js.meta +7 -0
  1038. package/src/engine-schemes/dist/synced-transform-model.js +73 -0
  1039. package/src/engine-schemes/dist/synced-transform-model.js.meta +7 -0
  1040. package/src/engine-schemes/dist/transform.js +46 -0
  1041. package/src/engine-schemes/dist/transform.js.meta +7 -0
  1042. package/src/engine-schemes/dist/vec2.js +32 -0
  1043. package/src/engine-schemes/dist/vec2.js.meta +7 -0
  1044. package/src/engine-schemes/dist/vec3.js +36 -0
  1045. package/src/engine-schemes/dist/vec3.js.meta +7 -0
  1046. package/src/engine-schemes/dist/vec4.js +40 -0
  1047. package/src/engine-schemes/dist/vec4.js.meta +7 -0
  1048. package/src/engine-schemes/dist/vr-user-state-buffer.js +110 -0
  1049. package/src/engine-schemes/dist/vr-user-state-buffer.js.meta +7 -0
  1050. package/src/engine-schemes/schemes.ts +28 -28
  1051. package/src/engine-schemes/synced-camera-model.ts +92 -92
  1052. package/src/engine-schemes/synced-transform-model.ts +90 -90
  1053. package/src/engine-schemes/syncedCamera.fbs +10 -10
  1054. package/src/engine-schemes/transform.ts +50 -50
  1055. package/src/engine-schemes/transforms.fbs +25 -25
  1056. package/src/engine-schemes/vec.fbs +19 -19
  1057. package/src/engine-schemes/vec2.ts +33 -33
  1058. package/src/engine-schemes/vec3.ts +38 -38
  1059. package/src/engine-schemes/vec4.ts +43 -43
  1060. package/src/engine-schemes/vr-user-state-buffer.ts +145 -145
  1061. package/src/engine-schemes/vrUserStateBuffer.fbs +17 -17
  1062. package/src/include/draco/draco_decoder.js +34 -34
  1063. package/src/include/ktx2/basis_transcoder.js +21 -21
  1064. package/src/include/needle/arial-msdf.json +1471 -1471
  1065. package/src/include/three/DragControls.js +231 -231
  1066. package/src/include/three/EXT_mesh_gpu_instancing_exporter.js +66 -66
  1067. package/src/needle-engine.ts +70 -70
  1068. package/dist/generateMeshBVH.worker-BaNp_Xtp.js +0 -25
  1069. package/dist/needle-engine.bundle-D0XWaCQs.min.js +0 -1575
@@ -1,765 +1,765 @@
1
- const defaultNetworkingBackendUrlProvider = "https://urls.needle.tools/default-networking-backend/index";
2
- let networkingServerUrl = "wss://networking.needle.tools/socket";
3
- import * as flatbuffers from 'flatbuffers';
4
- import * as schemes from "../engine-schemes/schemes.js";
5
- import { isDevEnvironment } from './debug/index.js';
6
- import { PeerNetworking } from './engine_networking_peer.js';
7
- import { SendQueue } from './engine_networking_types.js';
8
- import { isHostedOnGlitch } from './engine_networking_utils.js';
9
- import * as utils from "./engine_utils.js";
10
- export const debugNet = utils.getParam("debugnet") ? true : false;
11
- export const debugOwner = debugNet || utils.getParam("debugowner") ? true : false;
12
- const debugnetBin = utils.getParam("debugnetbin");
13
- /** Events regarding the websocket connection (e.g. when the connection opens) */
14
- export var ConnectionEvents;
15
- (function (ConnectionEvents) {
16
- ConnectionEvents["ConnectionInfo"] = "connection-start-info";
17
- })(ConnectionEvents || (ConnectionEvents = {}));
18
- /** Use to listen to room networking events like joining a networked room
19
- * For example: `this.context.connection.beginListen(RoomEvents.JoinedRoom, () => { })`
20
- * @link https://engine.needle.tools/docs/networking.html#manual-networking
21
- * */
22
- export var RoomEvents;
23
- (function (RoomEvents) {
24
- /** Internal: Sent to the server when attempting to join a room */
25
- RoomEvents["Join"] = "join-room";
26
- /** Internal: Sent to the server when attempting to leave a room */
27
- RoomEvents["Leave"] = "leave-room";
28
- /** Incoming: When the local user has joined a room */
29
- RoomEvents["JoinedRoom"] = "joined-room";
30
- /** Incoming: When the local user has left a room */
31
- RoomEvents["LeftRoom"] = "left-room";
32
- /** Incoming: When a other user has joined the room */
33
- RoomEvents["UserJoinedRoom"] = "user-joined-room";
34
- /** Incoming: When a other user has left the room */
35
- RoomEvents["UserLeftRoom"] = "user-left-room";
36
- /** When a user joins a room, the server sends the entire room state. Afterwards, the server sends the room-state-sent event. */
37
- RoomEvents["RoomStateSent"] = "room-state-sent";
38
- })(RoomEvents || (RoomEvents = {}));
39
- /** Received when listening to `RoomEvents.JoinedRoom` event */
40
- export class JoinedRoomResponse {
41
- room; // room name
42
- viewId;
43
- allowEditing;
44
- inRoom; // connection ids
45
- }
46
- export class LeftRoomResponse {
47
- room; // room name
48
- }
49
- export class UserJoinedOrLeftRoomModel {
50
- userId;
51
- }
52
- /** The Needle Engine networking server supports the concept of ownership that can be requested.
53
- * This enum contains possible outgoing (Request*) and incoming (Response*) events for communicating ownership.
54
- *
55
- * Typically, using the {@link OwnershipModel} class instead of dealing with those events directly is preferred. */
56
- export var OwnershipEvent;
57
- (function (OwnershipEvent) {
58
- OwnershipEvent["RequestHasOwner"] = "request-has-owner";
59
- OwnershipEvent["ResponseHasOwner"] = "response-has-owner";
60
- OwnershipEvent["RequestIsOwner"] = "request-is-owner";
61
- OwnershipEvent["ResponseIsOwner"] = "response-is-owner";
62
- OwnershipEvent["RequestOwnership"] = "request-ownership";
63
- OwnershipEvent["GainedOwnership"] = "gained-ownership";
64
- OwnershipEvent["RemoveOwnership"] = "remove-ownership";
65
- OwnershipEvent["LostOwnership"] = "lost-ownership";
66
- OwnershipEvent["GainedOwnershipBroadcast"] = "gained-ownership-broadcast";
67
- OwnershipEvent["LostOwnershipBroadcast"] = "lost-ownership-broadcast";
68
- })(OwnershipEvent || (OwnershipEvent = {}));
69
- /** Class for abstracting the concept of ownership regarding a networked object or component.
70
- * A component that is owned by another user can not be modified through networking (the server will reject changes) */
71
- export class OwnershipModel {
72
- guid;
73
- connection;
74
- get hasOwnership() {
75
- return this._hasOwnership;
76
- }
77
- // TODO: server should just send id to everyone
78
- /** @returns true of anyone has ownership */
79
- get isOwned() {
80
- return this._isOwned;
81
- }
82
- /**
83
- * Checks if Needle Engine networking is connected to a websocket. Note that this is **not equal** to being connected to a *room*. If you want to check if Needle Engine is connected to a networking room use the `isInRoom` property.
84
- * @returns true if connected to the websocket.
85
- */
86
- get isConnected() {
87
- return this.connection.isConnected;
88
- }
89
- _hasOwnership = false;
90
- _isOwned = undefined;
91
- _gainSubscription;
92
- _lostSubscription;
93
- _hasOwnerResponse;
94
- constructor(connection, guid) {
95
- this.connection = connection;
96
- this.guid = guid;
97
- this._gainSubscription = this.onGainedOwnership.bind(this);
98
- this._lostSubscription = this.onLostOwnership.bind(this);
99
- connection.beginListen(OwnershipEvent.LostOwnership, this._lostSubscription);
100
- connection.beginListen(OwnershipEvent.GainedOwnershipBroadcast, this._gainSubscription);
101
- this._hasOwnerResponse = this.onHasOwnerResponse.bind(this);
102
- connection.beginListen(OwnershipEvent.ResponseHasOwner, this._hasOwnerResponse);
103
- }
104
- _isWaitingForOwnershipResponseCallback = null;
105
- updateIsOwned() {
106
- this.connection.send(OwnershipEvent.RequestHasOwner, { guid: this.guid });
107
- }
108
- onHasOwnerResponse(res) {
109
- if (res.guid === this.guid) {
110
- this._isOwned = res.value;
111
- }
112
- }
113
- requestOwnershipIfNotOwned() {
114
- if (this._isWaitingForOwnershipResponseCallback !== null)
115
- return this;
116
- this._isWaitingForOwnershipResponseCallback = this.waitForHasOwnershipRequestResponse.bind(this);
117
- this.connection.beginListen(OwnershipEvent.ResponseHasOwner, this._isWaitingForOwnershipResponseCallback);
118
- this.connection.send(OwnershipEvent.RequestHasOwner, { guid: this.guid });
119
- return this;
120
- }
121
- waitForHasOwnershipRequestResponse(res) {
122
- // console.log(res);
123
- if (res.guid === this.guid) {
124
- if (this._isWaitingForOwnershipResponseCallback) {
125
- this.connection.stopListen(OwnershipEvent.ResponseHasOwner, this._isWaitingForOwnershipResponseCallback);
126
- this._isWaitingForOwnershipResponseCallback = null;
127
- }
128
- this._isOwned = res.value;
129
- if (!res.value) {
130
- if (debugOwner)
131
- console.log("request ownership", this.guid);
132
- this.requestOwnership();
133
- }
134
- }
135
- }
136
- requestOwnershipAsync() {
137
- return new Promise((resolve, reject) => {
138
- this.requestOwnership();
139
- let updates = 0;
140
- const waitForOwnership = () => {
141
- if (updates++ > 10)
142
- return reject("Timeout");
143
- setTimeout(() => {
144
- if (this.hasOwnership)
145
- resolve(this);
146
- else
147
- waitForOwnership();
148
- }, 100);
149
- };
150
- waitForOwnership();
151
- });
152
- }
153
- requestOwnership() {
154
- if (debugOwner)
155
- console.log("Request ownership", this.guid);
156
- this.connection.send(OwnershipEvent.RequestOwnership, { guid: this.guid });
157
- return this;
158
- }
159
- freeOwnership() {
160
- // TODO: abort "requestOwnershipIfNotOwned"
161
- this.connection.send(OwnershipEvent.RemoveOwnership, { guid: this.guid });
162
- if (this._isWaitingForOwnershipResponseCallback) {
163
- this.connection.stopListen(OwnershipEvent.ResponseHasOwner, this._isWaitingForOwnershipResponseCallback);
164
- this._isWaitingForOwnershipResponseCallback = null;
165
- }
166
- return this;
167
- }
168
- destroy() {
169
- this.connection.stopListen(OwnershipEvent.GainedOwnership, this._gainSubscription);
170
- this.connection.stopListen(OwnershipEvent.LostOwnership, this._lostSubscription);
171
- this.connection.stopListen(OwnershipEvent.ResponseHasOwner, this._hasOwnerResponse);
172
- if (this._isWaitingForOwnershipResponseCallback) {
173
- this.connection.stopListen(OwnershipEvent.ResponseHasOwner, this._isWaitingForOwnershipResponseCallback);
174
- this._isWaitingForOwnershipResponseCallback = null;
175
- }
176
- }
177
- onGainedOwnership(res) {
178
- if (res.guid === this.guid) {
179
- this._isOwned = true;
180
- // console.log(res.owner, connection.connectionId)
181
- if (this.connection.connectionId === res.owner) {
182
- if (debugOwner)
183
- console.log("GAINED OWNERSHIP", this.guid);
184
- this._hasOwnership = true;
185
- }
186
- else
187
- this._hasOwnership = false;
188
- }
189
- }
190
- onLostOwnership(guid) {
191
- if (guid === this.guid) {
192
- if (debugOwner)
193
- console.log("LOST OWNERSHIP", this.guid);
194
- this._hasOwnership = false;
195
- this._isOwned = false;
196
- }
197
- }
198
- }
199
- /** Main class to communicate with the networking backend
200
- * @link https://engine.needle.tools/docs/networking.html
201
- *
202
- */
203
- export class NetworkConnection {
204
- context;
205
- _peer = null;
206
- constructor(context) {
207
- this.context = context;
208
- }
209
- /** Experimental: networking via peerjs */
210
- get peer() {
211
- if (!this._peer) {
212
- this._peer = new PeerNetworking();
213
- }
214
- return this._peer;
215
- }
216
- /**
217
- * Returns the state of a given guid.
218
- */
219
- tryGetState(guid) {
220
- if (guid === "invalid")
221
- return null;
222
- return this._state[guid];
223
- }
224
- /** The connection id of the local user - it is given by the networking backend and can not be changed */
225
- get connectionId() {
226
- return this._connectionId;
227
- }
228
- /** Returns true if the networking backend is in debug mode.
229
- * To see all networking messages in the console use `?debugnet` in the url
230
- */
231
- get isDebugEnabled() {
232
- return debugNet;
233
- }
234
- /**
235
- * Checks if Needle Engine networking is connected to a websocket. Note that this is **not equal** to being connected to a *room*. If you want to check if Needle Engine is connected to a networking room use the `isInRoom` property.
236
- * @returns true if connected to the websocket.
237
- */
238
- get isConnected() {
239
- return this.connected;
240
- }
241
- /** The name of the room the user is currently connected to */
242
- get currentRoomName() { return this._currentRoomName; }
243
- /** True when connected to a room via a regular url, otherwise (when using a view only url) false indicating that the user should not be able to modify the scene */
244
- get allowEditing() { return this._currentRoomAllowEditing; }
245
- /**
246
- * The view id of the room the user is currently connected to.
247
- */
248
- get currentRoomViewId() { return this._currentRoomViewId; }
249
- /**
250
- * Returns a url that can be shared with others to view the current room in view only mode.
251
- * This is useful for sharing a room with others without allowing them to modify the scene.
252
- * Use `connection.allowEditing` to check if the current room is in view only mode.
253
- */
254
- getViewOnlyUrl() {
255
- if (this.currentRoomViewId === null)
256
- return null;
257
- const url = new URL(window.location.href);
258
- url.searchParams.set("view", this.currentRoomViewId);
259
- return url.href;
260
- }
261
- /** True if connected to a networked room. Use the joinRoom function or a `SyncedRoom` component */
262
- get isInRoom() {
263
- return this._isInRoom;
264
- }
265
- /** Latency to currently connected backend server */
266
- get currentLatency() {
267
- return this._currentDelay;
268
- }
269
- /**
270
- * The current server url that the networking backend is connected to (e.g. the url of the websocket server)
271
- */
272
- get currentServerUrl() {
273
- // @ts-ignore (in ts-websocket 2.x this property is exposed)
274
- return this._ws?.url ?? null;
275
- }
276
- /** A ping is sent to the server at a regular interval while the browser tab is active. This method can be used to send additional ping messages when needed so that the user doesn't get disconnected from the networking backend */
277
- sendPing() {
278
- this.send("ping", { time: this.context.time.time });
279
- }
280
- /** Returns true if a user with the given connectionId is in the room */
281
- userIsInRoom(id) {
282
- return this._currentInRoom.indexOf(id) !== -1;
283
- }
284
- _usersInRoomCopy = [];
285
- /** Returns a list of all user ids in the current room */
286
- usersInRoom(target = null) {
287
- if (!target)
288
- target = this._usersInRoomCopy;
289
- target.length = 0;
290
- for (const user of this._currentInRoom)
291
- target.push(user);
292
- return target;
293
- }
294
- /** Joins a networked room. If you don't want to manage a connection yourself you can use a `SyncedRoom` component as well */
295
- joinRoom(room, viewOnly = false) {
296
- if (!room) {
297
- console.error("Missing room name, can not join: \"" + room + "\"");
298
- return false;
299
- }
300
- // There's not really a reason to limit the room name length
301
- if (room.length > 1024) {
302
- console.error("Room name too long, can not join: \"" + room + "\". Max length is 1024 characters.");
303
- return false;
304
- }
305
- else if (this.isInRoom && this.currentRoomName !== room) {
306
- console.warn("Needle Engine is already connected to a networking room. Connecting to multiple rooms is not supported");
307
- }
308
- this.connect();
309
- if (debugNet)
310
- console.log("join: " + room);
311
- this.send(RoomEvents.Join, { room: room, viewOnly: viewOnly }, SendQueue.OnConnection);
312
- return true;
313
- }
314
- /** Use to leave a room that you are currently connected to (use `leaveRoom()` to disconnect from the currently active room but you can also specify a room name) */
315
- leaveRoom(room = null) {
316
- if (!room)
317
- room = this.currentRoomName;
318
- if (!room) {
319
- console.error("Missing room name, can not join: \"" + room + "\"");
320
- return false;
321
- }
322
- this.send(RoomEvents.Leave, { room: room });
323
- return true;
324
- }
325
- /** Send a message to the networking backend - it will broadcasted to all connected users in the same room by default */
326
- send(key, data = null, queue = SendQueue.Queued) {
327
- //@ts-ignore
328
- if (data === null)
329
- data = {};
330
- if (queue === SendQueue.Queued) {
331
- this._defaultMessagesBuffer.push({ key: key, value: data });
332
- return;
333
- }
334
- // if (!this.connected) return;
335
- // if (this.channelId)
336
- // data["__id"] = this.channelId;
337
- // else if (this.connectionId)
338
- // data["__id"] = this.connectionId;
339
- // this.sendGeckosIo(key, data);
340
- return this.sendWithWebsocket(key, data, queue);
341
- }
342
- /** Use to delete state for a given guid on the server */
343
- sendDeleteRemoteState(guid) {
344
- this.send("delete-state", { guid: guid, dontSave: true });
345
- delete this._state[guid];
346
- }
347
- /** Use to delete all state in the currently connected room on the server */
348
- sendDeleteRemoteStateAll() {
349
- this.send("delete-all-state");
350
- this._state = {};
351
- }
352
- /** Send a binary message to the server (broadcasted to all connected users) */
353
- sendBinary(bin) {
354
- if (debugnetBin)
355
- console.log("<< send binary", this.context.time.frame, (bin.length / 1024) + " KB");
356
- this._ws?.send(bin);
357
- }
358
- _defaultMessagesBuffer = [];
359
- _defaultMessagesBufferArray = [];
360
- sendBufferedMessagesNow() {
361
- if (!this._ws)
362
- return;
363
- this._defaultMessagesBufferArray.length = 0;
364
- const count = Object.keys(this._defaultMessagesBuffer).length;
365
- for (const key in this._defaultMessagesBuffer) {
366
- const data = this._defaultMessagesBuffer[key];
367
- // if there is only one message to be sent we dont need to send an array
368
- if (count <= 1) {
369
- this.sendWithWebsocket(data.key, data.value, SendQueue.Immediate);
370
- break;
371
- }
372
- const msg = this.toMessage(data.key, data.value);
373
- this._defaultMessagesBufferArray.push(msg);
374
- }
375
- this._defaultMessagesBuffer.length = 0;
376
- if (this._defaultMessagesBufferArray.length > 0 && debugNet)
377
- console.log("SEND BUFFERED", this._defaultMessagesBufferArray.length);
378
- if (this._defaultMessagesBufferArray.length <= 0)
379
- return;
380
- const message = JSON.stringify(this._defaultMessagesBufferArray);
381
- this._ws?.send(message);
382
- }
383
- /** Use to start listening to networking events.
384
- * To unsubscribe from events use the `stopListen` method.
385
- * See the example below for typical usage:
386
- *
387
- * ### Component Example
388
- * ```ts
389
- * // Make sure to unsubscribe from events when the component is disabled
390
- * export class MyComponent extends Behaviour {
391
- * onEnable() {
392
- * this.connection.beginListen("joined-room", this.onJoinedRoom)
393
- * }
394
- * onDisable() {
395
- * this.connection.stopListen("joined-room", this.onJoinedRoom)
396
- * }
397
- * onJoinedRoom = () => {
398
- * console.log("I joined a networked room")
399
- * }
400
- * }
401
- * ```
402
- * @link https://engine.needle.tools/docs/networking.html
403
- *
404
- */
405
- beginListen(key, callback) {
406
- if (!this._listeners[key])
407
- this._listeners[key] = [];
408
- this._listeners[key].push(callback);
409
- return callback;
410
- }
411
- /**@deprecated please use stopListen instead (2.65.2-pre) */
412
- stopListening(key, callback) { return this.stopListen(key, callback); }
413
- /** Use to stop listening to networking events
414
- * To subscribe to events use the `beginListen` method.
415
- * See the example below for typical usage:
416
- *
417
- * ### Component Example
418
- * ```ts
419
- * // Make sure to unsubscribe from events when the component is disabled
420
- * export class MyComponent extends Behaviour {
421
- * onEnable() {
422
- * this.connection.beginListen("joined-room", this.onJoinedRoom)
423
- * }
424
- * onDisable() {
425
- * this.connection.stopListen("joined-room", this.onJoinedRoom)
426
- * }
427
- * onJoinedRoom = () => {
428
- * console.log("I joined a networked room")
429
- * }
430
- * }
431
- * ```
432
- */
433
- stopListen(key, callback) {
434
- if (!callback)
435
- return;
436
- if (!this._listeners[key])
437
- return;
438
- const index = this._listeners[key].indexOf(callback);
439
- if (index >= 0) {
440
- this._listeners[key].splice(index, 1);
441
- }
442
- }
443
- /** Use to start listening to networking binary events */
444
- beginListenBinary(identifier, callback) {
445
- if (!this._listenersBinary[identifier])
446
- this._listenersBinary[identifier] = [];
447
- this._listenersBinary[identifier].push(callback);
448
- return callback;
449
- }
450
- /** Use to stop listening to networking binary events */
451
- stopListenBinary(identifier, callback) {
452
- if (!this._listenersBinary[identifier])
453
- return;
454
- const index = this._listenersBinary[identifier].indexOf(callback);
455
- if (index >= 0) {
456
- this._listenersBinary[identifier].splice(index, 1);
457
- }
458
- }
459
- netWebSocketUrlProvider;
460
- /** Use to override the networking server backend url. This is what the `Networking` component uses to modify the backend url */
461
- registerProvider(prov) {
462
- this.netWebSocketUrlProvider = prov;
463
- }
464
- /** Used to connect to the networking server */
465
- async connect(url) {
466
- if (this.connected && url && url !== networkingServerUrl) {
467
- return Promise.reject("Can not connect to different server url. Please disconnect first.");
468
- }
469
- if (this.connected) {
470
- return Promise.resolve(true);
471
- }
472
- if (url)
473
- console.debug("Connecting to user provided url " + url);
474
- const overrideUrl = url || this.netWebSocketUrlProvider?.getWebsocketUrl();
475
- if (overrideUrl) {
476
- networkingServerUrl = overrideUrl;
477
- }
478
- else if (isHostedOnGlitch()) {
479
- networkingServerUrl = "wss://" + window.location.host + "/socket";
480
- }
481
- return this.connectWebsocket();
482
- }
483
- ;
484
- /** Disconnect from the networking backend + reset internal state */
485
- disconnect() {
486
- this._ws?.close();
487
- this._ws = undefined;
488
- networkingServerUrl = undefined;
489
- // Reset all state
490
- this._currentRoomAllowEditing = true;
491
- this._currentRoomName = null;
492
- this._currentRoomViewId = null;
493
- this._isInRoom = false;
494
- this._currentInRoom.length = 0;
495
- this._state = {};
496
- this._currentDelay = -1;
497
- }
498
- _listeners = {};
499
- _listenersBinary = {};
500
- connected = false;
501
- channelId;
502
- _connectionId = null;
503
- // Websocket ------------------------------------------------------------
504
- _ws;
505
- _waitingForSocket = {};
506
- _isInRoom = false;
507
- _currentRoomName = null;
508
- _currentRoomViewId = null;
509
- _currentRoomAllowEditing = true;
510
- _currentInRoom = [];
511
- _state = {};
512
- _currentDelay = -1;
513
- _connectingToWebsocketPromise = null;
514
- connectWebsocket() {
515
- if (this._connectingToWebsocketPromise)
516
- return this._connectingToWebsocketPromise;
517
- return this._connectingToWebsocketPromise = new Promise(async (res, _) => {
518
- let didResolve = false;
519
- const resolve = (val) => {
520
- if (didResolve)
521
- return;
522
- didResolve = true;
523
- res(val);
524
- };
525
- if (networkingServerUrl === undefined) {
526
- console.log("Fetch default backend url: " + defaultNetworkingBackendUrlProvider);
527
- const failed = false;
528
- const defaultUrlResponse = await fetch(defaultNetworkingBackendUrlProvider);
529
- networkingServerUrl = await defaultUrlResponse.text();
530
- if (failed)
531
- return;
532
- }
533
- if (networkingServerUrl === undefined) {
534
- resolve(false);
535
- return;
536
- }
537
- console.debug("⊡ Connecting to networking backend on\n" + networkingServerUrl);
538
- const pkg = await import('websocket-ts');
539
- // @ts-ignore
540
- const WebsocketBuilder = pkg.default?.WebsocketBuilder ?? pkg.WebsocketBuilder;
541
- const ExponentialBackoff = pkg.default?.ExponentialBackoff ?? pkg.ExponentialBackoff;
542
- const ws = new WebsocketBuilder(networkingServerUrl)
543
- .withMaxRetries(10)
544
- .withBackoff(new ExponentialBackoff(2000, 4))
545
- .onOpen(() => {
546
- this._connectingToWebsocketPromise = null;
547
- this._ws = ws;
548
- this.connected = true;
549
- if (isDevEnvironment() || debugNet)
550
- console.log("⊞ Connected to networking backend\n" + networkingServerUrl);
551
- else
552
- console.debug("⊞ Connected to networking backend", networkingServerUrl);
553
- resolve(true);
554
- this.onSendQueued(SendQueue.OnConnection);
555
- })
556
- .onClose((_evt) => {
557
- this._connectingToWebsocketPromise = null;
558
- this.connected = false;
559
- this._isInRoom = false;
560
- resolve(false);
561
- let msg = "Websocket connection closed...";
562
- if (!networkingServerUrl?.includes("/socket"))
563
- msg += ` Do you perhaps mean to connect to \"/socket\"?`;
564
- console.error(msg);
565
- })
566
- .onError((_e) => {
567
- console.error("⊠ Websocket connection failed...");
568
- resolve(false);
569
- })
570
- .onRetry(() => { console.log("→ Retry connecting to networking websocket"); })
571
- .build();
572
- ws.addEventListener(pkg.WebsocketEvent.message, (socket, msg) => {
573
- this.onMessage(socket, msg);
574
- });
575
- });
576
- }
577
- onMessage(_, ev) {
578
- const msg = ev.data;
579
- try {
580
- if (typeof msg !== "string") {
581
- if (msg.size) {
582
- // is binary blob
583
- this.handleIncomingBinaryMessage(msg);
584
- }
585
- return;
586
- }
587
- const message = JSON.parse(msg);
588
- if (Array.isArray(message)) {
589
- // console.log("Receive package of " + message.length + " messages")
590
- for (const msg of message) {
591
- this.handleIncomingStringMessage(msg);
592
- }
593
- }
594
- else
595
- this.handleIncomingStringMessage(message);
596
- return;
597
- }
598
- catch (err) {
599
- if (debugNet && msg === "pong")
600
- console.log("<<", msg);
601
- else if (isDevEnvironment())
602
- console.error("Failed to parse message", err);
603
- }
604
- }
605
- async handleIncomingBinaryMessage(blob) {
606
- if (debugnetBin)
607
- console.log("<< bin", this.context.time.frame);
608
- const buf = await blob.arrayBuffer();
609
- var data = new Uint8Array(buf);
610
- const bb = new flatbuffers.ByteBuffer(data);
611
- const id = bb.getBufferIdentifier();
612
- const callbacks = this._listenersBinary[id];
613
- // use registered cast methods to get the correct type from the flatbuffer
614
- const obj = schemes.tryCastBinary(bb);
615
- const guid = schemes.tryGetGuid(obj);
616
- if (guid && typeof guid === "string") {
617
- this._state[guid] = obj;
618
- }
619
- if (!callbacks)
620
- return;
621
- const res = obj ?? bb; // fallback to bytebuffer if no cast method is registered
622
- // call all listeners subscribed to these events
623
- for (const cb of callbacks) {
624
- cb(res);
625
- }
626
- }
627
- handleIncomingStringMessage(message) {
628
- if (debugNet)
629
- console.log("<<", message.key ?? message);
630
- if (message.key) {
631
- switch (message.key) {
632
- case ConnectionEvents.ConnectionInfo:
633
- if (message.data) {
634
- const connection = message.data;
635
- if (connection) {
636
- console.assert(connection.id !== undefined && connection.id !== null && connection.id.length > 0, "server did not send connection id", connection.id);
637
- console.debug("Your id is: " + connection.id, this.context.alias ?? "");
638
- this._connectionId = connection.id;
639
- }
640
- }
641
- else
642
- console.warn("Expected connection id in " + message.key);
643
- break;
644
- case RoomEvents.JoinedRoom:
645
- if (debugNet)
646
- console.log(message);
647
- if (message) {
648
- this._isInRoom = true;
649
- const model = message;
650
- this._currentRoomName = model.room;
651
- this._currentRoomViewId = model.viewId;
652
- this._currentRoomAllowEditing = model.allowEditing ?? true;
653
- this._currentInRoom.length = 0;
654
- this._currentInRoom.push(...model.inRoom);
655
- if (debugnetBin || isDevEnvironment())
656
- console.debug("Joined Needle Engine Room: " + model.room);
657
- const viewUrl = new URL(window.location.href);
658
- if (viewUrl.searchParams.has("room")) {
659
- viewUrl.searchParams.delete("room");
660
- }
661
- viewUrl.searchParams.set("view", this._currentRoomViewId);
662
- console.debug(`Room view id: ${this._currentRoomViewId}\n${viewUrl.href}`);
663
- }
664
- this.onSendQueued(SendQueue.OnRoomJoin);
665
- break;
666
- case RoomEvents.LeftRoom:
667
- const model = message;
668
- if (model.room === this.currentRoomName) {
669
- this._isInRoom = false;
670
- this._currentRoomName = null;
671
- this._currentRoomAllowEditing = true;
672
- this._currentInRoom.length = 0;
673
- if (debugnetBin || isDevEnvironment())
674
- console.debug("Left Needle Engine Room: " + model.room);
675
- }
676
- break;
677
- case RoomEvents.UserJoinedRoom:
678
- if (message.data) {
679
- const model = message.data;
680
- this._currentInRoom.push(model.userId);
681
- if (debugNet)
682
- console.log(model.userId + " joined", "now in room:", this._currentInRoom);
683
- }
684
- break;
685
- case RoomEvents.UserLeftRoom:
686
- if (message.data) {
687
- const model = message.data;
688
- const index = this._currentInRoom.indexOf(model.userId);
689
- if (index >= 0) {
690
- if (debugNet)
691
- console.log(model.userId + " left", "now in room:", this._currentInRoom);
692
- this._currentInRoom.splice(index, 1);
693
- }
694
- if (model.userId === this.connectionId) {
695
- // you left the room
696
- console.log("you left the room");
697
- }
698
- }
699
- break;
700
- case "all-room-state-deleted":
701
- if (debugNet)
702
- console.log("RECEIVED all-room-state-deleted");
703
- this._state = {};
704
- break;
705
- case "ping":
706
- case "pong":
707
- const time = message.data?.time;
708
- if (time) {
709
- this._currentDelay = this.context.time.time - time;
710
- }
711
- if (debugNet)
712
- console.log(`Current latency: ${(this._currentDelay * 1000).toFixed()} ms`, "Clients in room: " + this._currentInRoom?.length);
713
- break;
714
- }
715
- }
716
- const model = message.data;
717
- if (model) {
718
- this._state[model.guid] = model;
719
- }
720
- let listeners = this._listeners[message.key];
721
- if (listeners) {
722
- // Copy listeners array in case a listener is removed while iterating
723
- listeners = [...listeners];
724
- for (const listener of listeners) {
725
- try {
726
- listener(message.data);
727
- }
728
- catch (err) {
729
- console.error("Error invoking callback for \"" + message.key + "\"", err);
730
- }
731
- }
732
- }
733
- }
734
- toMessage(key, data) {
735
- return {
736
- key: key,
737
- data: data
738
- };
739
- }
740
- sendWithWebsocket(key, data, queue = SendQueue.OnRoomJoin) {
741
- // console.log(key);
742
- if (!this._ws) {
743
- const arr = this._waitingForSocket[queue] || [];
744
- arr.push(() => this.sendWithWebsocket(key, data, queue));
745
- this._waitingForSocket[queue] = arr;
746
- // console.log(this._bufferedMessages)
747
- return;
748
- }
749
- const str = JSON.stringify(this.toMessage(key, data));
750
- if (debugNet)
751
- console.log(">>", key);
752
- this._ws.send(str);
753
- }
754
- onSendQueued(queue) {
755
- const queued = this._waitingForSocket[queue];
756
- // console.log("send", queue, queued);
757
- if (queued) {
758
- for (const callback of queued) {
759
- callback();
760
- }
761
- queued.length = 0;
762
- }
763
- }
764
- }
1
+ const defaultNetworkingBackendUrlProvider = "https://urls.needle.tools/default-networking-backend/index";
2
+ let networkingServerUrl = "wss://networking.needle.tools/socket";
3
+ import * as flatbuffers from 'flatbuffers';
4
+ import * as schemes from "../engine-schemes/schemes.js";
5
+ import { isDevEnvironment } from './debug/index.js';
6
+ import { PeerNetworking } from './engine_networking_peer.js';
7
+ import { SendQueue } from './engine_networking_types.js';
8
+ import { isHostedOnGlitch } from './engine_networking_utils.js';
9
+ import * as utils from "./engine_utils.js";
10
+ export const debugNet = utils.getParam("debugnet") ? true : false;
11
+ export const debugOwner = debugNet || utils.getParam("debugowner") ? true : false;
12
+ const debugnetBin = utils.getParam("debugnetbin");
13
+ /** Events regarding the websocket connection (e.g. when the connection opens) */
14
+ export var ConnectionEvents;
15
+ (function (ConnectionEvents) {
16
+ ConnectionEvents["ConnectionInfo"] = "connection-start-info";
17
+ })(ConnectionEvents || (ConnectionEvents = {}));
18
+ /** Use to listen to room networking events like joining a networked room
19
+ * For example: `this.context.connection.beginListen(RoomEvents.JoinedRoom, () => { })`
20
+ * @link https://engine.needle.tools/docs/networking.html#manual-networking
21
+ * */
22
+ export var RoomEvents;
23
+ (function (RoomEvents) {
24
+ /** Internal: Sent to the server when attempting to join a room */
25
+ RoomEvents["Join"] = "join-room";
26
+ /** Internal: Sent to the server when attempting to leave a room */
27
+ RoomEvents["Leave"] = "leave-room";
28
+ /** Incoming: When the local user has joined a room */
29
+ RoomEvents["JoinedRoom"] = "joined-room";
30
+ /** Incoming: When the local user has left a room */
31
+ RoomEvents["LeftRoom"] = "left-room";
32
+ /** Incoming: When a other user has joined the room */
33
+ RoomEvents["UserJoinedRoom"] = "user-joined-room";
34
+ /** Incoming: When a other user has left the room */
35
+ RoomEvents["UserLeftRoom"] = "user-left-room";
36
+ /** When a user joins a room, the server sends the entire room state. Afterwards, the server sends the room-state-sent event. */
37
+ RoomEvents["RoomStateSent"] = "room-state-sent";
38
+ })(RoomEvents || (RoomEvents = {}));
39
+ /** Received when listening to `RoomEvents.JoinedRoom` event */
40
+ export class JoinedRoomResponse {
41
+ room; // room name
42
+ viewId;
43
+ allowEditing;
44
+ inRoom; // connection ids
45
+ }
46
+ export class LeftRoomResponse {
47
+ room; // room name
48
+ }
49
+ export class UserJoinedOrLeftRoomModel {
50
+ userId;
51
+ }
52
+ /** The Needle Engine networking server supports the concept of ownership that can be requested.
53
+ * This enum contains possible outgoing (Request*) and incoming (Response*) events for communicating ownership.
54
+ *
55
+ * Typically, using the {@link OwnershipModel} class instead of dealing with those events directly is preferred. */
56
+ export var OwnershipEvent;
57
+ (function (OwnershipEvent) {
58
+ OwnershipEvent["RequestHasOwner"] = "request-has-owner";
59
+ OwnershipEvent["ResponseHasOwner"] = "response-has-owner";
60
+ OwnershipEvent["RequestIsOwner"] = "request-is-owner";
61
+ OwnershipEvent["ResponseIsOwner"] = "response-is-owner";
62
+ OwnershipEvent["RequestOwnership"] = "request-ownership";
63
+ OwnershipEvent["GainedOwnership"] = "gained-ownership";
64
+ OwnershipEvent["RemoveOwnership"] = "remove-ownership";
65
+ OwnershipEvent["LostOwnership"] = "lost-ownership";
66
+ OwnershipEvent["GainedOwnershipBroadcast"] = "gained-ownership-broadcast";
67
+ OwnershipEvent["LostOwnershipBroadcast"] = "lost-ownership-broadcast";
68
+ })(OwnershipEvent || (OwnershipEvent = {}));
69
+ /** Class for abstracting the concept of ownership regarding a networked object or component.
70
+ * A component that is owned by another user can not be modified through networking (the server will reject changes) */
71
+ export class OwnershipModel {
72
+ guid;
73
+ connection;
74
+ get hasOwnership() {
75
+ return this._hasOwnership;
76
+ }
77
+ // TODO: server should just send id to everyone
78
+ /** @returns true of anyone has ownership */
79
+ get isOwned() {
80
+ return this._isOwned;
81
+ }
82
+ /**
83
+ * Checks if Needle Engine networking is connected to a websocket. Note that this is **not equal** to being connected to a *room*. If you want to check if Needle Engine is connected to a networking room use the `isInRoom` property.
84
+ * @returns true if connected to the websocket.
85
+ */
86
+ get isConnected() {
87
+ return this.connection.isConnected;
88
+ }
89
+ _hasOwnership = false;
90
+ _isOwned = undefined;
91
+ _gainSubscription;
92
+ _lostSubscription;
93
+ _hasOwnerResponse;
94
+ constructor(connection, guid) {
95
+ this.connection = connection;
96
+ this.guid = guid;
97
+ this._gainSubscription = this.onGainedOwnership.bind(this);
98
+ this._lostSubscription = this.onLostOwnership.bind(this);
99
+ connection.beginListen(OwnershipEvent.LostOwnership, this._lostSubscription);
100
+ connection.beginListen(OwnershipEvent.GainedOwnershipBroadcast, this._gainSubscription);
101
+ this._hasOwnerResponse = this.onHasOwnerResponse.bind(this);
102
+ connection.beginListen(OwnershipEvent.ResponseHasOwner, this._hasOwnerResponse);
103
+ }
104
+ _isWaitingForOwnershipResponseCallback = null;
105
+ updateIsOwned() {
106
+ this.connection.send(OwnershipEvent.RequestHasOwner, { guid: this.guid });
107
+ }
108
+ onHasOwnerResponse(res) {
109
+ if (res.guid === this.guid) {
110
+ this._isOwned = res.value;
111
+ }
112
+ }
113
+ requestOwnershipIfNotOwned() {
114
+ if (this._isWaitingForOwnershipResponseCallback !== null)
115
+ return this;
116
+ this._isWaitingForOwnershipResponseCallback = this.waitForHasOwnershipRequestResponse.bind(this);
117
+ this.connection.beginListen(OwnershipEvent.ResponseHasOwner, this._isWaitingForOwnershipResponseCallback);
118
+ this.connection.send(OwnershipEvent.RequestHasOwner, { guid: this.guid });
119
+ return this;
120
+ }
121
+ waitForHasOwnershipRequestResponse(res) {
122
+ // console.log(res);
123
+ if (res.guid === this.guid) {
124
+ if (this._isWaitingForOwnershipResponseCallback) {
125
+ this.connection.stopListen(OwnershipEvent.ResponseHasOwner, this._isWaitingForOwnershipResponseCallback);
126
+ this._isWaitingForOwnershipResponseCallback = null;
127
+ }
128
+ this._isOwned = res.value;
129
+ if (!res.value) {
130
+ if (debugOwner)
131
+ console.log("request ownership", this.guid);
132
+ this.requestOwnership();
133
+ }
134
+ }
135
+ }
136
+ requestOwnershipAsync() {
137
+ return new Promise((resolve, reject) => {
138
+ this.requestOwnership();
139
+ let updates = 0;
140
+ const waitForOwnership = () => {
141
+ if (updates++ > 10)
142
+ return reject("Timeout");
143
+ setTimeout(() => {
144
+ if (this.hasOwnership)
145
+ resolve(this);
146
+ else
147
+ waitForOwnership();
148
+ }, 100);
149
+ };
150
+ waitForOwnership();
151
+ });
152
+ }
153
+ requestOwnership() {
154
+ if (debugOwner)
155
+ console.log("Request ownership", this.guid);
156
+ this.connection.send(OwnershipEvent.RequestOwnership, { guid: this.guid });
157
+ return this;
158
+ }
159
+ freeOwnership() {
160
+ // TODO: abort "requestOwnershipIfNotOwned"
161
+ this.connection.send(OwnershipEvent.RemoveOwnership, { guid: this.guid });
162
+ if (this._isWaitingForOwnershipResponseCallback) {
163
+ this.connection.stopListen(OwnershipEvent.ResponseHasOwner, this._isWaitingForOwnershipResponseCallback);
164
+ this._isWaitingForOwnershipResponseCallback = null;
165
+ }
166
+ return this;
167
+ }
168
+ destroy() {
169
+ this.connection.stopListen(OwnershipEvent.GainedOwnership, this._gainSubscription);
170
+ this.connection.stopListen(OwnershipEvent.LostOwnership, this._lostSubscription);
171
+ this.connection.stopListen(OwnershipEvent.ResponseHasOwner, this._hasOwnerResponse);
172
+ if (this._isWaitingForOwnershipResponseCallback) {
173
+ this.connection.stopListen(OwnershipEvent.ResponseHasOwner, this._isWaitingForOwnershipResponseCallback);
174
+ this._isWaitingForOwnershipResponseCallback = null;
175
+ }
176
+ }
177
+ onGainedOwnership(res) {
178
+ if (res.guid === this.guid) {
179
+ this._isOwned = true;
180
+ // console.log(res.owner, connection.connectionId)
181
+ if (this.connection.connectionId === res.owner) {
182
+ if (debugOwner)
183
+ console.log("GAINED OWNERSHIP", this.guid);
184
+ this._hasOwnership = true;
185
+ }
186
+ else
187
+ this._hasOwnership = false;
188
+ }
189
+ }
190
+ onLostOwnership(guid) {
191
+ if (guid === this.guid) {
192
+ if (debugOwner)
193
+ console.log("LOST OWNERSHIP", this.guid);
194
+ this._hasOwnership = false;
195
+ this._isOwned = false;
196
+ }
197
+ }
198
+ }
199
+ /** Main class to communicate with the networking backend
200
+ * @link https://engine.needle.tools/docs/networking.html
201
+ *
202
+ */
203
+ export class NetworkConnection {
204
+ context;
205
+ _peer = null;
206
+ constructor(context) {
207
+ this.context = context;
208
+ }
209
+ /** Experimental: networking via peerjs */
210
+ get peer() {
211
+ if (!this._peer) {
212
+ this._peer = new PeerNetworking();
213
+ }
214
+ return this._peer;
215
+ }
216
+ /**
217
+ * Returns the state of a given guid.
218
+ */
219
+ tryGetState(guid) {
220
+ if (guid === "invalid")
221
+ return null;
222
+ return this._state[guid];
223
+ }
224
+ /** The connection id of the local user - it is given by the networking backend and can not be changed */
225
+ get connectionId() {
226
+ return this._connectionId;
227
+ }
228
+ /** Returns true if the networking backend is in debug mode.
229
+ * To see all networking messages in the console use `?debugnet` in the url
230
+ */
231
+ get isDebugEnabled() {
232
+ return debugNet;
233
+ }
234
+ /**
235
+ * Checks if Needle Engine networking is connected to a websocket. Note that this is **not equal** to being connected to a *room*. If you want to check if Needle Engine is connected to a networking room use the `isInRoom` property.
236
+ * @returns true if connected to the websocket.
237
+ */
238
+ get isConnected() {
239
+ return this.connected;
240
+ }
241
+ /** The name of the room the user is currently connected to */
242
+ get currentRoomName() { return this._currentRoomName; }
243
+ /** True when connected to a room via a regular url, otherwise (when using a view only url) false indicating that the user should not be able to modify the scene */
244
+ get allowEditing() { return this._currentRoomAllowEditing; }
245
+ /**
246
+ * The view id of the room the user is currently connected to.
247
+ */
248
+ get currentRoomViewId() { return this._currentRoomViewId; }
249
+ /**
250
+ * Returns a url that can be shared with others to view the current room in view only mode.
251
+ * This is useful for sharing a room with others without allowing them to modify the scene.
252
+ * Use `connection.allowEditing` to check if the current room is in view only mode.
253
+ */
254
+ getViewOnlyUrl() {
255
+ if (this.currentRoomViewId === null)
256
+ return null;
257
+ const url = new URL(window.location.href);
258
+ url.searchParams.set("view", this.currentRoomViewId);
259
+ return url.href;
260
+ }
261
+ /** True if connected to a networked room. Use the joinRoom function or a `SyncedRoom` component */
262
+ get isInRoom() {
263
+ return this._isInRoom;
264
+ }
265
+ /** Latency to currently connected backend server */
266
+ get currentLatency() {
267
+ return this._currentDelay;
268
+ }
269
+ /**
270
+ * The current server url that the networking backend is connected to (e.g. the url of the websocket server)
271
+ */
272
+ get currentServerUrl() {
273
+ // @ts-ignore (in ts-websocket 2.x this property is exposed)
274
+ return this._ws?.url ?? null;
275
+ }
276
+ /** A ping is sent to the server at a regular interval while the browser tab is active. This method can be used to send additional ping messages when needed so that the user doesn't get disconnected from the networking backend */
277
+ sendPing() {
278
+ this.send("ping", { time: this.context.time.time });
279
+ }
280
+ /** Returns true if a user with the given connectionId is in the room */
281
+ userIsInRoom(id) {
282
+ return this._currentInRoom.indexOf(id) !== -1;
283
+ }
284
+ _usersInRoomCopy = [];
285
+ /** Returns a list of all user ids in the current room */
286
+ usersInRoom(target = null) {
287
+ if (!target)
288
+ target = this._usersInRoomCopy;
289
+ target.length = 0;
290
+ for (const user of this._currentInRoom)
291
+ target.push(user);
292
+ return target;
293
+ }
294
+ /** Joins a networked room. If you don't want to manage a connection yourself you can use a `SyncedRoom` component as well */
295
+ joinRoom(room, viewOnly = false) {
296
+ if (!room) {
297
+ console.error("Missing room name, can not join: \"" + room + "\"");
298
+ return false;
299
+ }
300
+ // There's not really a reason to limit the room name length
301
+ if (room.length > 1024) {
302
+ console.error("Room name too long, can not join: \"" + room + "\". Max length is 1024 characters.");
303
+ return false;
304
+ }
305
+ else if (this.isInRoom && this.currentRoomName !== room) {
306
+ console.warn("Needle Engine is already connected to a networking room. Connecting to multiple rooms is not supported");
307
+ }
308
+ this.connect();
309
+ if (debugNet)
310
+ console.log("join: " + room);
311
+ this.send(RoomEvents.Join, { room: room, viewOnly: viewOnly }, SendQueue.OnConnection);
312
+ return true;
313
+ }
314
+ /** Use to leave a room that you are currently connected to (use `leaveRoom()` to disconnect from the currently active room but you can also specify a room name) */
315
+ leaveRoom(room = null) {
316
+ if (!room)
317
+ room = this.currentRoomName;
318
+ if (!room) {
319
+ console.error("Missing room name, can not join: \"" + room + "\"");
320
+ return false;
321
+ }
322
+ this.send(RoomEvents.Leave, { room: room });
323
+ return true;
324
+ }
325
+ /** Send a message to the networking backend - it will broadcasted to all connected users in the same room by default */
326
+ send(key, data = null, queue = SendQueue.Queued) {
327
+ //@ts-ignore
328
+ if (data === null)
329
+ data = {};
330
+ if (queue === SendQueue.Queued) {
331
+ this._defaultMessagesBuffer.push({ key: key, value: data });
332
+ return;
333
+ }
334
+ // if (!this.connected) return;
335
+ // if (this.channelId)
336
+ // data["__id"] = this.channelId;
337
+ // else if (this.connectionId)
338
+ // data["__id"] = this.connectionId;
339
+ // this.sendGeckosIo(key, data);
340
+ return this.sendWithWebsocket(key, data, queue);
341
+ }
342
+ /** Use to delete state for a given guid on the server */
343
+ sendDeleteRemoteState(guid) {
344
+ this.send("delete-state", { guid: guid, dontSave: true });
345
+ delete this._state[guid];
346
+ }
347
+ /** Use to delete all state in the currently connected room on the server */
348
+ sendDeleteRemoteStateAll() {
349
+ this.send("delete-all-state");
350
+ this._state = {};
351
+ }
352
+ /** Send a binary message to the server (broadcasted to all connected users) */
353
+ sendBinary(bin) {
354
+ if (debugnetBin)
355
+ console.log("<< send binary", this.context.time.frame, (bin.length / 1024) + " KB");
356
+ this._ws?.send(bin);
357
+ }
358
+ _defaultMessagesBuffer = [];
359
+ _defaultMessagesBufferArray = [];
360
+ sendBufferedMessagesNow() {
361
+ if (!this._ws)
362
+ return;
363
+ this._defaultMessagesBufferArray.length = 0;
364
+ const count = Object.keys(this._defaultMessagesBuffer).length;
365
+ for (const key in this._defaultMessagesBuffer) {
366
+ const data = this._defaultMessagesBuffer[key];
367
+ // if there is only one message to be sent we dont need to send an array
368
+ if (count <= 1) {
369
+ this.sendWithWebsocket(data.key, data.value, SendQueue.Immediate);
370
+ break;
371
+ }
372
+ const msg = this.toMessage(data.key, data.value);
373
+ this._defaultMessagesBufferArray.push(msg);
374
+ }
375
+ this._defaultMessagesBuffer.length = 0;
376
+ if (this._defaultMessagesBufferArray.length > 0 && debugNet)
377
+ console.log("SEND BUFFERED", this._defaultMessagesBufferArray.length);
378
+ if (this._defaultMessagesBufferArray.length <= 0)
379
+ return;
380
+ const message = JSON.stringify(this._defaultMessagesBufferArray);
381
+ this._ws?.send(message);
382
+ }
383
+ /** Use to start listening to networking events.
384
+ * To unsubscribe from events use the `stopListen` method.
385
+ * See the example below for typical usage:
386
+ *
387
+ * ### Component Example
388
+ * ```ts
389
+ * // Make sure to unsubscribe from events when the component is disabled
390
+ * export class MyComponent extends Behaviour {
391
+ * onEnable() {
392
+ * this.connection.beginListen("joined-room", this.onJoinedRoom)
393
+ * }
394
+ * onDisable() {
395
+ * this.connection.stopListen("joined-room", this.onJoinedRoom)
396
+ * }
397
+ * onJoinedRoom = () => {
398
+ * console.log("I joined a networked room")
399
+ * }
400
+ * }
401
+ * ```
402
+ * @link https://engine.needle.tools/docs/networking.html
403
+ *
404
+ */
405
+ beginListen(key, callback) {
406
+ if (!this._listeners[key])
407
+ this._listeners[key] = [];
408
+ this._listeners[key].push(callback);
409
+ return callback;
410
+ }
411
+ /**@deprecated please use stopListen instead (2.65.2-pre) */
412
+ stopListening(key, callback) { return this.stopListen(key, callback); }
413
+ /** Use to stop listening to networking events
414
+ * To subscribe to events use the `beginListen` method.
415
+ * See the example below for typical usage:
416
+ *
417
+ * ### Component Example
418
+ * ```ts
419
+ * // Make sure to unsubscribe from events when the component is disabled
420
+ * export class MyComponent extends Behaviour {
421
+ * onEnable() {
422
+ * this.connection.beginListen("joined-room", this.onJoinedRoom)
423
+ * }
424
+ * onDisable() {
425
+ * this.connection.stopListen("joined-room", this.onJoinedRoom)
426
+ * }
427
+ * onJoinedRoom = () => {
428
+ * console.log("I joined a networked room")
429
+ * }
430
+ * }
431
+ * ```
432
+ */
433
+ stopListen(key, callback) {
434
+ if (!callback)
435
+ return;
436
+ if (!this._listeners[key])
437
+ return;
438
+ const index = this._listeners[key].indexOf(callback);
439
+ if (index >= 0) {
440
+ this._listeners[key].splice(index, 1);
441
+ }
442
+ }
443
+ /** Use to start listening to networking binary events */
444
+ beginListenBinary(identifier, callback) {
445
+ if (!this._listenersBinary[identifier])
446
+ this._listenersBinary[identifier] = [];
447
+ this._listenersBinary[identifier].push(callback);
448
+ return callback;
449
+ }
450
+ /** Use to stop listening to networking binary events */
451
+ stopListenBinary(identifier, callback) {
452
+ if (!this._listenersBinary[identifier])
453
+ return;
454
+ const index = this._listenersBinary[identifier].indexOf(callback);
455
+ if (index >= 0) {
456
+ this._listenersBinary[identifier].splice(index, 1);
457
+ }
458
+ }
459
+ netWebSocketUrlProvider;
460
+ /** Use to override the networking server backend url. This is what the `Networking` component uses to modify the backend url */
461
+ registerProvider(prov) {
462
+ this.netWebSocketUrlProvider = prov;
463
+ }
464
+ /** Used to connect to the networking server */
465
+ async connect(url) {
466
+ if (this.connected && url && url !== networkingServerUrl) {
467
+ return Promise.reject("Can not connect to different server url. Please disconnect first.");
468
+ }
469
+ if (this.connected) {
470
+ return Promise.resolve(true);
471
+ }
472
+ if (url)
473
+ console.debug("Connecting to user provided url " + url);
474
+ const overrideUrl = url || this.netWebSocketUrlProvider?.getWebsocketUrl();
475
+ if (overrideUrl) {
476
+ networkingServerUrl = overrideUrl;
477
+ }
478
+ else if (isHostedOnGlitch()) {
479
+ networkingServerUrl = "wss://" + window.location.host + "/socket";
480
+ }
481
+ return this.connectWebsocket();
482
+ }
483
+ ;
484
+ /** Disconnect from the networking backend + reset internal state */
485
+ disconnect() {
486
+ this._ws?.close();
487
+ this._ws = undefined;
488
+ networkingServerUrl = undefined;
489
+ // Reset all state
490
+ this._currentRoomAllowEditing = true;
491
+ this._currentRoomName = null;
492
+ this._currentRoomViewId = null;
493
+ this._isInRoom = false;
494
+ this._currentInRoom.length = 0;
495
+ this._state = {};
496
+ this._currentDelay = -1;
497
+ }
498
+ _listeners = {};
499
+ _listenersBinary = {};
500
+ connected = false;
501
+ channelId;
502
+ _connectionId = null;
503
+ // Websocket ------------------------------------------------------------
504
+ _ws;
505
+ _waitingForSocket = {};
506
+ _isInRoom = false;
507
+ _currentRoomName = null;
508
+ _currentRoomViewId = null;
509
+ _currentRoomAllowEditing = true;
510
+ _currentInRoom = [];
511
+ _state = {};
512
+ _currentDelay = -1;
513
+ _connectingToWebsocketPromise = null;
514
+ connectWebsocket() {
515
+ if (this._connectingToWebsocketPromise)
516
+ return this._connectingToWebsocketPromise;
517
+ return this._connectingToWebsocketPromise = new Promise(async (res, _) => {
518
+ let didResolve = false;
519
+ const resolve = (val) => {
520
+ if (didResolve)
521
+ return;
522
+ didResolve = true;
523
+ res(val);
524
+ };
525
+ if (networkingServerUrl === undefined) {
526
+ console.log("Fetch default backend url: " + defaultNetworkingBackendUrlProvider);
527
+ const failed = false;
528
+ const defaultUrlResponse = await fetch(defaultNetworkingBackendUrlProvider);
529
+ networkingServerUrl = await defaultUrlResponse.text();
530
+ if (failed)
531
+ return;
532
+ }
533
+ if (networkingServerUrl === undefined) {
534
+ resolve(false);
535
+ return;
536
+ }
537
+ console.debug("⊡ Connecting to networking backend on\n" + networkingServerUrl);
538
+ const pkg = await import('websocket-ts');
539
+ // @ts-ignore
540
+ const WebsocketBuilder = pkg.default?.WebsocketBuilder ?? pkg.WebsocketBuilder;
541
+ const ExponentialBackoff = pkg.default?.ExponentialBackoff ?? pkg.ExponentialBackoff;
542
+ const ws = new WebsocketBuilder(networkingServerUrl)
543
+ .withMaxRetries(10)
544
+ .withBackoff(new ExponentialBackoff(2000, 4))
545
+ .onOpen(() => {
546
+ this._connectingToWebsocketPromise = null;
547
+ this._ws = ws;
548
+ this.connected = true;
549
+ if (isDevEnvironment() || debugNet)
550
+ console.log("⊞ Connected to networking backend\n" + networkingServerUrl);
551
+ else
552
+ console.debug("⊞ Connected to networking backend", networkingServerUrl);
553
+ resolve(true);
554
+ this.onSendQueued(SendQueue.OnConnection);
555
+ })
556
+ .onClose((_evt) => {
557
+ this._connectingToWebsocketPromise = null;
558
+ this.connected = false;
559
+ this._isInRoom = false;
560
+ resolve(false);
561
+ let msg = "Websocket connection closed...";
562
+ if (!networkingServerUrl?.includes("/socket"))
563
+ msg += ` Do you perhaps mean to connect to \"/socket\"?`;
564
+ console.error(msg);
565
+ })
566
+ .onError((_e) => {
567
+ console.error("⊠ Websocket connection failed...");
568
+ resolve(false);
569
+ })
570
+ .onRetry(() => { console.log("→ Retry connecting to networking websocket"); })
571
+ .build();
572
+ ws.addEventListener(pkg.WebsocketEvent.message, (socket, msg) => {
573
+ this.onMessage(socket, msg);
574
+ });
575
+ });
576
+ }
577
+ onMessage(_, ev) {
578
+ const msg = ev.data;
579
+ try {
580
+ if (typeof msg !== "string") {
581
+ if (msg.size) {
582
+ // is binary blob
583
+ this.handleIncomingBinaryMessage(msg);
584
+ }
585
+ return;
586
+ }
587
+ const message = JSON.parse(msg);
588
+ if (Array.isArray(message)) {
589
+ // console.log("Receive package of " + message.length + " messages")
590
+ for (const msg of message) {
591
+ this.handleIncomingStringMessage(msg);
592
+ }
593
+ }
594
+ else
595
+ this.handleIncomingStringMessage(message);
596
+ return;
597
+ }
598
+ catch (err) {
599
+ if (debugNet && msg === "pong")
600
+ console.log("<<", msg);
601
+ else if (isDevEnvironment())
602
+ console.error("Failed to parse message", err);
603
+ }
604
+ }
605
+ async handleIncomingBinaryMessage(blob) {
606
+ if (debugnetBin)
607
+ console.log("<< bin", this.context.time.frame);
608
+ const buf = await blob.arrayBuffer();
609
+ var data = new Uint8Array(buf);
610
+ const bb = new flatbuffers.ByteBuffer(data);
611
+ const id = bb.getBufferIdentifier();
612
+ const callbacks = this._listenersBinary[id];
613
+ // use registered cast methods to get the correct type from the flatbuffer
614
+ const obj = schemes.tryCastBinary(bb);
615
+ const guid = schemes.tryGetGuid(obj);
616
+ if (guid && typeof guid === "string") {
617
+ this._state[guid] = obj;
618
+ }
619
+ if (!callbacks)
620
+ return;
621
+ const res = obj ?? bb; // fallback to bytebuffer if no cast method is registered
622
+ // call all listeners subscribed to these events
623
+ for (const cb of callbacks) {
624
+ cb(res);
625
+ }
626
+ }
627
+ handleIncomingStringMessage(message) {
628
+ if (debugNet)
629
+ console.log("<<", message.key ?? message);
630
+ if (message.key) {
631
+ switch (message.key) {
632
+ case ConnectionEvents.ConnectionInfo:
633
+ if (message.data) {
634
+ const connection = message.data;
635
+ if (connection) {
636
+ console.assert(connection.id !== undefined && connection.id !== null && connection.id.length > 0, "server did not send connection id", connection.id);
637
+ console.debug("Your id is: " + connection.id, this.context.alias ?? "");
638
+ this._connectionId = connection.id;
639
+ }
640
+ }
641
+ else
642
+ console.warn("Expected connection id in " + message.key);
643
+ break;
644
+ case RoomEvents.JoinedRoom:
645
+ if (debugNet)
646
+ console.log(message);
647
+ if (message) {
648
+ this._isInRoom = true;
649
+ const model = message;
650
+ this._currentRoomName = model.room;
651
+ this._currentRoomViewId = model.viewId;
652
+ this._currentRoomAllowEditing = model.allowEditing ?? true;
653
+ this._currentInRoom.length = 0;
654
+ this._currentInRoom.push(...model.inRoom);
655
+ if (debugnetBin || isDevEnvironment())
656
+ console.debug("Joined Needle Engine Room: " + model.room);
657
+ const viewUrl = new URL(window.location.href);
658
+ if (viewUrl.searchParams.has("room")) {
659
+ viewUrl.searchParams.delete("room");
660
+ }
661
+ viewUrl.searchParams.set("view", this._currentRoomViewId);
662
+ console.debug(`Room view id: ${this._currentRoomViewId}\n${viewUrl.href}`);
663
+ }
664
+ this.onSendQueued(SendQueue.OnRoomJoin);
665
+ break;
666
+ case RoomEvents.LeftRoom:
667
+ const model = message;
668
+ if (model.room === this.currentRoomName) {
669
+ this._isInRoom = false;
670
+ this._currentRoomName = null;
671
+ this._currentRoomAllowEditing = true;
672
+ this._currentInRoom.length = 0;
673
+ if (debugnetBin || isDevEnvironment())
674
+ console.debug("Left Needle Engine Room: " + model.room);
675
+ }
676
+ break;
677
+ case RoomEvents.UserJoinedRoom:
678
+ if (message.data) {
679
+ const model = message.data;
680
+ this._currentInRoom.push(model.userId);
681
+ if (debugNet)
682
+ console.log(model.userId + " joined", "now in room:", this._currentInRoom);
683
+ }
684
+ break;
685
+ case RoomEvents.UserLeftRoom:
686
+ if (message.data) {
687
+ const model = message.data;
688
+ const index = this._currentInRoom.indexOf(model.userId);
689
+ if (index >= 0) {
690
+ if (debugNet)
691
+ console.log(model.userId + " left", "now in room:", this._currentInRoom);
692
+ this._currentInRoom.splice(index, 1);
693
+ }
694
+ if (model.userId === this.connectionId) {
695
+ // you left the room
696
+ console.log("you left the room");
697
+ }
698
+ }
699
+ break;
700
+ case "all-room-state-deleted":
701
+ if (debugNet)
702
+ console.log("RECEIVED all-room-state-deleted");
703
+ this._state = {};
704
+ break;
705
+ case "ping":
706
+ case "pong":
707
+ const time = message.data?.time;
708
+ if (time) {
709
+ this._currentDelay = this.context.time.time - time;
710
+ }
711
+ if (debugNet)
712
+ console.log(`Current latency: ${(this._currentDelay * 1000).toFixed()} ms`, "Clients in room: " + this._currentInRoom?.length);
713
+ break;
714
+ }
715
+ }
716
+ const model = message.data;
717
+ if (model) {
718
+ this._state[model.guid] = model;
719
+ }
720
+ let listeners = this._listeners[message.key];
721
+ if (listeners) {
722
+ // Copy listeners array in case a listener is removed while iterating
723
+ listeners = [...listeners];
724
+ for (const listener of listeners) {
725
+ try {
726
+ listener(message.data);
727
+ }
728
+ catch (err) {
729
+ console.error("Error invoking callback for \"" + message.key + "\"", err);
730
+ }
731
+ }
732
+ }
733
+ }
734
+ toMessage(key, data) {
735
+ return {
736
+ key: key,
737
+ data: data
738
+ };
739
+ }
740
+ sendWithWebsocket(key, data, queue = SendQueue.OnRoomJoin) {
741
+ // console.log(key);
742
+ if (!this._ws) {
743
+ const arr = this._waitingForSocket[queue] || [];
744
+ arr.push(() => this.sendWithWebsocket(key, data, queue));
745
+ this._waitingForSocket[queue] = arr;
746
+ // console.log(this._bufferedMessages)
747
+ return;
748
+ }
749
+ const str = JSON.stringify(this.toMessage(key, data));
750
+ if (debugNet)
751
+ console.log(">>", key);
752
+ this._ws.send(str);
753
+ }
754
+ onSendQueued(queue) {
755
+ const queued = this._waitingForSocket[queue];
756
+ // console.log("send", queue, queued);
757
+ if (queued) {
758
+ for (const callback of queued) {
759
+ callback();
760
+ }
761
+ queued.length = 0;
762
+ }
763
+ }
764
+ }
765
765
  //# sourceMappingURL=engine_networking.js.map