hytopia 0.2.11 → 0.3.0-dev.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (429) hide show
  1. package/docs/server.audio.md +7 -1
  2. package/docs/{server.audioeventtype.md → server.audioevent.md} +4 -4
  3. package/docs/server.audioeventpayloads._audio.pause_.md +15 -0
  4. package/docs/server.audioeventpayloads._audio.play_.md +15 -0
  5. package/docs/server.audioeventpayloads._audio.play_restart_.md +15 -0
  6. package/docs/server.audioeventpayloads._audio.set_attached_to_entity_.md +16 -0
  7. package/docs/server.audioeventpayloads._audio.set_detune_.md +16 -0
  8. package/docs/server.audioeventpayloads._audio.set_distortion_.md +16 -0
  9. package/docs/server.audioeventpayloads._audio.set_playback_rate_.md +16 -0
  10. package/docs/server.audioeventpayloads._audio.set_position_.md +16 -0
  11. package/docs/server.audioeventpayloads._audio.set_reference_distance_.md +16 -0
  12. package/docs/server.audioeventpayloads._audio.set_volume_.md +16 -0
  13. package/docs/server.audioeventpayloads.md +228 -0
  14. package/docs/server.baseentitycontroller.md +4 -138
  15. package/docs/server.baseentitycontrollerevent.md +117 -0
  16. package/docs/server.baseentitycontrollereventpayloads.attach.md +15 -0
  17. package/docs/server.baseentitycontrollereventpayloads.despawn.md +15 -0
  18. package/docs/server.baseentitycontrollereventpayloads.detach.md +15 -0
  19. package/docs/server.baseentitycontrollereventpayloads.md +152 -0
  20. package/docs/server.baseentitycontrollereventpayloads.spawn.md +15 -0
  21. package/docs/server.baseentitycontrollereventpayloads.tick.md +16 -0
  22. package/docs/server.baseentitycontrollereventpayloads.tickwithplayerinput.md +18 -0
  23. package/docs/server.blocktype.md +7 -39
  24. package/docs/server.blocktypeevent.md +61 -0
  25. package/docs/server.blocktypeeventpayloads._block_type.entity_collision_.md +19 -0
  26. package/docs/server.blocktypeeventpayloads._block_type.entity_contact_force_.md +17 -0
  27. package/docs/server.blocktypeeventpayloads.md +76 -0
  28. package/docs/server.blocktyperegistry.md +7 -1
  29. package/docs/{server.blocktyperegistryeventtype.md → server.blocktyperegistryevent.md} +4 -4
  30. package/docs/server.blocktyperegistryeventpayloads._block_type_registry.register_block_type_.md +17 -0
  31. package/docs/server.blocktyperegistryeventpayloads.md +57 -0
  32. package/docs/server.chatevent.md +61 -0
  33. package/docs/server.chateventpayloads._chat.broadcast_message_.md +17 -0
  34. package/docs/server.chateventpayloads._chat.player_message_.md +17 -0
  35. package/docs/server.chateventpayloads.md +76 -0
  36. package/docs/server.chatmanager.md +6 -45
  37. package/docs/server.chunk.md +7 -1
  38. package/docs/{server.chunkeventtype.md → server.chunkevent.md} +4 -4
  39. package/docs/server.chunkeventpayloads._chunk.despawn_.md +15 -0
  40. package/docs/server.chunkeventpayloads._chunk.set_block_.md +18 -0
  41. package/docs/server.chunkeventpayloads._chunk.spawn_.md +15 -0
  42. package/docs/server.chunkeventpayloads.md +95 -0
  43. package/docs/server.collider.md +2 -1
  44. package/docs/server.entity.md +4 -133
  45. package/docs/{server.entityeventtype.md → server.entityevent.md} +74 -4
  46. package/docs/server.entityeventpayloads._entity.block_collision_.md +19 -0
  47. package/docs/server.entityeventpayloads._entity.block_contact_force_.md +17 -0
  48. package/docs/server.entityeventpayloads._entity.despawn_.md +15 -0
  49. package/docs/server.entityeventpayloads._entity.entity_collision_.md +19 -0
  50. package/docs/server.entityeventpayloads._entity.entity_contact_force_.md +17 -0
  51. package/docs/server.entityeventpayloads._entity.set_model_animations_playback_rate_.md +16 -0
  52. package/docs/server.entityeventpayloads._entity.set_model_hidden_nodes_.md +16 -0
  53. package/docs/server.entityeventpayloads._entity.set_opacity_.md +16 -0
  54. package/docs/server.entityeventpayloads._entity.set_parent_.md +17 -0
  55. package/docs/server.entityeventpayloads._entity.set_tint_color_.md +16 -0
  56. package/docs/server.entityeventpayloads._entity.spawn_.md +15 -0
  57. package/docs/server.entityeventpayloads._entity.start_model_looped_animations_.md +16 -0
  58. package/docs/server.entityeventpayloads._entity.start_model_oneshot_animations_.md +16 -0
  59. package/docs/server.entityeventpayloads._entity.stop_model_animations_.md +16 -0
  60. package/docs/server.entityeventpayloads._entity.tick_.md +16 -0
  61. package/docs/server.entityeventpayloads._entity.update_position_.md +16 -0
  62. package/docs/server.entityeventpayloads._entity.update_rotation_.md +16 -0
  63. package/docs/server.entityeventpayloads.md +361 -0
  64. package/docs/server.eventpayloads.md +15 -0
  65. package/docs/server.eventrouter.emit.md +4 -4
  66. package/docs/server.eventrouter.emit_1.md +63 -0
  67. package/docs/server.eventrouter.emitwithglobal.md +69 -0
  68. package/docs/server.eventrouter.emitwithglobal_1.md +63 -0
  69. package/docs/server.eventrouter.emitwithworld.md +85 -0
  70. package/docs/server.eventrouter.emitwithworld_1.md +77 -0
  71. package/docs/{server.eventrouter.prependon.md → server.eventrouter.final_1.md} +4 -10
  72. package/docs/server.eventrouter.haslisteners.md +55 -0
  73. package/docs/server.eventrouter.listenercount.md +55 -0
  74. package/docs/server.eventrouter.listeners.md +55 -0
  75. package/docs/server.eventrouter.md +40 -95
  76. package/docs/server.eventrouter.off.md +3 -3
  77. package/docs/{server.eventrouter.prependonce.md → server.eventrouter.off_1.md} +4 -10
  78. package/docs/server.eventrouter.offall.md +4 -4
  79. package/docs/server.eventrouter.on.md +3 -3
  80. package/docs/server.eventrouter.on_1.md +63 -0
  81. package/docs/server.eventrouter.once.md +3 -3
  82. package/docs/server.eventrouter.once_1.md +63 -0
  83. package/docs/{server.gameservereventtype.md → server.gameserverevent.md} +4 -4
  84. package/docs/server.gameservereventpayloads._gameserver.start_.md +15 -0
  85. package/docs/server.gameservereventpayloads._gameserver.stop_.md +15 -0
  86. package/docs/server.gameservereventpayloads.md +76 -0
  87. package/docs/server.light.md +7 -1
  88. package/docs/{server.lighteventtype.md → server.lightevent.md} +4 -18
  89. package/docs/server.lighteventpayloads._light.despawn_.md +15 -0
  90. package/docs/server.lighteventpayloads._light.set_angle_.md +16 -0
  91. package/docs/server.lighteventpayloads._light.set_attached_to_entity_.md +16 -0
  92. package/docs/server.lighteventpayloads._light.set_color_.md +16 -0
  93. package/docs/server.lighteventpayloads._light.set_distance_.md +16 -0
  94. package/docs/server.lighteventpayloads._light.set_intensity_.md +16 -0
  95. package/docs/server.lighteventpayloads._light.set_offset_.md +16 -0
  96. package/docs/server.lighteventpayloads._light.set_penumbra_.md +16 -0
  97. package/docs/server.lighteventpayloads._light.set_position_.md +16 -0
  98. package/docs/server.lighteventpayloads._light.set_tracked_entity_.md +16 -0
  99. package/docs/server.lighteventpayloads._light.set_tracked_position_.md +16 -0
  100. package/docs/server.lighteventpayloads._light.spawn_.md +15 -0
  101. package/docs/server.lighteventpayloads.md +266 -0
  102. package/docs/server.md +201 -84
  103. package/docs/server.player.md +7 -1
  104. package/docs/server.playercamera.md +7 -1
  105. package/docs/{server.playercameraeventtype.md → server.playercameraevent.md} +4 -4
  106. package/docs/server.playercameraeventpayloads._player_camera.look_at_entity_.md +16 -0
  107. package/docs/server.playercameraeventpayloads._player_camera.look_at_position_.md +16 -0
  108. package/docs/server.playercameraeventpayloads._player_camera.set_attached_to_entity_.md +16 -0
  109. package/docs/server.playercameraeventpayloads._player_camera.set_attached_to_position_.md +16 -0
  110. package/docs/server.playercameraeventpayloads._player_camera.set_film_offset_.md +16 -0
  111. package/docs/server.playercameraeventpayloads._player_camera.set_forward_offset_.md +16 -0
  112. package/docs/server.playercameraeventpayloads._player_camera.set_fov_.md +16 -0
  113. package/docs/server.playercameraeventpayloads._player_camera.set_mode_.md +16 -0
  114. package/docs/server.playercameraeventpayloads._player_camera.set_model_hidden_nodes_.md +16 -0
  115. package/docs/server.playercameraeventpayloads._player_camera.set_offset_.md +16 -0
  116. package/docs/server.playercameraeventpayloads._player_camera.set_tracked_entity_.md +16 -0
  117. package/docs/server.playercameraeventpayloads._player_camera.set_tracked_position_.md +16 -0
  118. package/docs/server.playercameraeventpayloads._player_camera.set_zoom_.md +16 -0
  119. package/docs/server.playercameraeventpayloads.md +285 -0
  120. package/docs/{server.playereventtype.md → server.playerevent.md} +4 -4
  121. package/docs/server.playereventpayloads._player.chat_message_send_.md +16 -0
  122. package/docs/server.playereventpayloads._player.joined_world_.md +16 -0
  123. package/docs/server.playereventpayloads._player.left_world_.md +16 -0
  124. package/docs/server.playereventpayloads._player.request_sync_.md +17 -0
  125. package/docs/server.playereventpayloads.md +114 -0
  126. package/docs/server.playermanager.md +4 -0
  127. package/docs/server.playermanagereventpayloads._player_manager.player_connected_.md +15 -0
  128. package/docs/server.playermanagereventpayloads._player_manager.player_disconnected_.md +15 -0
  129. package/docs/server.playermanagereventpayloads.md +76 -0
  130. package/docs/server.playerui.md +6 -1
  131. package/docs/{server.playeruieventtype.md → server.playeruievent.md} +4 -4
  132. package/docs/server.playeruieventpayloads._player_ui.load_.md +16 -0
  133. package/docs/server.playeruieventpayloads._player_ui.lock_pointer_.md +16 -0
  134. package/docs/server.playeruieventpayloads._player_ui.send_data_.md +16 -0
  135. package/docs/server.playeruieventpayloads.md +95 -0
  136. package/docs/server.rigidbody.md +2 -1
  137. package/docs/server.sceneui.md +7 -1
  138. package/docs/server.sceneuievent.md +131 -0
  139. package/docs/server.sceneuieventpayloads._scene_ui.load_.md +15 -0
  140. package/docs/server.sceneuieventpayloads._scene_ui.set_attached_to_entity_.md +16 -0
  141. package/docs/server.sceneuieventpayloads._scene_ui.set_offset_.md +16 -0
  142. package/docs/server.sceneuieventpayloads._scene_ui.set_position_.md +16 -0
  143. package/docs/server.sceneuieventpayloads._scene_ui.set_state_.md +16 -0
  144. package/docs/server.sceneuieventpayloads._scene_ui.set_view_distance_.md +16 -0
  145. package/docs/server.sceneuieventpayloads._scene_ui.unload_.md +15 -0
  146. package/docs/server.sceneuieventpayloads.md +171 -0
  147. package/docs/server.simulation.md +6 -1
  148. package/docs/server.simulationevent.md +89 -0
  149. package/docs/server.simulationeventpayloads._simulation.debug_raycast_.md +19 -0
  150. package/docs/server.simulationeventpayloads._simulation.debug_render_.md +17 -0
  151. package/docs/server.simulationeventpayloads._simulation.step_end_.md +16 -0
  152. package/docs/server.simulationeventpayloads._simulation.step_start_.md +16 -0
  153. package/docs/server.simulationeventpayloads.md +114 -0
  154. package/docs/server.world.md +7 -60
  155. package/docs/server.worldevent.md +131 -0
  156. package/docs/server.worldeventpayloads._world.set_ambient_light_color_.md +16 -0
  157. package/docs/server.worldeventpayloads._world.set_ambient_light_intensity_.md +16 -0
  158. package/docs/server.worldeventpayloads._world.set_directional_light_color_.md +16 -0
  159. package/docs/server.worldeventpayloads._world.set_directional_light_intensity_.md +16 -0
  160. package/docs/server.worldeventpayloads._world.set_directional_light_position_.md +16 -0
  161. package/docs/server.worldeventpayloads._world.start_.md +16 -0
  162. package/docs/server.worldeventpayloads._world.stop_.md +16 -0
  163. package/docs/server.worldeventpayloads.md +171 -0
  164. package/docs/server.worldloop.md +6 -1
  165. package/docs/{server.worldloopeventtype.md → server.worldloopevent.md} +4 -4
  166. package/docs/server.worldloopeventpayloads._world_loop.start_.md +15 -0
  167. package/docs/server.worldloopeventpayloads._world_loop.stop_.md +15 -0
  168. package/docs/server.worldloopeventpayloads._world_loop.tick_end_.md +16 -0
  169. package/docs/server.worldloopeventpayloads._world_loop.tick_error_.md +16 -0
  170. package/docs/server.worldloopeventpayloads._world_loop.tick_start_.md +16 -0
  171. package/docs/server.worldloopeventpayloads.md +133 -0
  172. package/examples/ai-agents/index.ts +9 -13
  173. package/examples/ai-agents/src/BaseAgent.ts +4 -2
  174. package/examples/ai-agents/src/behaviors/FishingBehavior.ts +2 -2
  175. package/examples/ai-agents/src/behaviors/FollowBehavior.ts +3 -3
  176. package/examples/ai-agents/src/behaviors/MiningBehavior.ts +2 -2
  177. package/examples/ai-agents/src/behaviors/PathfindingBehavior.ts +7 -7
  178. package/examples/big-world/index.ts +5 -4
  179. package/examples/block-entity/index.ts +12 -10
  180. package/examples/child-entity/index.ts +5 -4
  181. package/examples/custom-ui/index.ts +5 -4
  182. package/examples/entity-controller/index.ts +5 -4
  183. package/examples/entity-spawn/index.ts +8 -6
  184. package/examples/hole-in-wall-game/index.ts +9 -7
  185. package/examples/lighting/index.ts +5 -4
  186. package/examples/pathfinding/index.ts +5 -4
  187. package/examples/payload-game/index.ts +27 -23
  188. package/examples/wall-dodge-game/index.ts +8 -6
  189. package/examples/zombies-fps/classes/EnemyEntity.ts +10 -4
  190. package/examples/zombies-fps/classes/GamePlayerEntity.ts +7 -2
  191. package/examples/zombies-fps/classes/enemies/RipperEntity.ts +2 -1
  192. package/examples/zombies-fps/index.ts +5 -5
  193. package/package.json +1 -1
  194. package/server.api.json +9422 -7805
  195. package/server.d.ts +748 -472
  196. package/server.js +89 -89
  197. package/docs/server.audioeventpayload.md +0 -118
  198. package/docs/server.audioeventpayload.pause.audio.md +0 -11
  199. package/docs/server.audioeventpayload.pause.md +0 -53
  200. package/docs/server.audioeventpayload.play.audio.md +0 -11
  201. package/docs/server.audioeventpayload.play.md +0 -53
  202. package/docs/server.audioeventpayload.playrestart.audio.md +0 -11
  203. package/docs/server.audioeventpayload.playrestart.md +0 -53
  204. package/docs/server.audioeventpayload.setattachedtoentity.audio.md +0 -11
  205. package/docs/server.audioeventpayload.setattachedtoentity.entity.md +0 -11
  206. package/docs/server.audioeventpayload.setattachedtoentity.md +0 -70
  207. package/docs/server.audioeventpayload.setdetune.audio.md +0 -11
  208. package/docs/server.audioeventpayload.setdetune.detune.md +0 -11
  209. package/docs/server.audioeventpayload.setdetune.md +0 -70
  210. package/docs/server.audioeventpayload.setdistortion.audio.md +0 -11
  211. package/docs/server.audioeventpayload.setdistortion.distortion.md +0 -11
  212. package/docs/server.audioeventpayload.setdistortion.md +0 -70
  213. package/docs/server.audioeventpayload.setplaybackrate.audio.md +0 -11
  214. package/docs/server.audioeventpayload.setplaybackrate.md +0 -70
  215. package/docs/server.audioeventpayload.setplaybackrate.playbackrate.md +0 -11
  216. package/docs/server.audioeventpayload.setposition.audio.md +0 -11
  217. package/docs/server.audioeventpayload.setposition.md +0 -70
  218. package/docs/server.audioeventpayload.setposition.position.md +0 -11
  219. package/docs/server.audioeventpayload.setreferencedistance.audio.md +0 -11
  220. package/docs/server.audioeventpayload.setreferencedistance.md +0 -70
  221. package/docs/server.audioeventpayload.setreferencedistance.referencedistance.md +0 -11
  222. package/docs/server.audioeventpayload.setvolume.audio.md +0 -11
  223. package/docs/server.audioeventpayload.setvolume.md +0 -70
  224. package/docs/server.audioeventpayload.setvolume.volume.md +0 -11
  225. package/docs/server.baseentitycontroller.onattach.md +0 -13
  226. package/docs/server.baseentitycontroller.ondespawn.md +0 -13
  227. package/docs/server.baseentitycontroller.ondetach.md +0 -13
  228. package/docs/server.baseentitycontroller.onspawn.md +0 -13
  229. package/docs/server.baseentitycontroller.ontick.md +0 -13
  230. package/docs/server.baseentitycontroller.ontickwithplayerinput.md +0 -13
  231. package/docs/server.blocktype.onentitycollision.md +0 -18
  232. package/docs/server.blocktype.onentitycontactforce.md +0 -18
  233. package/docs/server.blocktyperegistryeventpayload.md +0 -37
  234. package/docs/server.blocktyperegistryeventpayload.registerblocktype.blocktype.md +0 -11
  235. package/docs/server.blocktyperegistryeventpayload.registerblocktype.blocktyperegistry.md +0 -11
  236. package/docs/server.blocktyperegistryeventpayload.registerblocktype.id.md +0 -11
  237. package/docs/server.blocktyperegistryeventpayload.registerblocktype.md +0 -87
  238. package/docs/server.chateventpayload.md +0 -46
  239. package/docs/server.chateventpayload.sendbroadcastmessage.color.md +0 -11
  240. package/docs/server.chateventpayload.sendbroadcastmessage.md +0 -91
  241. package/docs/server.chateventpayload.sendbroadcastmessage.message.md +0 -11
  242. package/docs/server.chateventpayload.sendbroadcastmessage.playerid.md +0 -11
  243. package/docs/server.chateventpayload.sendplayermessage.color.md +0 -11
  244. package/docs/server.chateventpayload.sendplayermessage.md +0 -89
  245. package/docs/server.chateventpayload.sendplayermessage.message.md +0 -11
  246. package/docs/server.chateventpayload.sendplayermessage.player.md +0 -11
  247. package/docs/server.chateventtype.md +0 -61
  248. package/docs/server.chatmanager.onbroadcastmessage.md +0 -13
  249. package/docs/server.chunkeventpayload.despawn.chunk.md +0 -11
  250. package/docs/server.chunkeventpayload.despawn.md +0 -53
  251. package/docs/server.chunkeventpayload.md +0 -55
  252. package/docs/server.chunkeventpayload.setblock.blocktypeid.md +0 -11
  253. package/docs/server.chunkeventpayload.setblock.chunk.md +0 -11
  254. package/docs/server.chunkeventpayload.setblock.globalcoordinate.md +0 -11
  255. package/docs/server.chunkeventpayload.setblock.localcoordinate.md +0 -11
  256. package/docs/server.chunkeventpayload.setblock.md +0 -104
  257. package/docs/server.chunkeventpayload.spawn.chunk.md +0 -11
  258. package/docs/server.chunkeventpayload.spawn.md +0 -53
  259. package/docs/server.entity.onblockcollision.md +0 -18
  260. package/docs/server.entity.onblockcontactforce.md +0 -18
  261. package/docs/server.entity.ondespawn.md +0 -13
  262. package/docs/server.entity.onentitycollision.md +0 -18
  263. package/docs/server.entity.onentitycontactforce.md +0 -18
  264. package/docs/server.entity.onspawn.md +0 -13
  265. package/docs/server.entity.ontick.md +0 -13
  266. package/docs/server.entityeventpayload.despawn.entity.md +0 -11
  267. package/docs/server.entityeventpayload.despawn.md +0 -53
  268. package/docs/server.entityeventpayload.md +0 -136
  269. package/docs/server.entityeventpayload.setmodelanimationsplaybackrate.entity.md +0 -11
  270. package/docs/server.entityeventpayload.setmodelanimationsplaybackrate.md +0 -70
  271. package/docs/server.entityeventpayload.setmodelanimationsplaybackrate.playbackrate.md +0 -11
  272. package/docs/server.entityeventpayload.setmodelhiddennodes.entity.md +0 -11
  273. package/docs/server.entityeventpayload.setmodelhiddennodes.md +0 -70
  274. package/docs/server.entityeventpayload.setmodelhiddennodes.modelhiddennodes.md +0 -11
  275. package/docs/server.entityeventpayload.setopacity.entity.md +0 -11
  276. package/docs/server.entityeventpayload.setopacity.md +0 -70
  277. package/docs/server.entityeventpayload.setopacity.opacity.md +0 -11
  278. package/docs/server.entityeventpayload.setparent.entity.md +0 -11
  279. package/docs/server.entityeventpayload.setparent.md +0 -87
  280. package/docs/server.entityeventpayload.setparent.parent.md +0 -11
  281. package/docs/server.entityeventpayload.setparent.parentnodename.md +0 -11
  282. package/docs/server.entityeventpayload.settintcolor.entity.md +0 -11
  283. package/docs/server.entityeventpayload.settintcolor.md +0 -70
  284. package/docs/server.entityeventpayload.settintcolor.tintcolor.md +0 -11
  285. package/docs/server.entityeventpayload.spawn.entity.md +0 -11
  286. package/docs/server.entityeventpayload.spawn.md +0 -53
  287. package/docs/server.entityeventpayload.startmodelloopedanimations.animations.md +0 -11
  288. package/docs/server.entityeventpayload.startmodelloopedanimations.entity.md +0 -11
  289. package/docs/server.entityeventpayload.startmodelloopedanimations.md +0 -70
  290. package/docs/server.entityeventpayload.startmodeloneshotanimations.animations.md +0 -11
  291. package/docs/server.entityeventpayload.startmodeloneshotanimations.entity.md +0 -11
  292. package/docs/server.entityeventpayload.startmodeloneshotanimations.md +0 -70
  293. package/docs/server.entityeventpayload.stopmodelanimations.animations.md +0 -11
  294. package/docs/server.entityeventpayload.stopmodelanimations.entity.md +0 -11
  295. package/docs/server.entityeventpayload.stopmodelanimations.md +0 -70
  296. package/docs/server.entityeventpayload.updateposition.entity.md +0 -11
  297. package/docs/server.entityeventpayload.updateposition.md +0 -70
  298. package/docs/server.entityeventpayload.updateposition.position.md +0 -11
  299. package/docs/server.entityeventpayload.updaterotation.entity.md +0 -11
  300. package/docs/server.entityeventpayload.updaterotation.md +0 -70
  301. package/docs/server.entityeventpayload.updaterotation.rotation.md +0 -11
  302. package/docs/server.eventrouter._constructor_.md +0 -49
  303. package/docs/server.eventrouter.logallevents.md +0 -13
  304. package/docs/server.eventrouter.logeventspayloads.md +0 -13
  305. package/docs/server.eventrouter.logignoreeventprefixes.md +0 -13
  306. package/docs/server.eventrouter.logignoreevents.md +0 -13
  307. package/docs/server.eventrouter.logunlistenedevents.md +0 -13
  308. package/docs/server.eventrouter.serverinstance.md +0 -13
  309. package/docs/server.gameservereventpayload.md +0 -46
  310. package/docs/server.gameservereventpayload.start.md +0 -53
  311. package/docs/server.gameservereventpayload.start.startedatms.md +0 -11
  312. package/docs/server.gameservereventpayload.stop.md +0 -53
  313. package/docs/server.gameservereventpayload.stop.stoppedatms.md +0 -11
  314. package/docs/server.lighteventpayload.despawn.light.md +0 -11
  315. package/docs/server.lighteventpayload.despawn.md +0 -53
  316. package/docs/server.lighteventpayload.md +0 -136
  317. package/docs/server.lighteventpayload.setangle.angle.md +0 -11
  318. package/docs/server.lighteventpayload.setangle.light.md +0 -11
  319. package/docs/server.lighteventpayload.setangle.md +0 -70
  320. package/docs/server.lighteventpayload.setattachedtoentity.entity.md +0 -11
  321. package/docs/server.lighteventpayload.setattachedtoentity.light.md +0 -11
  322. package/docs/server.lighteventpayload.setattachedtoentity.md +0 -70
  323. package/docs/server.lighteventpayload.setcolor.color.md +0 -11
  324. package/docs/server.lighteventpayload.setcolor.light.md +0 -11
  325. package/docs/server.lighteventpayload.setcolor.md +0 -70
  326. package/docs/server.lighteventpayload.setdistance.distance.md +0 -11
  327. package/docs/server.lighteventpayload.setdistance.light.md +0 -11
  328. package/docs/server.lighteventpayload.setdistance.md +0 -70
  329. package/docs/server.lighteventpayload.setintensity.intensity.md +0 -11
  330. package/docs/server.lighteventpayload.setintensity.light.md +0 -11
  331. package/docs/server.lighteventpayload.setintensity.md +0 -70
  332. package/docs/server.lighteventpayload.setoffset.light.md +0 -11
  333. package/docs/server.lighteventpayload.setoffset.md +0 -70
  334. package/docs/server.lighteventpayload.setoffset.offset.md +0 -11
  335. package/docs/server.lighteventpayload.setpenumbra.light.md +0 -11
  336. package/docs/server.lighteventpayload.setpenumbra.md +0 -70
  337. package/docs/server.lighteventpayload.setpenumbra.penumbra.md +0 -11
  338. package/docs/server.lighteventpayload.setposition.light.md +0 -11
  339. package/docs/server.lighteventpayload.setposition.md +0 -70
  340. package/docs/server.lighteventpayload.setposition.position.md +0 -11
  341. package/docs/server.lighteventpayload.settrackedentity.entity.md +0 -11
  342. package/docs/server.lighteventpayload.settrackedentity.light.md +0 -11
  343. package/docs/server.lighteventpayload.settrackedentity.md +0 -70
  344. package/docs/server.lighteventpayload.settrackedposition.light.md +0 -11
  345. package/docs/server.lighteventpayload.settrackedposition.md +0 -70
  346. package/docs/server.lighteventpayload.settrackedposition.position.md +0 -11
  347. package/docs/server.lighteventpayload.spawn.light.md +0 -11
  348. package/docs/server.lighteventpayload.spawn.md +0 -53
  349. package/docs/server.playercameraeventpayload.lookatentity.entity.md +0 -11
  350. package/docs/server.playercameraeventpayload.lookatentity.md +0 -70
  351. package/docs/server.playercameraeventpayload.lookatentity.playercamera.md +0 -11
  352. package/docs/server.playercameraeventpayload.lookatposition.md +0 -70
  353. package/docs/server.playercameraeventpayload.lookatposition.playercamera.md +0 -11
  354. package/docs/server.playercameraeventpayload.lookatposition.position.md +0 -11
  355. package/docs/server.playercameraeventpayload.md +0 -145
  356. package/docs/server.playercameraeventpayload.setattachedtoentity.entity.md +0 -11
  357. package/docs/server.playercameraeventpayload.setattachedtoentity.md +0 -70
  358. package/docs/server.playercameraeventpayload.setattachedtoentity.playercamera.md +0 -11
  359. package/docs/server.playercameraeventpayload.setattachedtoposition.md +0 -70
  360. package/docs/server.playercameraeventpayload.setattachedtoposition.playercamera.md +0 -11
  361. package/docs/server.playercameraeventpayload.setattachedtoposition.position.md +0 -11
  362. package/docs/server.playercameraeventpayload.setfilmoffset.filmoffset.md +0 -11
  363. package/docs/server.playercameraeventpayload.setfilmoffset.md +0 -70
  364. package/docs/server.playercameraeventpayload.setfilmoffset.playercamera.md +0 -11
  365. package/docs/server.playercameraeventpayload.setforwardoffset.forwardoffset.md +0 -11
  366. package/docs/server.playercameraeventpayload.setforwardoffset.md +0 -70
  367. package/docs/server.playercameraeventpayload.setforwardoffset.playercamera.md +0 -11
  368. package/docs/server.playercameraeventpayload.setfov.fov.md +0 -11
  369. package/docs/server.playercameraeventpayload.setfov.md +0 -70
  370. package/docs/server.playercameraeventpayload.setfov.playercamera.md +0 -11
  371. package/docs/server.playercameraeventpayload.setmode.md +0 -70
  372. package/docs/server.playercameraeventpayload.setmode.mode.md +0 -11
  373. package/docs/server.playercameraeventpayload.setmode.playercamera.md +0 -11
  374. package/docs/server.playercameraeventpayload.setmodelhiddennodes.md +0 -70
  375. package/docs/server.playercameraeventpayload.setmodelhiddennodes.modelhiddennodes.md +0 -11
  376. package/docs/server.playercameraeventpayload.setmodelhiddennodes.playercamera.md +0 -11
  377. package/docs/server.playercameraeventpayload.setoffset.md +0 -70
  378. package/docs/server.playercameraeventpayload.setoffset.offset.md +0 -11
  379. package/docs/server.playercameraeventpayload.setoffset.playercamera.md +0 -11
  380. package/docs/server.playercameraeventpayload.settrackedentity.entity.md +0 -11
  381. package/docs/server.playercameraeventpayload.settrackedentity.md +0 -70
  382. package/docs/server.playercameraeventpayload.settrackedentity.playercamera.md +0 -11
  383. package/docs/server.playercameraeventpayload.settrackedposition.md +0 -70
  384. package/docs/server.playercameraeventpayload.settrackedposition.playercamera.md +0 -11
  385. package/docs/server.playercameraeventpayload.settrackedposition.position.md +0 -11
  386. package/docs/server.playercameraeventpayload.setzoom.md +0 -70
  387. package/docs/server.playercameraeventpayload.setzoom.playercamera.md +0 -11
  388. package/docs/server.playercameraeventpayload.setzoom.zoom.md +0 -11
  389. package/docs/server.playereventpayload.chatmessagesend.md +0 -70
  390. package/docs/server.playereventpayload.chatmessagesend.message.md +0 -11
  391. package/docs/server.playereventpayload.chatmessagesend.player.md +0 -11
  392. package/docs/server.playereventpayload.joinedworld.md +0 -70
  393. package/docs/server.playereventpayload.joinedworld.player.md +0 -11
  394. package/docs/server.playereventpayload.joinedworld.world.md +0 -11
  395. package/docs/server.playereventpayload.leftworld.md +0 -70
  396. package/docs/server.playereventpayload.leftworld.player.md +0 -11
  397. package/docs/server.playereventpayload.leftworld.world.md +0 -11
  398. package/docs/server.playereventpayload.md +0 -64
  399. package/docs/server.playereventpayload.requestsync.md +0 -87
  400. package/docs/server.playereventpayload.requestsync.player.md +0 -11
  401. package/docs/server.playereventpayload.requestsync.receivedat.md +0 -11
  402. package/docs/server.playereventpayload.requestsync.receivedatms.md +0 -11
  403. package/docs/server.playeruieventpayload.load.htmluri.md +0 -11
  404. package/docs/server.playeruieventpayload.load.md +0 -70
  405. package/docs/server.playeruieventpayload.load.playerui.md +0 -11
  406. package/docs/server.playeruieventpayload.lockpointer.lock.md +0 -11
  407. package/docs/server.playeruieventpayload.lockpointer.md +0 -70
  408. package/docs/server.playeruieventpayload.lockpointer.playerui.md +0 -11
  409. package/docs/server.playeruieventpayload.md +0 -55
  410. package/docs/server.playeruieventpayload.senddata.data.md +0 -11
  411. package/docs/server.playeruieventpayload.senddata.md +0 -70
  412. package/docs/server.playeruieventpayload.senddata.playerui.md +0 -11
  413. package/docs/server.world.eventrouter.md +0 -13
  414. package/docs/server.world.onplayerjoin.md +0 -13
  415. package/docs/server.world.onplayerleave.md +0 -13
  416. package/docs/server.worldloopeventpayload.md +0 -73
  417. package/docs/server.worldloopeventpayload.start.md +0 -53
  418. package/docs/server.worldloopeventpayload.start.worldloop.md +0 -11
  419. package/docs/server.worldloopeventpayload.stop.md +0 -53
  420. package/docs/server.worldloopeventpayload.stop.worldloop.md +0 -11
  421. package/docs/server.worldloopeventpayload.tickend.md +0 -70
  422. package/docs/server.worldloopeventpayload.tickend.tickdurationms.md +0 -11
  423. package/docs/server.worldloopeventpayload.tickend.worldloop.md +0 -11
  424. package/docs/server.worldloopeventpayload.tickerror.error.md +0 -11
  425. package/docs/server.worldloopeventpayload.tickerror.md +0 -70
  426. package/docs/server.worldloopeventpayload.tickerror.worldloop.md +0 -11
  427. package/docs/server.worldloopeventpayload.tickstart.md +0 -70
  428. package/docs/server.worldloopeventpayload.tickstart.tickdeltams.md +0 -11
  429. package/docs/server.worldloopeventpayload.tickstart.worldloop.md +0 -11
