@needle-tools/engine 4.5.5-next.f053174 → 4.5.6

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 (1044) hide show
  1. package/CHANGELOG.md +3740 -3740
  2. package/LICENSE.md +10 -10
  3. package/README.md +64 -64
  4. package/components.needle.json +1 -1
  5. package/dist/{needle-engine.bundle-DFfLpZpn.min.js → needle-engine.bundle-2nTaeeW3.min.js} +62 -62
  6. package/dist/{needle-engine.bundle-Dx2hV9Bu.umd.cjs → needle-engine.bundle-B3qVc_uH.umd.cjs} +54 -54
  7. package/dist/{needle-engine.bundle-DvRTYg0j.js → needle-engine.bundle-B9tUMvDR.js} +623 -623
  8. package/dist/{needle-engine.bundle-BxW8rOic.light.min.js → needle-engine.bundle-BWeBylyu.light.min.js} +62 -62
  9. package/dist/{needle-engine.bundle-5YrltOTW.light.umd.cjs → needle-engine.bundle-Bx32FU5Z.light.umd.cjs} +54 -54
  10. package/dist/{needle-engine.bundle-Bjtl-M4D.light.js → needle-engine.bundle-CAuuubKQ.light.js} +623 -623
  11. package/dist/needle-engine.d.ts +129 -130
  12. package/dist/needle-engine.js +2 -2
  13. package/dist/needle-engine.light.d.ts +129 -130
  14. package/dist/needle-engine.light.js +2 -2
  15. package/dist/needle-engine.light.min.js +1 -1
  16. package/dist/needle-engine.light.umd.cjs +1 -1
  17. package/dist/needle-engine.min.js +1 -1
  18. package/dist/needle-engine.umd.cjs +1 -1
  19. package/lib/asap/needle-asap.d.ts +1 -1
  20. package/lib/asap/needle-asap.js +95 -95
  21. package/lib/asap/sessiongranted.d.ts +3 -3
  22. package/lib/asap/sessiongranted.js +65 -65
  23. package/lib/asap/utils.d.ts +1 -1
  24. package/lib/asap/utils.js +3 -3
  25. package/lib/engine/analytics/index.d.ts +6 -6
  26. package/lib/engine/analytics/index.js +12 -12
  27. package/lib/engine/analytics/lcp.d.ts +3 -3
  28. package/lib/engine/analytics/lcp.js +34 -34
  29. package/lib/engine/api.d.ts +82 -82
  30. package/lib/engine/api.js +81 -81
  31. package/lib/engine/assets/index.d.ts +11 -11
  32. package/lib/engine/assets/index.js +47 -47
  33. package/lib/engine/assets/static.d.ts +1 -1
  34. package/lib/engine/assets/static.js +4 -4
  35. package/lib/engine/codegen/register_types.d.ts +1 -1
  36. package/lib/engine/codegen/register_types.js +300 -300
  37. package/lib/engine/debug/debug.d.ts +15 -15
  38. package/lib/engine/debug/debug.js +44 -44
  39. package/lib/engine/debug/debug_console.d.ts +2 -2
  40. package/lib/engine/debug/debug_console.js +307 -307
  41. package/lib/engine/debug/debug_overlay.d.ts +22 -22
  42. package/lib/engine/debug/debug_overlay.js +316 -316
  43. package/lib/engine/debug/debug_spatial_console.d.ts +2 -2
  44. package/lib/engine/debug/debug_spatial_console.js +390 -390
  45. package/lib/engine/debug/index.d.ts +2 -2
  46. package/lib/engine/debug/index.js +2 -2
  47. package/lib/engine/engine_addressables.d.ts +166 -166
  48. package/lib/engine/engine_addressables.js +608 -608
  49. package/lib/engine/engine_animation.d.ts +43 -43
  50. package/lib/engine/engine_animation.js +133 -133
  51. package/lib/engine/engine_application.d.ts +45 -45
  52. package/lib/engine/engine_application.js +104 -104
  53. package/lib/engine/engine_assetdatabase.d.ts +25 -25
  54. package/lib/engine/engine_assetdatabase.js +344 -344
  55. package/lib/engine/engine_audio.d.ts +4 -4
  56. package/lib/engine/engine_audio.js +23 -23
  57. package/lib/engine/engine_camera.d.ts +13 -13
  58. package/lib/engine/engine_camera.js +30 -30
  59. package/lib/engine/engine_components.d.ts +110 -110
  60. package/lib/engine/engine_components.js +374 -374
  61. package/lib/engine/engine_components_internal.d.ts +9 -9
  62. package/lib/engine/engine_components_internal.js +36 -36
  63. package/lib/engine/engine_constants.d.ts +10 -10
  64. package/lib/engine/engine_constants.js +41 -41
  65. package/lib/engine/engine_context.d.ts +472 -472
  66. package/lib/engine/engine_context.js +1664 -1664
  67. package/lib/engine/engine_context_registry.d.ts +71 -71
  68. package/lib/engine/engine_context_registry.js +117 -117
  69. package/lib/engine/engine_coroutine.d.ts +35 -35
  70. package/lib/engine/engine_coroutine.js +52 -52
  71. package/lib/engine/engine_create_objects.d.ts +119 -119
  72. package/lib/engine/engine_create_objects.js +320 -320
  73. package/lib/engine/engine_default_parameters.d.ts +2 -2
  74. package/lib/engine/engine_default_parameters.js +3 -3
  75. package/lib/engine/engine_editor-sync.d.ts +21 -21
  76. package/lib/engine/engine_editor-sync.js +4 -4
  77. package/lib/engine/engine_fileloader.d.ts +2 -2
  78. package/lib/engine/engine_fileloader.js +8 -8
  79. package/lib/engine/engine_gameobject.d.ts +68 -68
  80. package/lib/engine/engine_gameobject.js +616 -616
  81. package/lib/engine/engine_generic_utils.d.ts +1 -1
  82. package/lib/engine/engine_generic_utils.js +13 -13
  83. package/lib/engine/engine_gizmos.d.ts +149 -149
  84. package/lib/engine/engine_gizmos.js +530 -530
  85. package/lib/engine/engine_gltf.d.ts +12 -12
  86. package/lib/engine/engine_gltf.js +15 -15
  87. package/lib/engine/engine_gltf_builtin_components.d.ts +11 -11
  88. package/lib/engine/engine_gltf_builtin_components.js +341 -341
  89. package/lib/engine/engine_hot_reload.d.ts +8 -8
  90. package/lib/engine/engine_hot_reload.js +197 -197
  91. package/lib/engine/engine_input.d.ts +362 -362
  92. package/lib/engine/engine_input.js +1294 -1294
  93. package/lib/engine/engine_input_utils.d.ts +2 -2
  94. package/lib/engine/engine_input_utils.js +22 -22
  95. package/lib/engine/engine_instancing.d.ts +19 -19
  96. package/lib/engine/engine_instancing.js +39 -39
  97. package/lib/engine/engine_license.d.ts +11 -11
  98. package/lib/engine/engine_license.js +369 -369
  99. package/lib/engine/engine_lifecycle_api.d.ts +83 -83
  100. package/lib/engine/engine_lifecycle_api.js +106 -106
  101. package/lib/engine/engine_lifecycle_functions_internal.d.ts +32 -32
  102. package/lib/engine/engine_lifecycle_functions_internal.js +146 -146
  103. package/lib/engine/engine_lightdata.d.ts +23 -23
  104. package/lib/engine/engine_lightdata.js +91 -91
  105. package/lib/engine/engine_loaders.callbacks.d.ts +97 -97
  106. package/lib/engine/engine_loaders.callbacks.js +86 -86
  107. package/lib/engine/engine_loaders.d.ts +48 -48
  108. package/lib/engine/engine_loaders.gltf.d.ts +13 -13
  109. package/lib/engine/engine_loaders.gltf.js +62 -62
  110. package/lib/engine/engine_loaders.js +337 -337
  111. package/lib/engine/engine_lods.d.ts +31 -31
  112. package/lib/engine/engine_lods.js +146 -146
  113. package/lib/engine/engine_mainloop_utils.d.ts +32 -32
  114. package/lib/engine/engine_mainloop_utils.js +466 -466
  115. package/lib/engine/engine_math.d.ts +114 -114
  116. package/lib/engine/engine_math.js +247 -247
  117. package/lib/engine/engine_modules.d.ts +36 -36
  118. package/lib/engine/engine_modules.js +85 -85
  119. package/lib/engine/engine_networking.d.ts +260 -260
  120. package/lib/engine/engine_networking.js +764 -764
  121. package/lib/engine/engine_networking_auto.d.ts +24 -24
  122. package/lib/engine/engine_networking_auto.js +310 -310
  123. package/lib/engine/engine_networking_blob.d.ts +48 -48
  124. package/lib/engine/engine_networking_blob.js +228 -228
  125. package/lib/engine/engine_networking_files.d.ts +35 -35
  126. package/lib/engine/engine_networking_files.js +172 -172
  127. package/lib/engine/engine_networking_files_default_components.d.ts +6 -6
  128. package/lib/engine/engine_networking_files_default_components.js +42 -42
  129. package/lib/engine/engine_networking_instantiate.d.ts +100 -100
  130. package/lib/engine/engine_networking_instantiate.js +345 -345
  131. package/lib/engine/engine_networking_peer.d.ts +15 -15
  132. package/lib/engine/engine_networking_peer.js +132 -132
  133. package/lib/engine/engine_networking_streams.d.ts +123 -123
  134. package/lib/engine/engine_networking_streams.js +645 -645
  135. package/lib/engine/engine_networking_types.d.ts +22 -22
  136. package/lib/engine/engine_networking_types.js +7 -7
  137. package/lib/engine/engine_networking_utils.d.ts +2 -2
  138. package/lib/engine/engine_networking_utils.js +20 -20
  139. package/lib/engine/engine_networking_websocket.d.ts +1 -1
  140. package/lib/engine/engine_networking_websocket.js +2 -2
  141. package/lib/engine/engine_patcher.d.ts +10 -10
  142. package/lib/engine/engine_patcher.js +142 -142
  143. package/lib/engine/engine_physics.d.ts +152 -152
  144. package/lib/engine/engine_physics.js +645 -645
  145. package/lib/engine/engine_physics.types.d.ts +40 -40
  146. package/lib/engine/engine_physics.types.js +33 -33
  147. package/lib/engine/engine_physics_rapier.d.ts +147 -147
  148. package/lib/engine/engine_physics_rapier.js +1433 -1433
  149. package/lib/engine/engine_playerview.d.ts +26 -26
  150. package/lib/engine/engine_playerview.js +64 -64
  151. package/lib/engine/engine_scenelighting.d.ts +71 -71
  152. package/lib/engine/engine_scenelighting.js +226 -226
  153. package/lib/engine/engine_serialization.d.ts +3 -3
  154. package/lib/engine/engine_serialization.js +3 -3
  155. package/lib/engine/engine_serialization_builtin_serializer.d.ts +72 -72
  156. package/lib/engine/engine_serialization_builtin_serializer.js +403 -403
  157. package/lib/engine/engine_serialization_core.d.ts +94 -94
  158. package/lib/engine/engine_serialization_core.js +607 -607
  159. package/lib/engine/engine_serialization_decorator.d.ts +23 -23
  160. package/lib/engine/engine_serialization_decorator.js +66 -66
  161. package/lib/engine/engine_setup.d.ts +1 -1
  162. package/lib/engine/engine_setup.js +2 -2
  163. package/lib/engine/engine_shaders.d.ts +53 -53
  164. package/lib/engine/engine_shaders.js +252 -252
  165. package/lib/engine/engine_shims.d.ts +4 -4
  166. package/lib/engine/engine_shims.js +24 -24
  167. package/lib/engine/engine_test_utils.d.ts +39 -39
  168. package/lib/engine/engine_test_utils.js +83 -83
  169. package/lib/engine/engine_texture.d.ts +28 -28
  170. package/lib/engine/engine_texture.js +64 -64
  171. package/lib/engine/engine_three_utils.d.ts +201 -201
  172. package/lib/engine/engine_three_utils.js +731 -731
  173. package/lib/engine/engine_time.d.ts +51 -51
  174. package/lib/engine/engine_time.js +82 -82
  175. package/lib/engine/engine_time_utils.d.ts +88 -88
  176. package/lib/engine/engine_time_utils.js +215 -215
  177. package/lib/engine/engine_tonemapping.d.ts +2 -2
  178. package/lib/engine/engine_tonemapping.js +194 -194
  179. package/lib/engine/engine_types.d.ts +578 -578
  180. package/lib/engine/engine_types.js +95 -95
  181. package/lib/engine/engine_typestore.d.ts +28 -28
  182. package/lib/engine/engine_typestore.js +55 -55
  183. package/lib/engine/engine_util_decorator.d.ts +13 -13
  184. package/lib/engine/engine_util_decorator.js +116 -116
  185. package/lib/engine/engine_utils.d.ts +248 -248
  186. package/lib/engine/engine_utils.js +993 -993
  187. package/lib/engine/engine_utils_format.d.ts +24 -24
  188. package/lib/engine/engine_utils_format.js +239 -239
  189. package/lib/engine/engine_utils_screenshot.d.ts +159 -159
  190. package/lib/engine/engine_utils_screenshot.js +513 -513
  191. package/lib/engine/engine_utils_screenshot.xr.d.ts +5 -5
  192. package/lib/engine/engine_utils_screenshot.xr.js +90 -90
  193. package/lib/engine/engine_xr.d.ts +1 -1
  194. package/lib/engine/engine_xr.js +1 -1
  195. package/lib/engine/export/gltf/Writers.d.ts +19 -19
  196. package/lib/engine/export/gltf/Writers.js +24 -24
  197. package/lib/engine/export/gltf/index.d.ts +11 -11
  198. package/lib/engine/export/gltf/index.js +123 -123
  199. package/lib/engine/export/index.d.ts +2 -2
  200. package/lib/engine/export/index.js +2 -2
  201. package/lib/engine/export/state.d.ts +7 -7
  202. package/lib/engine/export/state.js +17 -17
  203. package/lib/engine/export/utils.d.ts +2 -2
  204. package/lib/engine/export/utils.js +7 -7
  205. package/lib/engine/extensions/EXT_texture_exr.d.ts +8 -8
  206. package/lib/engine/extensions/EXT_texture_exr.js +32 -32
  207. package/lib/engine/extensions/NEEDLE_animator_controller_model.d.ts +122 -122
  208. package/lib/engine/extensions/NEEDLE_animator_controller_model.js +95 -95
  209. package/lib/engine/extensions/NEEDLE_components.d.ts +35 -35
  210. package/lib/engine/extensions/NEEDLE_components.js +220 -220
  211. package/lib/engine/extensions/NEEDLE_gameobject_data.d.ts +10 -10
  212. package/lib/engine/extensions/NEEDLE_gameobject_data.js +57 -57
  213. package/lib/engine/extensions/NEEDLE_lighting_settings.d.ts +37 -37
  214. package/lib/engine/extensions/NEEDLE_lighting_settings.js +157 -157
  215. package/lib/engine/extensions/NEEDLE_lightmaps.d.ts +18 -18
  216. package/lib/engine/extensions/NEEDLE_lightmaps.js +99 -99
  217. package/lib/engine/extensions/NEEDLE_persistent_assets.d.ts +11 -11
  218. package/lib/engine/extensions/NEEDLE_persistent_assets.js +63 -63
  219. package/lib/engine/extensions/NEEDLE_progressive.d.ts +1 -1
  220. package/lib/engine/extensions/NEEDLE_progressive.js +1 -1
  221. package/lib/engine/extensions/NEEDLE_render_objects.d.ts +13 -13
  222. package/lib/engine/extensions/NEEDLE_render_objects.js +159 -159
  223. package/lib/engine/extensions/NEEDLE_techniques_webgl.d.ts +38 -38
  224. package/lib/engine/extensions/NEEDLE_techniques_webgl.js +564 -564
  225. package/lib/engine/extensions/extension_resolver.d.ts +4 -4
  226. package/lib/engine/extensions/extension_resolver.js +1 -1
  227. package/lib/engine/extensions/extension_utils.d.ts +12 -12
  228. package/lib/engine/extensions/extension_utils.js +152 -152
  229. package/lib/engine/extensions/extensions.d.ts +32 -32
  230. package/lib/engine/extensions/extensions.js +107 -107
  231. package/lib/engine/extensions/index.d.ts +6 -6
  232. package/lib/engine/extensions/index.js +6 -6
  233. package/lib/engine/extensions/usage_tracker.d.ts +13 -13
  234. package/lib/engine/extensions/usage_tracker.js +65 -65
  235. package/lib/engine/js-extensions/Camera.d.ts +1 -1
  236. package/lib/engine/js-extensions/Camera.js +39 -39
  237. package/lib/engine/js-extensions/ExtensionUtils.d.ts +9 -9
  238. package/lib/engine/js-extensions/ExtensionUtils.js +67 -67
  239. package/lib/engine/js-extensions/Layers.d.ts +6 -6
  240. package/lib/engine/js-extensions/Layers.js +22 -22
  241. package/lib/engine/js-extensions/Object3D.d.ts +120 -120
  242. package/lib/engine/js-extensions/Object3D.js +136 -136
  243. package/lib/engine/js-extensions/RGBAColor.d.ts +23 -23
  244. package/lib/engine/js-extensions/RGBAColor.js +111 -111
  245. package/lib/engine/js-extensions/Vector.d.ts +3 -3
  246. package/lib/engine/js-extensions/Vector.js +13 -13
  247. package/lib/engine/js-extensions/index.d.ts +5 -5
  248. package/lib/engine/js-extensions/index.js +5 -5
  249. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.d.ts +4 -4
  250. package/lib/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +79 -79
  251. package/lib/engine/shaders/shaderData.d.ts +55 -55
  252. package/lib/engine/shaders/shaderData.js +58 -58
  253. package/lib/engine/tests/test_utils.d.ts +2 -2
  254. package/lib/engine/tests/test_utils.js +53 -53
  255. package/lib/engine/webcomponents/WebXRButtons.d.ts +56 -56
  256. package/lib/engine/webcomponents/WebXRButtons.js +230 -230
  257. package/lib/engine/webcomponents/api.d.ts +5 -5
  258. package/lib/engine/webcomponents/api.js +4 -4
  259. package/lib/engine/webcomponents/buttons.d.ts +51 -51
  260. package/lib/engine/webcomponents/buttons.js +264 -264
  261. package/lib/engine/webcomponents/fonts.d.ts +9 -9
  262. package/lib/engine/webcomponents/fonts.js +32 -32
  263. package/lib/engine/webcomponents/icons.d.ts +9 -9
  264. package/lib/engine/webcomponents/icons.js +52 -52
  265. package/lib/engine/webcomponents/index.d.ts +1 -1
  266. package/lib/engine/webcomponents/index.js +1 -1
  267. package/lib/engine/webcomponents/logo-element.d.ts +10 -10
  268. package/lib/engine/webcomponents/logo-element.js +67 -67
  269. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.d.ts +37 -37
  270. package/lib/engine/webcomponents/needle menu/needle-menu-spatial.js +513 -513
  271. package/lib/engine/webcomponents/needle menu/needle-menu.d.ts +155 -155
  272. package/lib/engine/webcomponents/needle menu/needle-menu.js +1029 -1029
  273. package/lib/engine/webcomponents/needle-button.d.ts +34 -34
  274. package/lib/engine/webcomponents/needle-button.js +161 -161
  275. package/lib/engine/webcomponents/needle-engine.ar-overlay.d.ts +21 -21
  276. package/lib/engine/webcomponents/needle-engine.ar-overlay.js +166 -166
  277. package/lib/engine/webcomponents/needle-engine.attributes.d.ts +69 -69
  278. package/lib/engine/webcomponents/needle-engine.attributes.js +1 -1
  279. package/lib/engine/webcomponents/needle-engine.d.ts +113 -113
  280. package/lib/engine/webcomponents/needle-engine.extras.d.ts +6 -6
  281. package/lib/engine/webcomponents/needle-engine.extras.js +13 -13
  282. package/lib/engine/webcomponents/needle-engine.js +831 -831
  283. package/lib/engine/webcomponents/needle-engine.loading.d.ts +44 -44
  284. package/lib/engine/webcomponents/needle-engine.loading.js +341 -341
  285. package/lib/engine/xr/NeedleXRController.d.ts +313 -313
  286. package/lib/engine/xr/NeedleXRController.js +1007 -1007
  287. package/lib/engine/xr/NeedleXRSession.d.ts +340 -340
  288. package/lib/engine/xr/NeedleXRSession.js +1463 -1463
  289. package/lib/engine/xr/NeedleXRSync.d.ts +22 -22
  290. package/lib/engine/xr/NeedleXRSync.js +188 -188
  291. package/lib/engine/xr/SceneTransition.d.ts +18 -18
  292. package/lib/engine/xr/SceneTransition.js +69 -69
  293. package/lib/engine/xr/TempXRContext.d.ts +34 -34
  294. package/lib/engine/xr/TempXRContext.js +187 -187
  295. package/lib/engine/xr/XRRig.d.ts +7 -7
  296. package/lib/engine/xr/XRRig.js +1 -1
  297. package/lib/engine/xr/api.d.ts +6 -6
  298. package/lib/engine/xr/api.js +6 -6
  299. package/lib/engine/xr/events.d.ts +66 -66
  300. package/lib/engine/xr/events.js +93 -93
  301. package/lib/engine/xr/internal.d.ts +12 -12
  302. package/lib/engine/xr/internal.js +25 -25
  303. package/lib/engine/xr/usdz.d.ts +12 -12
  304. package/lib/engine/xr/usdz.js +29 -29
  305. package/lib/engine/xr/utils.d.ts +11 -11
  306. package/lib/engine/xr/utils.js +34 -34
  307. package/lib/engine-components/AlignmentConstraint.d.ts +10 -10
  308. package/lib/engine-components/AlignmentConstraint.js +39 -39
  309. package/lib/engine-components/Animation.d.ts +156 -156
  310. package/lib/engine-components/Animation.js +508 -508
  311. package/lib/engine-components/AnimationCurve.d.ts +40 -40
  312. package/lib/engine-components/AnimationCurve.js +159 -159
  313. package/lib/engine-components/AnimationUtils.d.ts +8 -8
  314. package/lib/engine-components/AnimationUtils.js +27 -27
  315. package/lib/engine-components/AnimationUtilsAutoplay.d.ts +1 -1
  316. package/lib/engine-components/AnimationUtilsAutoplay.js +39 -39
  317. package/lib/engine-components/Animator.d.ts +217 -217
  318. package/lib/engine-components/Animator.js +354 -354
  319. package/lib/engine-components/AnimatorController.d.ts +227 -227
  320. package/lib/engine-components/AnimatorController.js +1152 -1152
  321. package/lib/engine-components/AudioListener.d.ts +33 -33
  322. package/lib/engine-components/AudioListener.js +86 -86
  323. package/lib/engine-components/AudioSource.d.ts +217 -217
  324. package/lib/engine-components/AudioSource.js +634 -634
  325. package/lib/engine-components/AvatarLoader.d.ts +80 -80
  326. package/lib/engine-components/AvatarLoader.js +231 -231
  327. package/lib/engine-components/AxesHelper.d.ts +32 -32
  328. package/lib/engine-components/AxesHelper.js +67 -67
  329. package/lib/engine-components/BasicIKConstraint.d.ts +9 -9
  330. package/lib/engine-components/BasicIKConstraint.js +43 -43
  331. package/lib/engine-components/BoxCollider.d.ts +2 -2
  332. package/lib/engine-components/BoxCollider.js +2 -2
  333. package/lib/engine-components/BoxHelperComponent.d.ts +47 -47
  334. package/lib/engine-components/BoxHelperComponent.js +102 -102
  335. package/lib/engine-components/Camera.d.ts +231 -231
  336. package/lib/engine-components/Camera.js +700 -700
  337. package/lib/engine-components/CameraUtils.d.ts +1 -1
  338. package/lib/engine-components/CameraUtils.js +121 -121
  339. package/lib/engine-components/CharacterController.d.ts +55 -55
  340. package/lib/engine-components/CharacterController.js +236 -236
  341. package/lib/engine-components/Collider.d.ts +188 -188
  342. package/lib/engine-components/Collider.js +369 -369
  343. package/lib/engine-components/Component.d.ts +792 -792
  344. package/lib/engine-components/Component.js +920 -920
  345. package/lib/engine-components/ContactShadows.d.ts +94 -94
  346. package/lib/engine-components/ContactShadows.js +453 -453
  347. package/lib/engine-components/DeleteBox.d.ts +19 -19
  348. package/lib/engine-components/DeleteBox.js +58 -58
  349. package/lib/engine-components/DeviceFlag.d.ts +16 -16
  350. package/lib/engine-components/DeviceFlag.js +47 -47
  351. package/lib/engine-components/DragControls.d.ts +170 -170
  352. package/lib/engine-components/DragControls.js +1421 -1421
  353. package/lib/engine-components/DropListener.d.ts +215 -215
  354. package/lib/engine-components/DropListener.js +642 -642
  355. package/lib/engine-components/Duplicatable.d.ts +35 -35
  356. package/lib/engine-components/Duplicatable.js +202 -202
  357. package/lib/engine-components/EventList.d.ts +54 -54
  358. package/lib/engine-components/EventList.js +232 -232
  359. package/lib/engine-components/EventTrigger.d.ts +33 -33
  360. package/lib/engine-components/EventTrigger.js +75 -75
  361. package/lib/engine-components/EventType.d.ts +22 -22
  362. package/lib/engine-components/EventType.js +23 -23
  363. package/lib/engine-components/Fog.d.ts +22 -22
  364. package/lib/engine-components/Fog.js +61 -61
  365. package/lib/engine-components/Gizmos.d.ts +17 -17
  366. package/lib/engine-components/Gizmos.js +64 -64
  367. package/lib/engine-components/GridHelper.d.ts +20 -20
  368. package/lib/engine-components/GridHelper.js +54 -54
  369. package/lib/engine-components/GroundProjection.d.ts +67 -67
  370. package/lib/engine-components/GroundProjection.js +343 -343
  371. package/lib/engine-components/Interactable.d.ts +12 -12
  372. package/lib/engine-components/Interactable.js +12 -12
  373. package/lib/engine-components/Joints.d.ts +19 -19
  374. package/lib/engine-components/Joints.js +51 -51
  375. package/lib/engine-components/LODGroup.d.ts +35 -35
  376. package/lib/engine-components/LODGroup.js +152 -152
  377. package/lib/engine-components/Light.d.ts +180 -180
  378. package/lib/engine-components/Light.js +535 -535
  379. package/lib/engine-components/LookAtConstraint.d.ts +19 -19
  380. package/lib/engine-components/LookAtConstraint.js +35 -35
  381. package/lib/engine-components/NeedleMenu.d.ts +50 -50
  382. package/lib/engine-components/NeedleMenu.js +92 -92
  383. package/lib/engine-components/NestedGltf.d.ts +25 -25
  384. package/lib/engine-components/NestedGltf.js +88 -88
  385. package/lib/engine-components/Networking.d.ts +54 -54
  386. package/lib/engine-components/Networking.js +112 -112
  387. package/lib/engine-components/OffsetConstraint.d.ts +14 -14
  388. package/lib/engine-components/OffsetConstraint.js +65 -65
  389. package/lib/engine-components/OrbitControls.d.ts +268 -268
  390. package/lib/engine-components/OrbitControls.js +1015 -1015
  391. package/lib/engine-components/PlayerColor.d.ts +19 -19
  392. package/lib/engine-components/PlayerColor.js +94 -94
  393. package/lib/engine-components/ReflectionProbe.d.ts +27 -27
  394. package/lib/engine-components/ReflectionProbe.js +201 -201
  395. package/lib/engine-components/Renderer.d.ts +153 -153
  396. package/lib/engine-components/Renderer.js +830 -830
  397. package/lib/engine-components/RendererInstancing.d.ts +140 -140
  398. package/lib/engine-components/RendererInstancing.js +744 -744
  399. package/lib/engine-components/RendererLightmap.d.ts +24 -24
  400. package/lib/engine-components/RendererLightmap.js +182 -182
  401. package/lib/engine-components/RigidBody.d.ts +155 -155
  402. package/lib/engine-components/RigidBody.js +517 -517
  403. package/lib/engine-components/SceneSwitcher.d.ts +263 -263
  404. package/lib/engine-components/SceneSwitcher.js +971 -971
  405. package/lib/engine-components/ScreenCapture.d.ts +144 -144
  406. package/lib/engine-components/ScreenCapture.js +547 -547
  407. package/lib/engine-components/ShadowCatcher.d.ts +33 -33
  408. package/lib/engine-components/ShadowCatcher.js +166 -166
  409. package/lib/engine-components/Skybox.d.ts +82 -82
  410. package/lib/engine-components/Skybox.js +448 -448
  411. package/lib/engine-components/SmoothFollow.d.ts +34 -34
  412. package/lib/engine-components/SmoothFollow.js +82 -82
  413. package/lib/engine-components/SpatialTrigger.d.ts +102 -102
  414. package/lib/engine-components/SpatialTrigger.js +225 -225
  415. package/lib/engine-components/SpectatorCamera.d.ts +111 -111
  416. package/lib/engine-components/SpectatorCamera.js +715 -715
  417. package/lib/engine-components/SphereCollider.d.ts +2 -2
  418. package/lib/engine-components/SphereCollider.js +2 -2
  419. package/lib/engine-components/SpriteRenderer.d.ts +132 -132
  420. package/lib/engine-components/SpriteRenderer.js +472 -472
  421. package/lib/engine-components/SyncedCamera.d.ts +41 -41
  422. package/lib/engine-components/SyncedCamera.js +199 -199
  423. package/lib/engine-components/SyncedRoom.d.ts +106 -106
  424. package/lib/engine-components/SyncedRoom.js +371 -371
  425. package/lib/engine-components/SyncedTransform.d.ts +94 -94
  426. package/lib/engine-components/SyncedTransform.js +331 -331
  427. package/lib/engine-components/TestRunner.d.ts +16 -16
  428. package/lib/engine-components/TestRunner.js +102 -102
  429. package/lib/engine-components/TransformGizmo.d.ts +75 -75
  430. package/lib/engine-components/TransformGizmo.js +209 -209
  431. package/lib/engine-components/VideoPlayer.d.ts +184 -184
  432. package/lib/engine-components/VideoPlayer.js +978 -978
  433. package/lib/engine-components/Voip.d.ts +67 -67
  434. package/lib/engine-components/Voip.js +360 -360
  435. package/lib/engine-components/api.d.ts +51 -51
  436. package/lib/engine-components/api.js +50 -50
  437. package/lib/engine-components/avatar/AvatarBlink_Simple.d.ts +11 -11
  438. package/lib/engine-components/avatar/AvatarBlink_Simple.js +76 -76
  439. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.d.ts +14 -14
  440. package/lib/engine-components/avatar/AvatarEyeLook_Rotation.js +68 -68
  441. package/lib/engine-components/avatar/Avatar_Brain_LookAt.d.ts +29 -29
  442. package/lib/engine-components/avatar/Avatar_Brain_LookAt.js +121 -121
  443. package/lib/engine-components/avatar/Avatar_MouthShapes.d.ts +15 -15
  444. package/lib/engine-components/avatar/Avatar_MouthShapes.js +79 -79
  445. package/lib/engine-components/avatar/Avatar_MustacheShake.d.ts +9 -9
  446. package/lib/engine-components/avatar/Avatar_MustacheShake.js +29 -29
  447. package/lib/engine-components/codegen/components.d.ts +216 -216
  448. package/lib/engine-components/codegen/components.js +218 -218
  449. package/lib/engine-components/debug/LogStats.d.ts +5 -5
  450. package/lib/engine-components/debug/LogStats.js +18 -18
  451. package/lib/engine-components/export/gltf/GltfExport.d.ts +30 -30
  452. package/lib/engine-components/export/gltf/GltfExport.js +246 -246
  453. package/lib/engine-components/export/gltf/index.d.ts +1 -1
  454. package/lib/engine-components/export/gltf/index.js +1 -1
  455. package/lib/engine-components/export/index.d.ts +1 -1
  456. package/lib/engine-components/export/index.js +1 -1
  457. package/lib/engine-components/export/usdz/Extension.d.ts +22 -22
  458. package/lib/engine-components/export/usdz/Extension.js +1 -1
  459. package/lib/engine-components/export/usdz/ThreeUSDZExporter.d.ts +160 -160
  460. package/lib/engine-components/export/usdz/ThreeUSDZExporter.js +1782 -1782
  461. package/lib/engine-components/export/usdz/USDZExporter.d.ts +130 -130
  462. package/lib/engine-components/export/usdz/USDZExporter.js +663 -663
  463. package/lib/engine-components/export/usdz/extensions/Animation.d.ts +106 -106
  464. package/lib/engine-components/export/usdz/extensions/Animation.js +1071 -1071
  465. package/lib/engine-components/export/usdz/extensions/DocumentExtension.d.ts +5 -5
  466. package/lib/engine-components/export/usdz/extensions/DocumentExtension.js +6 -6
  467. package/lib/engine-components/export/usdz/extensions/USDZText.d.ts +54 -54
  468. package/lib/engine-components/export/usdz/extensions/USDZText.js +203 -203
  469. package/lib/engine-components/export/usdz/extensions/USDZUI.d.ts +8 -8
  470. package/lib/engine-components/export/usdz/extensions/USDZUI.js +158 -158
  471. package/lib/engine-components/export/usdz/extensions/behavior/Actions.d.ts +30 -30
  472. package/lib/engine-components/export/usdz/extensions/behavior/Actions.js +88 -88
  473. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.d.ts +10 -10
  474. package/lib/engine-components/export/usdz/extensions/behavior/AudioExtension.js +86 -86
  475. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.d.ts +28 -28
  476. package/lib/engine-components/export/usdz/extensions/behavior/Behaviour.js +290 -290
  477. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.d.ts +190 -190
  478. package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.js +1060 -1060
  479. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.d.ts +135 -135
  480. package/lib/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.js +548 -548
  481. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.d.ts +7 -7
  482. package/lib/engine-components/export/usdz/extensions/behavior/PhysicsExtension.js +115 -115
  483. package/lib/engine-components/export/usdz/index.d.ts +3 -3
  484. package/lib/engine-components/export/usdz/index.js +2 -2
  485. package/lib/engine-components/export/usdz/utils/animationutils.d.ts +7 -7
  486. package/lib/engine-components/export/usdz/utils/animationutils.js +163 -163
  487. package/lib/engine-components/export/usdz/utils/quicklook.d.ts +2 -2
  488. package/lib/engine-components/export/usdz/utils/quicklook.js +43 -43
  489. package/lib/engine-components/particlesystem/ParticleSystem.d.ts +177 -177
  490. package/lib/engine-components/particlesystem/ParticleSystem.js +1176 -1176
  491. package/lib/engine-components/particlesystem/ParticleSystemModules.d.ts +526 -526
  492. package/lib/engine-components/particlesystem/ParticleSystemModules.js +1930 -1930
  493. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.d.ts +25 -25
  494. package/lib/engine-components/particlesystem/ParticleSystemSubEmitter.js +87 -87
  495. package/lib/engine-components/particlesystem/api.d.ts +2 -2
  496. package/lib/engine-components/particlesystem/api.js +2 -2
  497. package/lib/engine-components/postprocessing/Effects/Antialiasing.d.ts +17 -17
  498. package/lib/engine-components/postprocessing/Effects/Antialiasing.js +50 -50
  499. package/lib/engine-components/postprocessing/Effects/BloomEffect.d.ts +46 -46
  500. package/lib/engine-components/postprocessing/Effects/BloomEffect.js +113 -113
  501. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.d.ts +11 -11
  502. package/lib/engine-components/postprocessing/Effects/ChromaticAberration.js +39 -39
  503. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.d.ts +15 -15
  504. package/lib/engine-components/postprocessing/Effects/ColorAdjustments.js +92 -92
  505. package/lib/engine-components/postprocessing/Effects/DepthOfField.d.ts +25 -25
  506. package/lib/engine-components/postprocessing/Effects/DepthOfField.js +104 -104
  507. package/lib/engine-components/postprocessing/Effects/EffectWrapper.d.ts +12 -12
  508. package/lib/engine-components/postprocessing/Effects/EffectWrapper.js +18 -18
  509. package/lib/engine-components/postprocessing/Effects/Pixelation.d.ts +11 -11
  510. package/lib/engine-components/postprocessing/Effects/Pixelation.js +32 -32
  511. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.d.ts +18 -18
  512. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.js +91 -91
  513. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.d.ts +70 -70
  514. package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.js +175 -175
  515. package/lib/engine-components/postprocessing/Effects/Sharpening.d.ts +17 -17
  516. package/lib/engine-components/postprocessing/Effects/Sharpening.js +123 -123
  517. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.d.ts +17 -17
  518. package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.js +70 -70
  519. package/lib/engine-components/postprocessing/Effects/Tonemapping.d.ts +26 -26
  520. package/lib/engine-components/postprocessing/Effects/Tonemapping.js +138 -138
  521. package/lib/engine-components/postprocessing/Effects/Vignette.d.ts +15 -15
  522. package/lib/engine-components/postprocessing/Effects/Vignette.js +60 -60
  523. package/lib/engine-components/postprocessing/PostProcessingEffect.d.ts +72 -72
  524. package/lib/engine-components/postprocessing/PostProcessingEffect.js +149 -149
  525. package/lib/engine-components/postprocessing/PostProcessingHandler.d.ts +25 -25
  526. package/lib/engine-components/postprocessing/PostProcessingHandler.js +350 -350
  527. package/lib/engine-components/postprocessing/Volume.d.ts +89 -89
  528. package/lib/engine-components/postprocessing/Volume.js +367 -367
  529. package/lib/engine-components/postprocessing/VolumeParameter.d.ts +26 -26
  530. package/lib/engine-components/postprocessing/VolumeParameter.js +136 -136
  531. package/lib/engine-components/postprocessing/VolumeProfile.d.ts +15 -15
  532. package/lib/engine-components/postprocessing/VolumeProfile.js +60 -60
  533. package/lib/engine-components/postprocessing/index.d.ts +5 -5
  534. package/lib/engine-components/postprocessing/index.js +5 -5
  535. package/lib/engine-components/postprocessing/utils.d.ts +11 -11
  536. package/lib/engine-components/postprocessing/utils.js +37 -37
  537. package/lib/engine-components/timeline/PlayableDirector.d.ts +163 -163
  538. package/lib/engine-components/timeline/PlayableDirector.js +686 -686
  539. package/lib/engine-components/timeline/SignalAsset.d.ts +24 -24
  540. package/lib/engine-components/timeline/SignalAsset.js +130 -130
  541. package/lib/engine-components/timeline/TimelineModels.d.ts +89 -89
  542. package/lib/engine-components/timeline/TimelineModels.js +22 -22
  543. package/lib/engine-components/timeline/TimelineTracks.d.ts +110 -110
  544. package/lib/engine-components/timeline/TimelineTracks.js +879 -879
  545. package/lib/engine-components/timeline/index.d.ts +4 -4
  546. package/lib/engine-components/timeline/index.js +3 -3
  547. package/lib/engine-components/ui/BaseUIComponent.d.ts +48 -48
  548. package/lib/engine-components/ui/BaseUIComponent.js +170 -170
  549. package/lib/engine-components/ui/Button.d.ts +64 -64
  550. package/lib/engine-components/ui/Button.js +315 -315
  551. package/lib/engine-components/ui/Canvas.d.ts +74 -74
  552. package/lib/engine-components/ui/Canvas.js +407 -407
  553. package/lib/engine-components/ui/CanvasGroup.d.ts +19 -19
  554. package/lib/engine-components/ui/CanvasGroup.js +58 -58
  555. package/lib/engine-components/ui/EventSystem.d.ts +125 -125
  556. package/lib/engine-components/ui/EventSystem.js +765 -765
  557. package/lib/engine-components/ui/Graphic.d.ts +55 -55
  558. package/lib/engine-components/ui/Graphic.js +255 -255
  559. package/lib/engine-components/ui/Image.d.ts +35 -35
  560. package/lib/engine-components/ui/Image.js +116 -116
  561. package/lib/engine-components/ui/InputField.d.ts +42 -42
  562. package/lib/engine-components/ui/InputField.js +268 -268
  563. package/lib/engine-components/ui/Interfaces.d.ts +38 -38
  564. package/lib/engine-components/ui/Interfaces.js +12 -12
  565. package/lib/engine-components/ui/Layout.d.ts +84 -84
  566. package/lib/engine-components/ui/Layout.js +330 -330
  567. package/lib/engine-components/ui/Outline.d.ts +7 -7
  568. package/lib/engine-components/ui/Outline.js +20 -20
  569. package/lib/engine-components/ui/PointerEvents.d.ts +115 -115
  570. package/lib/engine-components/ui/PointerEvents.js +145 -145
  571. package/lib/engine-components/ui/RaycastUtils.d.ts +11 -11
  572. package/lib/engine-components/ui/RaycastUtils.js +67 -67
  573. package/lib/engine-components/ui/Raycaster.d.ts +30 -30
  574. package/lib/engine-components/ui/Raycaster.js +95 -95
  575. package/lib/engine-components/ui/RectTransform.d.ts +61 -61
  576. package/lib/engine-components/ui/RectTransform.js +356 -356
  577. package/lib/engine-components/ui/SpatialHtml.d.ts +8 -8
  578. package/lib/engine-components/ui/SpatialHtml.js +79 -79
  579. package/lib/engine-components/ui/Symbols.d.ts +1 -1
  580. package/lib/engine-components/ui/Symbols.js +1 -1
  581. package/lib/engine-components/ui/Text.d.ts +78 -78
  582. package/lib/engine-components/ui/Text.js +539 -539
  583. package/lib/engine-components/ui/Utils.d.ts +24 -24
  584. package/lib/engine-components/ui/Utils.js +90 -90
  585. package/lib/engine-components/ui/index.d.ts +1 -1
  586. package/lib/engine-components/ui/index.js +1 -1
  587. package/lib/engine-components/utils/EnvironmentScene.d.ts +5 -5
  588. package/lib/engine-components/utils/EnvironmentScene.js +205 -205
  589. package/lib/engine-components/utils/LookAt.d.ts +31 -31
  590. package/lib/engine-components/utils/LookAt.js +82 -82
  591. package/lib/engine-components/utils/OpenURL.d.ts +42 -42
  592. package/lib/engine-components/utils/OpenURL.js +119 -119
  593. package/lib/engine-components/webxr/Avatar.d.ts +25 -25
  594. package/lib/engine-components/webxr/Avatar.js +255 -255
  595. package/lib/engine-components/webxr/TeleportTarget.d.ts +7 -7
  596. package/lib/engine-components/webxr/TeleportTarget.js +7 -7
  597. package/lib/engine-components/webxr/WebARCameraBackground.d.ts +30 -30
  598. package/lib/engine-components/webxr/WebARCameraBackground.js +155 -155
  599. package/lib/engine-components/webxr/WebARSessionRoot.d.ts +98 -98
  600. package/lib/engine-components/webxr/WebARSessionRoot.js +770 -770
  601. package/lib/engine-components/webxr/WebXR.d.ts +232 -232
  602. package/lib/engine-components/webxr/WebXR.js +561 -561
  603. package/lib/engine-components/webxr/WebXRAvatar.d.ts +27 -27
  604. package/lib/engine-components/webxr/WebXRAvatar.js +44 -44
  605. package/lib/engine-components/webxr/WebXRImageTracking.d.ts +86 -86
  606. package/lib/engine-components/webxr/WebXRImageTracking.js +471 -471
  607. package/lib/engine-components/webxr/WebXRPlaneTracking.d.ts +92 -92
  608. package/lib/engine-components/webxr/WebXRPlaneTracking.js +500 -500
  609. package/lib/engine-components/webxr/WebXRRig.d.ts +32 -32
  610. package/lib/engine-components/webxr/WebXRRig.js +72 -72
  611. package/lib/engine-components/webxr/XRFlag.d.ts +38 -38
  612. package/lib/engine-components/webxr/XRFlag.js +139 -139
  613. package/lib/engine-components/webxr/controllers/XRControllerFollow.d.ts +47 -47
  614. package/lib/engine-components/webxr/controllers/XRControllerFollow.js +120 -120
  615. package/lib/engine-components/webxr/controllers/XRControllerModel.d.ts +43 -43
  616. package/lib/engine-components/webxr/controllers/XRControllerModel.js +352 -352
  617. package/lib/engine-components/webxr/controllers/XRControllerMovement.d.ts +78 -78
  618. package/lib/engine-components/webxr/controllers/XRControllerMovement.js +506 -506
  619. package/lib/engine-components/webxr/index.d.ts +3 -3
  620. package/lib/engine-components/webxr/index.js +3 -3
  621. package/lib/engine-components/webxr/types.d.ts +3 -3
  622. package/lib/engine-components/webxr/types.js +1 -1
  623. package/lib/engine-components-experimental/Presentation.d.ts +6 -6
  624. package/lib/engine-components-experimental/Presentation.js +9 -9
  625. package/lib/engine-components-experimental/api.d.ts +4 -4
  626. package/lib/engine-components-experimental/api.js +4 -4
  627. package/lib/engine-components-experimental/networking/PlayerSync.d.ts +156 -156
  628. package/lib/engine-components-experimental/networking/PlayerSync.js +377 -377
  629. package/lib/engine-schemes/api.d.ts +12 -12
  630. package/lib/engine-schemes/api.js +12 -12
  631. package/lib/engine-schemes/schemes.d.ts +7 -7
  632. package/lib/engine-schemes/schemes.js +19 -19
  633. package/lib/engine-schemes/synced-camera-model.d.ts +25 -25
  634. package/lib/engine-schemes/synced-camera-model.js +67 -67
  635. package/lib/engine-schemes/synced-transform-model.d.ts +31 -31
  636. package/lib/engine-schemes/synced-transform-model.js +66 -66
  637. package/lib/engine-schemes/transform.d.ts +12 -12
  638. package/lib/engine-schemes/transform.js +39 -39
  639. package/lib/engine-schemes/vec2.d.ts +10 -10
  640. package/lib/engine-schemes/vec2.js +25 -25
  641. package/lib/engine-schemes/vec3.d.ts +11 -11
  642. package/lib/engine-schemes/vec3.js +29 -29
  643. package/lib/engine-schemes/vec4.d.ts +12 -12
  644. package/lib/engine-schemes/vec4.js +33 -33
  645. package/lib/engine-schemes/vr-user-state-buffer.d.ts +37 -37
  646. package/lib/engine-schemes/vr-user-state-buffer.js +110 -110
  647. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.d.ts +6 -6
  648. package/lib/include/three/EXT_mesh_gpu_instancing_exporter.js +45 -45
  649. package/lib/needle-engine.d.ts +7 -7
  650. package/lib/needle-engine.js +64 -64
  651. package/package.json +2 -2
  652. package/plugins/common/buildinfo.js +64 -64
  653. package/plugins/common/cloud.js +1 -1
  654. package/plugins/common/config.cjs +31 -31
  655. package/plugins/common/config.js +35 -35
  656. package/plugins/common/files.js +31 -31
  657. package/plugins/common/generator.js +10 -10
  658. package/plugins/common/license.js +452 -442
  659. package/plugins/common/npm.js +15 -15
  660. package/plugins/common/timers.js +7 -7
  661. package/plugins/common/version.js +37 -37
  662. package/plugins/gltf-packer.mjs +1 -1
  663. package/plugins/next/alias.cjs +39 -39
  664. package/plugins/next/license.cjs +24 -24
  665. package/plugins/next/meshbvhworker.cjs +18 -18
  666. package/plugins/next/next.js +141 -141
  667. package/plugins/types/index.d.ts +2 -2
  668. package/plugins/types/license.d.ts +24 -24
  669. package/plugins/types/needleConfig.d.ts +27 -27
  670. package/plugins/types/next.d.ts +2 -2
  671. package/plugins/types/userconfig.d.ts +120 -120
  672. package/plugins/types/vite.d.ts +13 -13
  673. package/plugins/types/webmanifest.d.ts +32 -32
  674. package/plugins/vite/alias.js +174 -174
  675. package/plugins/vite/asap.js +245 -245
  676. package/plugins/vite/build-pipeline.js +371 -371
  677. package/plugins/vite/build.js +19 -19
  678. package/plugins/vite/buildinfo.js +41 -41
  679. package/plugins/vite/config.js +106 -106
  680. package/plugins/vite/copyfiles.js +138 -138
  681. package/plugins/vite/defines.js +70 -70
  682. package/plugins/vite/dependencies.js +232 -232
  683. package/plugins/vite/dependency-watcher.js +231 -231
  684. package/plugins/vite/drop-client.js +76 -76
  685. package/plugins/vite/drop.js +87 -87
  686. package/plugins/vite/editor-connection.js +124 -124
  687. package/plugins/vite/facebook-instant-games.js +102 -102
  688. package/plugins/vite/gzip.js +5 -5
  689. package/plugins/vite/imports-logger.js +143 -143
  690. package/plugins/vite/index.js +143 -143
  691. package/plugins/vite/license.js +56 -56
  692. package/plugins/vite/local-files.js +231 -231
  693. package/plugins/vite/meta.js +163 -163
  694. package/plugins/vite/npm.js +7 -7
  695. package/plugins/vite/peer.js +29 -29
  696. package/plugins/vite/poster-client.js +73 -73
  697. package/plugins/vite/poster.js +79 -79
  698. package/plugins/vite/pwa.js +604 -604
  699. package/plugins/vite/reload-client.js +15 -15
  700. package/plugins/vite/reload.js +351 -351
  701. package/plugins/vite/server.js +66 -66
  702. package/plugins/vite/transform-codegen.js +55 -55
  703. package/plugins/vite/transform.js +31 -31
  704. package/plugins/vite/vite-4.4-hack.js +31 -31
  705. package/src/asap/needle-asap.ts +111 -111
  706. package/src/asap/sessiongranted.ts +75 -75
  707. package/src/asap/utils.ts +4 -4
  708. package/src/engine/analytics/index.ts +10 -10
  709. package/src/engine/analytics/lcp.ts +35 -35
  710. package/src/engine/api.ts +82 -82
  711. package/src/engine/assets/index.ts +59 -59
  712. package/src/engine/assets/static.js +5 -5
  713. package/src/engine/codegen/register_types.ts +300 -300
  714. package/src/engine/debug/debug.ts +51 -51
  715. package/src/engine/debug/debug_console.ts +333 -333
  716. package/src/engine/debug/debug_overlay.ts +332 -332
  717. package/src/engine/debug/debug_spatial_console.ts +429 -429
  718. package/src/engine/debug/index.ts +1 -1
  719. package/src/engine/engine_addressables.ts +680 -680
  720. package/src/engine/engine_animation.ts +145 -145
  721. package/src/engine/engine_application.ts +113 -113
  722. package/src/engine/engine_assetdatabase.ts +387 -387
  723. package/src/engine/engine_audio.ts +24 -24
  724. package/src/engine/engine_camera.ts +39 -39
  725. package/src/engine/engine_components.ts +366 -366
  726. package/src/engine/engine_components_internal.ts +40 -40
  727. package/src/engine/engine_constants.ts +52 -52
  728. package/src/engine/engine_context.ts +1811 -1811
  729. package/src/engine/engine_context_registry.ts +129 -129
  730. package/src/engine/engine_coroutine.ts +54 -54
  731. package/src/engine/engine_create_objects.ts +411 -411
  732. package/src/engine/engine_default_parameters.ts +3 -3
  733. package/src/engine/engine_editor-sync.ts +28 -28
  734. package/src/engine/engine_fileloader.js +9 -9
  735. package/src/engine/engine_gameobject.ts +709 -709
  736. package/src/engine/engine_generic_utils.js +13 -13
  737. package/src/engine/engine_gizmos.ts +577 -577
  738. package/src/engine/engine_gltf.ts +29 -29
  739. package/src/engine/engine_gltf_builtin_components.ts +403 -403
  740. package/src/engine/engine_hot_reload.ts +210 -210
  741. package/src/engine/engine_input.ts +1500 -1500
  742. package/src/engine/engine_input_utils.ts +23 -23
  743. package/src/engine/engine_instancing.ts +45 -45
  744. package/src/engine/engine_license.ts +386 -386
  745. package/src/engine/engine_lifecycle_api.ts +113 -113
  746. package/src/engine/engine_lifecycle_functions_internal.ts +193 -193
  747. package/src/engine/engine_lightdata.ts +117 -117
  748. package/src/engine/engine_loaders.callbacks.ts +136 -136
  749. package/src/engine/engine_loaders.gltf.ts +82 -82
  750. package/src/engine/engine_loaders.ts +378 -378
  751. package/src/engine/engine_lods.ts +168 -168
  752. package/src/engine/engine_mainloop_utils.ts +472 -472
  753. package/src/engine/engine_math.ts +282 -282
  754. package/src/engine/engine_modules.ts +83 -83
  755. package/src/engine/engine_networking.ts +862 -862
  756. package/src/engine/engine_networking_auto.ts +352 -352
  757. package/src/engine/engine_networking_blob.ts +275 -275
  758. package/src/engine/engine_networking_files.ts +217 -217
  759. package/src/engine/engine_networking_files_default_components.ts +58 -58
  760. package/src/engine/engine_networking_instantiate.ts +419 -419
  761. package/src/engine/engine_networking_peer.ts +159 -159
  762. package/src/engine/engine_networking_streams.ts +713 -713
  763. package/src/engine/engine_networking_types.ts +24 -24
  764. package/src/engine/engine_networking_utils.ts +23 -23
  765. package/src/engine/engine_networking_websocket.ts +2 -2
  766. package/src/engine/engine_patcher.ts +199 -199
  767. package/src/engine/engine_physics.ts +783 -783
  768. package/src/engine/engine_physics.types.ts +46 -46
  769. package/src/engine/engine_physics_rapier.ts +1577 -1577
  770. package/src/engine/engine_playerview.ts +80 -80
  771. package/src/engine/engine_scenelighting.ts +294 -294
  772. package/src/engine/engine_serialization.ts +2 -2
  773. package/src/engine/engine_serialization_builtin_serializer.ts +473 -473
  774. package/src/engine/engine_serialization_core.ts +720 -720
  775. package/src/engine/engine_serialization_decorator.ts +80 -80
  776. package/src/engine/engine_setup.ts +1 -1
  777. package/src/engine/engine_shaders.ts +267 -267
  778. package/src/engine/engine_shims.ts +32 -32
  779. package/src/engine/engine_test_utils.ts +109 -109
  780. package/src/engine/engine_texture.ts +82 -82
  781. package/src/engine/engine_three_utils.ts +849 -849
  782. package/src/engine/engine_time.ts +94 -94
  783. package/src/engine/engine_time_utils.ts +237 -237
  784. package/src/engine/engine_tonemapping.ts +210 -210
  785. package/src/engine/engine_types.ts +730 -730
  786. package/src/engine/engine_typestore.ts +63 -63
  787. package/src/engine/engine_util_decorator.ts +136 -136
  788. package/src/engine/engine_utils.ts +1093 -1093
  789. package/src/engine/engine_utils_format.ts +273 -273
  790. package/src/engine/engine_utils_screenshot.ts +698 -698
  791. package/src/engine/engine_utils_screenshot.xr.ts +103 -103
  792. package/src/engine/export/gltf/Writers.ts +34 -34
  793. package/src/engine/export/gltf/index.ts +158 -158
  794. package/src/engine/export/index.ts +2 -2
  795. package/src/engine/export/state.ts +19 -19
  796. package/src/engine/export/utils.ts +9 -9
  797. package/src/engine/extensions/EXT_texture_exr.ts +50 -50
  798. package/src/engine/extensions/NEEDLE_animator_controller_model.ts +195 -195
  799. package/src/engine/extensions/NEEDLE_components.ts +268 -268
  800. package/src/engine/extensions/NEEDLE_gameobject_data.ts +81 -81
  801. package/src/engine/extensions/NEEDLE_lighting_settings.ts +185 -185
  802. package/src/engine/extensions/NEEDLE_lightmaps.ts +119 -119
  803. package/src/engine/extensions/NEEDLE_persistent_assets.ts +76 -76
  804. package/src/engine/extensions/NEEDLE_render_objects.ts +209 -209
  805. package/src/engine/extensions/NEEDLE_techniques_webgl.ts +640 -640
  806. package/src/engine/extensions/extension_resolver.ts +4 -4
  807. package/src/engine/extensions/extension_utils.ts +166 -166
  808. package/src/engine/extensions/extensions.ts +140 -140
  809. package/src/engine/extensions/index.ts +5 -5
  810. package/src/engine/extensions/usage_tracker.ts +100 -100
  811. package/src/engine/js-extensions/Camera.ts +37 -37
  812. package/src/engine/js-extensions/ExtensionUtils.ts +85 -85
  813. package/src/engine/js-extensions/Layers.ts +23 -23
  814. package/src/engine/js-extensions/Object3D.ts +296 -296
  815. package/src/engine/js-extensions/RGBAColor.ts +126 -126
  816. package/src/engine/js-extensions/Vector.ts +18 -18
  817. package/src/engine/js-extensions/index.ts +4 -4
  818. package/src/engine/physics/workers/mesh-bvh/GenerateMeshBVHWorker.js +125 -125
  819. package/src/engine/shaders/shaderData.ts +67 -67
  820. package/src/engine/tests/test_utils.ts +63 -63
  821. package/src/engine/webcomponents/WebXRButtons.ts +260 -260
  822. package/src/engine/webcomponents/api.ts +6 -6
  823. package/src/engine/webcomponents/buttons.ts +292 -292
  824. package/src/engine/webcomponents/fonts.ts +41 -41
  825. package/src/engine/webcomponents/icons.ts +57 -57
  826. package/src/engine/webcomponents/index.ts +1 -1
  827. package/src/engine/webcomponents/logo-element.ts +78 -78
  828. package/src/engine/webcomponents/needle menu/needle-menu-spatial.ts +573 -573
  829. package/src/engine/webcomponents/needle menu/needle-menu.ts +1118 -1118
  830. package/src/engine/webcomponents/needle-button.ts +181 -181
  831. package/src/engine/webcomponents/needle-engine.ar-overlay.ts +186 -186
  832. package/src/engine/webcomponents/needle-engine.attributes.ts +82 -82
  833. package/src/engine/webcomponents/needle-engine.extras.ts +16 -16
  834. package/src/engine/webcomponents/needle-engine.loading.ts +373 -373
  835. package/src/engine/webcomponents/needle-engine.ts +871 -871
  836. package/src/engine/xr/NeedleXRController.ts +1125 -1125
  837. package/src/engine/xr/NeedleXRSession.ts +1624 -1624
  838. package/src/engine/xr/NeedleXRSync.ts +220 -220
  839. package/src/engine/xr/SceneTransition.ts +78 -78
  840. package/src/engine/xr/TempXRContext.ts +216 -216
  841. package/src/engine/xr/XRRig.ts +9 -9
  842. package/src/engine/xr/api.ts +5 -5
  843. package/src/engine/xr/events.ts +102 -102
  844. package/src/engine/xr/internal.ts +34 -34
  845. package/src/engine/xr/usdz.ts +30 -30
  846. package/src/engine/xr/utils.ts +39 -39
  847. package/src/engine-components/AlignmentConstraint.ts +36 -36
  848. package/src/engine-components/Animation.ts +557 -557
  849. package/src/engine-components/AnimationCurve.ts +150 -150
  850. package/src/engine-components/AnimationUtils.ts +28 -28
  851. package/src/engine-components/AnimationUtilsAutoplay.ts +43 -43
  852. package/src/engine-components/Animator.ts +397 -397
  853. package/src/engine-components/AnimatorController.ts +1293 -1293
  854. package/src/engine-components/AudioListener.ts +92 -92
  855. package/src/engine-components/AudioSource.ts +644 -644
  856. package/src/engine-components/AvatarLoader.ts +263 -263
  857. package/src/engine-components/AxesHelper.ts +59 -59
  858. package/src/engine-components/BasicIKConstraint.ts +54 -54
  859. package/src/engine-components/BoxCollider.ts +1 -1
  860. package/src/engine-components/BoxHelperComponent.ts +114 -114
  861. package/src/engine-components/Camera.ts +719 -719
  862. package/src/engine-components/CameraUtils.ts +136 -136
  863. package/src/engine-components/CharacterController.ts +253 -253
  864. package/src/engine-components/Collider.ts +374 -374
  865. package/src/engine-components/Component.ts +1297 -1297
  866. package/src/engine-components/ContactShadows.ts +506 -506
  867. package/src/engine-components/DeleteBox.ts +62 -62
  868. package/src/engine-components/DeviceFlag.ts +46 -46
  869. package/src/engine-components/DragControls.ts +1623 -1623
  870. package/src/engine-components/DropListener.ts +713 -713
  871. package/src/engine-components/Duplicatable.ts +198 -198
  872. package/src/engine-components/EventList.ts +266 -266
  873. package/src/engine-components/EventTrigger.ts +74 -74
  874. package/src/engine-components/EventType.ts +22 -22
  875. package/src/engine-components/Fog.ts +60 -60
  876. package/src/engine-components/Gizmos.ts +56 -56
  877. package/src/engine-components/GridHelper.ts +48 -48
  878. package/src/engine-components/GroundProjection.ts +356 -356
  879. package/src/engine-components/Interactable.ts +14 -14
  880. package/src/engine-components/Joints.ts +52 -52
  881. package/src/engine-components/LODGroup.ts +153 -153
  882. package/src/engine-components/Light.ts +558 -558
  883. package/src/engine-components/LookAtConstraint.ts +25 -25
  884. package/src/engine-components/NeedleMenu.ts +84 -84
  885. package/src/engine-components/NestedGltf.ts +86 -86
  886. package/src/engine-components/Networking.ts +114 -114
  887. package/src/engine-components/OffsetConstraint.ts +60 -60
  888. package/src/engine-components/OrbitControls.ts +1074 -1074
  889. package/src/engine-components/PlayerColor.ts +103 -103
  890. package/src/engine-components/ReflectionProbe.ts +216 -216
  891. package/src/engine-components/Renderer.ts +900 -900
  892. package/src/engine-components/RendererInstancing.ts +855 -855
  893. package/src/engine-components/RendererLightmap.ts +198 -198
  894. package/src/engine-components/RigidBody.ts +526 -526
  895. package/src/engine-components/SceneSwitcher.ts +1030 -1030
  896. package/src/engine-components/ScreenCapture.ts +592 -592
  897. package/src/engine-components/ShadowCatcher.ts +172 -172
  898. package/src/engine-components/Skybox.ts +455 -455
  899. package/src/engine-components/SmoothFollow.ts +76 -76
  900. package/src/engine-components/SpatialTrigger.ts +229 -229
  901. package/src/engine-components/SpectatorCamera.ts +787 -787
  902. package/src/engine-components/SphereCollider.ts +1 -1
  903. package/src/engine-components/SpriteRenderer.ts +468 -468
  904. package/src/engine-components/SyncedCamera.ts +220 -220
  905. package/src/engine-components/SyncedRoom.ts +380 -380
  906. package/src/engine-components/SyncedTransform.ts +383 -383
  907. package/src/engine-components/TestRunner.ts +118 -118
  908. package/src/engine-components/TransformGizmo.ts +219 -219
  909. package/src/engine-components/VideoPlayer.ts +1025 -1025
  910. package/src/engine-components/Voip.ts +363 -363
  911. package/src/engine-components/api.ts +60 -60
  912. package/src/engine-components/avatar/AvatarBlink_Simple.ts +69 -69
  913. package/src/engine-components/avatar/AvatarEyeLook_Rotation.ts +63 -63
  914. package/src/engine-components/avatar/Avatar_Brain_LookAt.ts +139 -139
  915. package/src/engine-components/avatar/Avatar_MouthShapes.ts +83 -83
  916. package/src/engine-components/avatar/Avatar_MustacheShake.ts +31 -31
  917. package/src/engine-components/codegen/components.ts +217 -217
  918. package/src/engine-components/debug/LogStats.ts +21 -21
  919. package/src/engine-components/export/gltf/GltfExport.ts +265 -265
  920. package/src/engine-components/export/usdz/Extension.ts +24 -24
  921. package/src/engine-components/export/usdz/ThreeUSDZExporter.ts +2413 -2413
  922. package/src/engine-components/export/usdz/USDZExporter.ts +705 -705
  923. package/src/engine-components/export/usdz/extensions/Animation.ts +1204 -1204
  924. package/src/engine-components/export/usdz/extensions/DocumentExtension.ts +9 -9
  925. package/src/engine-components/export/usdz/extensions/USDZText.ts +240 -240
  926. package/src/engine-components/export/usdz/extensions/USDZUI.ts +189 -189
  927. package/src/engine-components/export/usdz/extensions/behavior/Actions.ts +99 -99
  928. package/src/engine-components/export/usdz/extensions/behavior/AudioExtension.ts +102 -102
  929. package/src/engine-components/export/usdz/extensions/behavior/Behaviour.ts +320 -320
  930. package/src/engine-components/export/usdz/extensions/behavior/BehaviourComponents.ts +1225 -1225
  931. package/src/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.ts +646 -646
  932. package/src/engine-components/export/usdz/extensions/behavior/PhysicsExtension.ts +132 -132
  933. package/src/engine-components/export/usdz/index.ts +2 -2
  934. package/src/engine-components/export/usdz/utils/animationutils.ts +191 -191
  935. package/src/engine-components/export/usdz/utils/quicklook.ts +50 -50
  936. package/src/engine-components/particlesystem/ParticleSystem.ts +1287 -1287
  937. package/src/engine-components/particlesystem/ParticleSystemModules.ts +1765 -1765
  938. package/src/engine-components/particlesystem/ParticleSystemSubEmitter.ts +111 -111
  939. package/src/engine-components/particlesystem/api.ts +1 -1
  940. package/src/engine-components/postprocessing/Effects/Antialiasing.ts +55 -55
  941. package/src/engine-components/postprocessing/Effects/BloomEffect.ts +116 -116
  942. package/src/engine-components/postprocessing/Effects/ChromaticAberration.ts +37 -37
  943. package/src/engine-components/postprocessing/Effects/ColorAdjustments.ts +95 -95
  944. package/src/engine-components/postprocessing/Effects/DepthOfField.ts +103 -103
  945. package/src/engine-components/postprocessing/Effects/EffectWrapper.ts +25 -25
  946. package/src/engine-components/postprocessing/Effects/Pixelation.ts +32 -32
  947. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.ts +90 -90
  948. package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts +191 -191
  949. package/src/engine-components/postprocessing/Effects/Sharpening.ts +138 -138
  950. package/src/engine-components/postprocessing/Effects/TiltShiftEffect.ts +61 -61
  951. package/src/engine-components/postprocessing/Effects/Tonemapping.ts +155 -155
  952. package/src/engine-components/postprocessing/Effects/Vignette.ts +59 -59
  953. package/src/engine-components/postprocessing/PostProcessingEffect.ts +172 -172
  954. package/src/engine-components/postprocessing/PostProcessingHandler.ts +398 -398
  955. package/src/engine-components/postprocessing/Volume.ts +410 -410
  956. package/src/engine-components/postprocessing/VolumeParameter.ts +158 -158
  957. package/src/engine-components/postprocessing/VolumeProfile.ts +61 -61
  958. package/src/engine-components/postprocessing/index.ts +5 -5
  959. package/src/engine-components/postprocessing/utils.ts +52 -52
  960. package/src/engine-components/timeline/PlayableDirector.ts +722 -722
  961. package/src/engine-components/timeline/SignalAsset.ts +144 -144
  962. package/src/engine-components/timeline/TimelineModels.ts +92 -92
  963. package/src/engine-components/timeline/TimelineTracks.ts +967 -967
  964. package/src/engine-components/timeline/index.ts +3 -3
  965. package/src/engine-components/ui/BaseUIComponent.ts +203 -203
  966. package/src/engine-components/ui/Button.ts +307 -307
  967. package/src/engine-components/ui/Canvas.ts +419 -419
  968. package/src/engine-components/ui/CanvasGroup.ts +54 -54
  969. package/src/engine-components/ui/EventSystem.ts +854 -854
  970. package/src/engine-components/ui/Graphic.ts +275 -275
  971. package/src/engine-components/ui/Image.ts +112 -112
  972. package/src/engine-components/ui/InputField.ts +321 -321
  973. package/src/engine-components/ui/Interfaces.ts +57 -57
  974. package/src/engine-components/ui/Layout.ts +334 -334
  975. package/src/engine-components/ui/Outline.ts +13 -13
  976. package/src/engine-components/ui/PointerEvents.ts +206 -206
  977. package/src/engine-components/ui/RaycastUtils.ts +69 -69
  978. package/src/engine-components/ui/Raycaster.ts +102 -102
  979. package/src/engine-components/ui/RectTransform.ts +375 -375
  980. package/src/engine-components/ui/SpatialHtml.ts +79 -79
  981. package/src/engine-components/ui/Symbols.ts +1 -1
  982. package/src/engine-components/ui/Text.ts +578 -578
  983. package/src/engine-components/ui/Utils.ts +113 -113
  984. package/src/engine-components/utils/EnvironmentScene.ts +245 -245
  985. package/src/engine-components/utils/LookAt.ts +88 -88
  986. package/src/engine-components/utils/OpenURL.ts +114 -114
  987. package/src/engine-components/webxr/Avatar.ts +265 -265
  988. package/src/engine-components/webxr/TeleportTarget.ts +9 -9
  989. package/src/engine-components/webxr/WebARCameraBackground.ts +175 -175
  990. package/src/engine-components/webxr/WebARSessionRoot.ts +880 -880
  991. package/src/engine-components/webxr/WebXR.ts +585 -585
  992. package/src/engine-components/webxr/WebXRAvatar.ts +66 -66
  993. package/src/engine-components/webxr/WebXRImageTracking.ts +519 -519
  994. package/src/engine-components/webxr/WebXRPlaneTracking.ts +570 -570
  995. package/src/engine-components/webxr/WebXRRig.ts +77 -77
  996. package/src/engine-components/webxr/XRFlag.ts +147 -147
  997. package/src/engine-components/webxr/controllers/XRControllerFollow.ts +118 -118
  998. package/src/engine-components/webxr/controllers/XRControllerModel.ts +373 -373
  999. package/src/engine-components/webxr/controllers/XRControllerMovement.ts +550 -550
  1000. package/src/engine-components/webxr/index.ts +2 -2
  1001. package/src/engine-components/webxr/types.ts +3 -3
  1002. package/src/engine-components-experimental/Presentation.ts +12 -12
  1003. package/src/engine-components-experimental/api.ts +4 -4
  1004. package/src/engine-components-experimental/networking/PlayerSync.ts +401 -401
  1005. package/src/engine-schemes/COMPILE_SCHEMES.bat +3 -3
  1006. package/src/engine-schemes/COMPILE_TS.bat +11 -11
  1007. package/src/engine-schemes/README.md +1 -1
  1008. package/src/engine-schemes/api.ts +12 -12
  1009. package/src/engine-schemes/dist/api.js +17 -0
  1010. package/src/engine-schemes/dist/api.js.meta +7 -0
  1011. package/src/engine-schemes/dist/schemes.js +25 -0
  1012. package/src/engine-schemes/dist/schemes.js.meta +7 -0
  1013. package/src/engine-schemes/dist/synced-camera-model.js +74 -0
  1014. package/src/engine-schemes/dist/synced-camera-model.js.meta +7 -0
  1015. package/src/engine-schemes/dist/synced-transform-model.js +73 -0
  1016. package/src/engine-schemes/dist/synced-transform-model.js.meta +7 -0
  1017. package/src/engine-schemes/dist/transform.js +46 -0
  1018. package/src/engine-schemes/dist/transform.js.meta +7 -0
  1019. package/src/engine-schemes/dist/vec2.js +32 -0
  1020. package/src/engine-schemes/dist/vec2.js.meta +7 -0
  1021. package/src/engine-schemes/dist/vec3.js +36 -0
  1022. package/src/engine-schemes/dist/vec3.js.meta +7 -0
  1023. package/src/engine-schemes/dist/vec4.js +40 -0
  1024. package/src/engine-schemes/dist/vec4.js.meta +7 -0
  1025. package/src/engine-schemes/dist/vr-user-state-buffer.js +110 -0
  1026. package/src/engine-schemes/dist/vr-user-state-buffer.js.meta +7 -0
  1027. package/src/engine-schemes/schemes.ts +28 -28
  1028. package/src/engine-schemes/synced-camera-model.ts +92 -92
  1029. package/src/engine-schemes/synced-transform-model.ts +90 -90
  1030. package/src/engine-schemes/syncedCamera.fbs +10 -10
  1031. package/src/engine-schemes/transform.ts +50 -50
  1032. package/src/engine-schemes/transforms.fbs +25 -25
  1033. package/src/engine-schemes/vec.fbs +19 -19
  1034. package/src/engine-schemes/vec2.ts +33 -33
  1035. package/src/engine-schemes/vec3.ts +38 -38
  1036. package/src/engine-schemes/vec4.ts +43 -43
  1037. package/src/engine-schemes/vr-user-state-buffer.ts +145 -145
  1038. package/src/engine-schemes/vrUserStateBuffer.fbs +17 -17
  1039. package/src/include/draco/draco_decoder.js +34 -34
  1040. package/src/include/ktx2/basis_transcoder.js +21 -21
  1041. package/src/include/needle/arial-msdf.json +1471 -1471
  1042. package/src/include/three/DragControls.js +231 -231
  1043. package/src/include/three/EXT_mesh_gpu_instancing_exporter.js +66 -66
  1044. package/src/needle-engine.ts +70 -70
@@ -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