@@ -0,0 +1,114 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEventPayloads](./server.playereventpayloads.md)
4
+
5
+ ## PlayerEventPayloads interface
6
+
7
+ Event payloads for Player emitted events.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface PlayerEventPayloads
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Property
20
+
21
+
22
+ </th><th>
23
+
24
+ Modifiers
25
+
26
+
27
+ </th><th>
28
+
29
+ Type
30
+
31
+
32
+ </th><th>
33
+
34
+ Description
35
+
36
+
37
+ </th></tr></thead>
38
+ <tbody><tr><td>
39
+
40
+ ["PLAYER.CHAT\_MESSAGE\_SEND"](./server.playereventpayloads._player.chat_message_send_.md)
41
+
42
+
43
+ </td><td>
44
+
45
+
46
+ </td><td>
47
+
48
+ { player: [Player](./server.player.md)<!-- -->; message: string; }
49
+
50
+
51
+ </td><td>
52
+
53
+ Emitted when a player sends a chat message.
54
+
55
+
56
+ </td></tr>
57
+ <tr><td>
58
+
59
+ ["PLAYER.JOINED\_WORLD"](./server.playereventpayloads._player.joined_world_.md)
60
+
61
+
62
+ </td><td>
63
+
64
+
65
+ </td><td>
66
+
67
+ { player: [Player](./server.player.md)<!-- -->; world: [World](./server.world.md)<!-- -->; }
68
+
69
+
70
+ </td><td>
71
+
72
+ Emitted when a player joins a world.
73
+
74
+
75
+ </td></tr>
76
+ <tr><td>
77
+
78
+ ["PLAYER.LEFT\_WORLD"](./server.playereventpayloads._player.left_world_.md)
79
+
80
+
81
+ </td><td>
82
+
83
+
84
+ </td><td>
85
+
86
+ { player: [Player](./server.player.md)<!-- -->; world: [World](./server.world.md)<!-- -->; }
87
+
88
+
89
+ </td><td>
90
+
91
+ Emitted when a player leaves a world.
92
+
93
+
94
+ </td></tr>
95
+ <tr><td>
96
+
97
+ ["PLAYER.REQUEST\_SYNC"](./server.playereventpayloads._player.request_sync_.md)
98
+
99
+
100
+ </td><td>
101
+
102
+
103
+ </td><td>
104
+
105
+ { player: [Player](./server.player.md)<!-- -->; receivedAt: number; receivedAtMs: number; }
106
+
107
+
108
+ </td><td>
109
+
110
+ Emitted when a player's client requests a round trip time synchronization.
111
+
112
+
113
+ </td></tr>
114
+ </tbody></table>
@@ -16,6 +16,10 @@ export default class PlayerManager
16
16
 
17
17
  The PlayerManager is created internally as a global singleton accessible with the static property `PlayerManager.instance`<!-- -->.
18
18
 
19
+ <h2>Events</h2>
20
+
21
+ This class is an EventRouter, and instances of it emit events with payloads listed under [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md)
22
+
19
23
  The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlayerManager` class.
20
24
 
21
25
  ## Example
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md) &gt; ["PLAYER\_MANAGER.PLAYER\_CONNECTED"](./server.playermanagereventpayloads._player_manager.player_connected_.md)
4
+
5
+ ## PlayerManagerEventPayloads."PLAYER\_MANAGER.PLAYER\_CONNECTED" property
6
+
7
+ Emitted when a player connects to the server.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ [PlayerManagerEvent.PLAYER_CONNECTED]: {
13
+ player: Player;
14
+ };
15
+ ```
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md) &gt; ["PLAYER\_MANAGER.PLAYER\_DISCONNECTED"](./server.playermanagereventpayloads._player_manager.player_disconnected_.md)
4
+
5
+ ## PlayerManagerEventPayloads."PLAYER\_MANAGER.PLAYER\_DISCONNECTED" property
6
+
7
+ Emitted when a player disconnects from the server.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ [PlayerManagerEvent.PLAYER_DISCONNECTED]: {
13
+ player: Player;
14
+ };
15
+ ```
@@ -0,0 +1,76 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md)
4
+
5
+ ## PlayerManagerEventPayloads interface
6
+
7
+ Event payloads for PlayerManager emitted events.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface PlayerManagerEventPayloads
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Property
20
+
21
+
22
+ </th><th>
23
+
24
+ Modifiers
25
+
26
+
27
+ </th><th>
28
+
29
+ Type
30
+
31
+
32
+ </th><th>
33
+
34
+ Description
35
+
36
+
37
+ </th></tr></thead>
38
+ <tbody><tr><td>
39
+
40
+ ["PLAYER\_MANAGER.PLAYER\_CONNECTED"](./server.playermanagereventpayloads._player_manager.player_connected_.md)
41
+
42
+
43
+ </td><td>
44
+
45
+
46
+ </td><td>
47
+
48
+ { player: [Player](./server.player.md)<!-- -->; }
49
+
50
+
51
+ </td><td>
52
+
53
+ Emitted when a player connects to the server.
54
+
55
+
56
+ </td></tr>
57
+ <tr><td>
58
+
59
+ ["PLAYER\_MANAGER.PLAYER\_DISCONNECTED"](./server.playermanagereventpayloads._player_manager.player_disconnected_.md)
60
+
61
+
62
+ </td><td>
63
+
64
+
65
+ </td><td>
66
+
67
+ { player: [Player](./server.player.md)<!-- -->; }
68
+
69
+
70
+ </td><td>
71
+
72
+ Emitted when a player disconnects from the server.
73
+
74
+
75
+ </td></tr>
76
+ </tbody></table>
@@ -9,13 +9,18 @@ The UI for a player.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- export default class PlayerUI
12
+ export default class PlayerUI extends EventRouter
13
13
  ```
14
+ **Extends:** [EventRouter](./server.eventrouter.md)
14
15
 
15
16
  ## Remarks
16
17
 
17
18
  UI allows control of all in-game overlays a player sees. UI is controlled by HTML, CSS and JavaScript files you provide in your `assets` folder.
18
19
 
20
+ <h2>Events</h2>
21
+
22
+ This class is an EventRouter, and instances of it emit events with payloads listed under [PlayerUIEventPayloads](./server.playeruieventpayloads.md)
23
+
19
24
  The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlayerUI` class.
20
25
 
21
26
  ## Properties
@@ -1,15 +1,15 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventType](./server.playeruieventtype.md)
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEvent](./server.playeruievent.md)
4
4
 
5
- ## PlayerUIEventType enum
5
+ ## PlayerUIEvent enum
6
6
 
7
- Event types a PlayerUI can emit.
7
+ Event types a PlayerUI can emit. See [PlayerUIEventPayloads](./server.playeruieventpayloads.md) for the payloads.
8
8
 
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- export declare enum PlayerUIEventType
12
+ export declare enum PlayerUIEvent
13
13
  ```
14
14
 
15
15
  ## Enumeration Members
@@ -0,0 +1,16 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventPayloads](./server.playeruieventpayloads.md) &gt; ["PLAYER\_UI.LOAD"](./server.playeruieventpayloads._player_ui.load_.md)
4
+
5
+ ## PlayerUIEventPayloads."PLAYER\_UI.LOAD" property
6
+
7
+ Emitted when the player's client UI is loaded.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ [PlayerUIEvent.LOAD]: {
13
+ playerUI: PlayerUI;
14
+ htmlUri: string;
15
+ };
16
+ ```
@@ -0,0 +1,16 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventPayloads](./server.playeruieventpayloads.md) &gt; ["PLAYER\_UI.LOCK\_POINTER"](./server.playeruieventpayloads._player_ui.lock_pointer_.md)
4
+
5
+ ## PlayerUIEventPayloads."PLAYER\_UI.LOCK\_POINTER" property
6
+
7
+ Emitted when the player's mouse pointer is locked or unlocked.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ [PlayerUIEvent.LOCK_POINTER]: {
13
+ playerUI: PlayerUI;
14
+ lock: boolean;
15
+ };
16
+ ```
@@ -0,0 +1,16 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventPayloads](./server.playeruieventpayloads.md) &gt; ["PLAYER\_UI.SEND\_DATA"](./server.playeruieventpayloads._player_ui.send_data_.md)
4
+
5
+ ## PlayerUIEventPayloads."PLAYER\_UI.SEND\_DATA" property
6
+
7
+ Emitted when the player's client UI sends data to the server.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ [PlayerUIEvent.SEND_DATA]: {
13
+ playerUI: PlayerUI;
14
+ data: object;
15
+ };
16
+ ```
@@ -0,0 +1,95 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventPayloads](./server.playeruieventpayloads.md)
4
+
5
+ ## PlayerUIEventPayloads interface
6
+
7
+ Event payloads for PlayerUI emitted events.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface PlayerUIEventPayloads
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Property
20
+
21
+
22
+ </th><th>
23
+
24
+ Modifiers
25
+
26
+
27
+ </th><th>
28
+
29
+ Type
30
+
31
+
32
+ </th><th>
33
+
34
+ Description
35
+
36
+
37
+ </th></tr></thead>
38
+ <tbody><tr><td>
39
+
40
+ ["PLAYER\_UI.LOAD"](./server.playeruieventpayloads._player_ui.load_.md)
41
+
42
+
43
+ </td><td>
44
+
45
+
46
+ </td><td>
47
+
48
+ { playerUI: [PlayerUI](./server.playerui.md)<!-- -->; htmlUri: string; }
49
+
50
+
51
+ </td><td>
52
+
53
+ Emitted when the player's client UI is loaded.
54
+
55
+
56
+ </td></tr>
57
+ <tr><td>
58
+
59
+ ["PLAYER\_UI.LOCK\_POINTER"](./server.playeruieventpayloads._player_ui.lock_pointer_.md)
60
+
61
+
62
+ </td><td>
63
+
64
+
65
+ </td><td>
66
+
67
+ { playerUI: [PlayerUI](./server.playerui.md)<!-- -->; lock: boolean; }
68
+
69
+
70
+ </td><td>
71
+
72
+ Emitted when the player's mouse pointer is locked or unlocked.
73
+
74
+
75
+ </td></tr>
76
+ <tr><td>
77
+
78
+ ["PLAYER\_UI.SEND\_DATA"](./server.playeruieventpayloads._player_ui.send_data_.md)
79
+
80
+
81
+ </td><td>
82
+
83
+
84
+ </td><td>
85
+
86
+ { playerUI: [PlayerUI](./server.playerui.md)<!-- -->; data: object; }
87
+
88
+
89
+ </td><td>
90
+
91
+ Emitted when the player's client UI sends data to the server.
92
+
93
+
94
+ </td></tr>
95
+ </tbody></table>
@@ -9,8 +9,9 @@ Represents a rigid body in a world's physics simulation.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- export default class RigidBody
12
+ export default class RigidBody extends EventRouter
13
13
  ```
14
+ **Extends:** [EventRouter](./server.eventrouter.md)
14
15
 
15
16
  ## Remarks
16
17
 
@@ -9,14 +9,20 @@ UI rendered within the 3D space of a world's game scene.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- export default class SceneUI implements protocol.Serializable
12
+ export default class SceneUI extends EventRouter implements protocol.Serializable
13
13
  ```
14
+ **Extends:** [EventRouter](./server.eventrouter.md)
15
+
14
16
  **Implements:** protocol.Serializable
15
17
 
16
18
  ## Remarks
17
19
 
18
20
  SceneUI instances are created directly as instances. They support a variety of configuration options through the [SceneUIOptions](./server.sceneuioptions.md) constructor argument.
19
21
 
22
+ <h2>Events</h2>
23
+
24
+ This class is an EventRouter, and instances of it emit events with payloads listed under [SceneUIEventPayloads](./server.sceneuieventpayloads.md)
25
+
20
26
  ## Example
21
27
 
22
28
 
@@ -0,0 +1,131 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [SceneUIEvent](./server.sceneuievent.md)
4
+
5
+ ## SceneUIEvent enum
6
+
7
+ Event types a SceneUI instance can emit. See [SceneUIEventPayloads](./server.sceneuieventpayloads.md) for the payloads.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare enum SceneUIEvent
13
+ ```
14
+
15
+ ## Enumeration Members
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Member
20
+
21
+
22
+ </th><th>
23
+
24
+ Value
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ LOAD
36
+
37
+
38
+ </td><td>
39
+
40
+ `"SCENE_UI.LOAD"`
41
+
42
+
43
+ </td><td>
44
+
45
+
46
+ </td></tr>
47
+ <tr><td>
48
+
49
+ SET\_ATTACHED\_TO\_ENTITY
50
+
51
+
52
+ </td><td>
53
+
54
+ `"SCENE_UI.SET_ATTACHED_TO_ENTITY"`
55
+
56
+
57
+ </td><td>
58
+
59
+
60
+ </td></tr>
61
+ <tr><td>
62
+
63
+ SET\_OFFSET
64
+
65
+
66
+ </td><td>
67
+
68
+ `"SCENE_UI.SET_OFFSET"`
69
+
70
+
71
+ </td><td>
72
+
73
+
74
+ </td></tr>
75
+ <tr><td>
76
+
77
+ SET\_POSITION
78
+
79
+
80
+ </td><td>
81
+
82
+ `"SCENE_UI.SET_POSITION"`
83
+
84
+
85
+ </td><td>
86
+
87
+
88
+ </td></tr>
89
+ <tr><td>
90
+
91
+ SET\_STATE
92
+
93
+
94
+ </td><td>
95
+
96
+ `"SCENE_UI.SET_STATE"`
97
+
98
+
99
+ </td><td>
100
+
101
+
102
+ </td></tr>
103
+ <tr><td>
104
+
105
+ SET\_VIEW\_DISTANCE
106
+
107
+
108
+ </td><td>
109
+
110
+ `"SCENE_UI.SET_VIEW_DISTANCE"`
111
+
112
+
113
+ </td><td>
114
+
115
+
116
+ </td></tr>
117
+ <tr><td>
118
+
119
+ UNLOAD
120
+
121
+
122
+ </td><td>
123
+
124
+ `"SCENE_UI.UNLOAD"`
125
+
126
+
127
+ </td><td>
128
+
129
+
130
+ </td></tr>
131
+ </tbody></table>
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [SceneUIEventPayloads](./server.sceneuieventpayloads.md) &gt; ["SCENE\_UI.LOAD"](./server.sceneuieventpayloads._scene_ui.load_.md)
4
+
5
+ ## SceneUIEventPayloads."SCENE\_UI.LOAD" property
6
+
7
+ Emitted when a SceneUI is loaded into the world.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ [SceneUIEvent.LOAD]: {
13
+ sceneUI: SceneUI;
14
+ };
15
+ ```
@@ -0,0 +1,16 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [SceneUIEventPayloads](./server.sceneuieventpayloads.md) &gt; ["SCENE\_UI.SET\_ATTACHED\_TO\_ENTITY"](./server.sceneuieventpayloads._scene_ui.set_attached_to_entity_.md)
4
+
5
+ ## SceneUIEventPayloads."SCENE\_UI.SET\_ATTACHED\_TO\_ENTITY" property
6
+
7
+ Emitted when a SceneUI is attached to an entity.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ [SceneUIEvent.SET_ATTACHED_TO_ENTITY]: {
13
+ sceneUI: SceneUI;
14
+ entity: Entity;
15
+ };
16
+ ```
@@ -0,0 +1,16 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [SceneUIEventPayloads](./server.sceneuieventpayloads.md) &gt; ["SCENE\_UI.SET\_OFFSET"](./server.sceneuieventpayloads._scene_ui.set_offset_.md)
4
+
5
+ ## SceneUIEventPayloads."SCENE\_UI.SET\_OFFSET" property
6
+
7
+ Emitted when the offset of a SceneUI is set.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ [SceneUIEvent.SET_OFFSET]: {
13
+ sceneUI: SceneUI;
14
+ offset: Vector3Like;
15
+ };
16
+ ```
@@ -0,0 +1,16 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [SceneUIEventPayloads](./server.sceneuieventpayloads.md) &gt; ["SCENE\_UI.SET\_POSITION"](./server.sceneuieventpayloads._scene_ui.set_position_.md)
4
+
5
+ ## SceneUIEventPayloads."SCENE\_UI.SET\_POSITION" property
6
+
7
+ Emitted when the position of a SceneUI is set.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ [SceneUIEvent.SET_POSITION]: {
13
+ sceneUI: SceneUI;
14
+ position: Vector3Like;
15
+ };
16
+ ```
@@ -0,0 +1,16 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [SceneUIEventPayloads](./server.sceneuieventpayloads.md) &gt; ["SCENE\_UI.SET\_STATE"](./server.sceneuieventpayloads._scene_ui.set_state_.md)
4
+
5
+ ## SceneUIEventPayloads."SCENE\_UI.SET\_STATE" property
6
+
7
+ Emitted when the state of a SceneUI is set.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ [SceneUIEvent.SET_STATE]: {
13
+ sceneUI: SceneUI;
14
+ state: object;
15
+ };
16
+ ```
@@ -0,0 +1,16 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [SceneUIEventPayloads](./server.sceneuieventpayloads.md) &gt; ["SCENE\_UI.SET\_VIEW\_DISTANCE"](./server.sceneuieventpayloads._scene_ui.set_view_distance_.md)
4
+
5
+ ## SceneUIEventPayloads."SCENE\_UI.SET\_VIEW\_DISTANCE" property
6
+
7
+ Emitted when the view distance of a SceneUI is set.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ [SceneUIEvent.SET_VIEW_DISTANCE]: {
13
+ sceneUI: SceneUI;
14
+ viewDistance: number;
15
+ };
16
+ ```