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.
- package/docs/server.audio.md +7 -1
- package/docs/{server.audioeventtype.md → server.audioevent.md} +4 -4
- package/docs/server.audioeventpayloads._audio.pause_.md +15 -0
- package/docs/server.audioeventpayloads._audio.play_.md +15 -0
- package/docs/server.audioeventpayloads._audio.play_restart_.md +15 -0
- package/docs/server.audioeventpayloads._audio.set_attached_to_entity_.md +16 -0
- package/docs/server.audioeventpayloads._audio.set_detune_.md +16 -0
- package/docs/server.audioeventpayloads._audio.set_distortion_.md +16 -0
- package/docs/server.audioeventpayloads._audio.set_playback_rate_.md +16 -0
- package/docs/server.audioeventpayloads._audio.set_position_.md +16 -0
- package/docs/server.audioeventpayloads._audio.set_reference_distance_.md +16 -0
- package/docs/server.audioeventpayloads._audio.set_volume_.md +16 -0
- package/docs/server.audioeventpayloads.md +228 -0
- package/docs/server.baseentitycontroller.md +4 -138
- package/docs/server.baseentitycontrollerevent.md +117 -0
- package/docs/server.baseentitycontrollereventpayloads.attach.md +15 -0
- package/docs/server.baseentitycontrollereventpayloads.despawn.md +15 -0
- package/docs/server.baseentitycontrollereventpayloads.detach.md +15 -0
- package/docs/server.baseentitycontrollereventpayloads.md +152 -0
- package/docs/server.baseentitycontrollereventpayloads.spawn.md +15 -0
- package/docs/server.baseentitycontrollereventpayloads.tick.md +16 -0
- package/docs/server.baseentitycontrollereventpayloads.tickwithplayerinput.md +18 -0
- package/docs/server.blocktype.md +7 -39
- package/docs/server.blocktypeevent.md +61 -0
- package/docs/server.blocktypeeventpayloads._block_type.entity_collision_.md +19 -0
- package/docs/server.blocktypeeventpayloads._block_type.entity_contact_force_.md +17 -0
- package/docs/server.blocktypeeventpayloads.md +76 -0
- package/docs/server.blocktyperegistry.md +7 -1
- package/docs/{server.blocktyperegistryeventtype.md → server.blocktyperegistryevent.md} +4 -4
- package/docs/server.blocktyperegistryeventpayloads._block_type_registry.register_block_type_.md +17 -0
- package/docs/server.blocktyperegistryeventpayloads.md +57 -0
- package/docs/server.chatevent.md +61 -0
- package/docs/server.chateventpayloads._chat.broadcast_message_.md +17 -0
- package/docs/server.chateventpayloads._chat.player_message_.md +17 -0
- package/docs/server.chateventpayloads.md +76 -0
- package/docs/server.chatmanager.md +6 -45
- package/docs/server.chunk.md +7 -1
- package/docs/{server.chunkeventtype.md → server.chunkevent.md} +4 -4
- package/docs/server.chunkeventpayloads._chunk.despawn_.md +15 -0
- package/docs/server.chunkeventpayloads._chunk.set_block_.md +18 -0
- package/docs/server.chunkeventpayloads._chunk.spawn_.md +15 -0
- package/docs/server.chunkeventpayloads.md +95 -0
- package/docs/server.collider.md +2 -1
- package/docs/server.entity.md +4 -133
- package/docs/{server.entityeventtype.md → server.entityevent.md} +74 -4
- package/docs/server.entityeventpayloads._entity.block_collision_.md +19 -0
- package/docs/server.entityeventpayloads._entity.block_contact_force_.md +17 -0
- package/docs/server.entityeventpayloads._entity.despawn_.md +15 -0
- package/docs/server.entityeventpayloads._entity.entity_collision_.md +19 -0
- package/docs/server.entityeventpayloads._entity.entity_contact_force_.md +17 -0
- package/docs/server.entityeventpayloads._entity.set_model_animations_playback_rate_.md +16 -0
- package/docs/server.entityeventpayloads._entity.set_model_hidden_nodes_.md +16 -0
- package/docs/server.entityeventpayloads._entity.set_opacity_.md +16 -0
- package/docs/server.entityeventpayloads._entity.set_parent_.md +17 -0
- package/docs/server.entityeventpayloads._entity.set_tint_color_.md +16 -0
- package/docs/server.entityeventpayloads._entity.spawn_.md +15 -0
- package/docs/server.entityeventpayloads._entity.start_model_looped_animations_.md +16 -0
- package/docs/server.entityeventpayloads._entity.start_model_oneshot_animations_.md +16 -0
- package/docs/server.entityeventpayloads._entity.stop_model_animations_.md +16 -0
- package/docs/server.entityeventpayloads._entity.tick_.md +16 -0
- package/docs/server.entityeventpayloads._entity.update_position_.md +16 -0
- package/docs/server.entityeventpayloads._entity.update_rotation_.md +16 -0
- package/docs/server.entityeventpayloads.md +361 -0
- package/docs/server.eventpayloads.md +15 -0
- package/docs/server.eventrouter.emit.md +4 -4
- package/docs/server.eventrouter.emit_1.md +63 -0
- package/docs/server.eventrouter.emitwithglobal.md +69 -0
- package/docs/server.eventrouter.emitwithglobal_1.md +63 -0
- package/docs/server.eventrouter.emitwithworld.md +85 -0
- package/docs/server.eventrouter.emitwithworld_1.md +77 -0
- package/docs/{server.eventrouter.prependon.md → server.eventrouter.final_1.md} +4 -10
- package/docs/server.eventrouter.haslisteners.md +55 -0
- package/docs/server.eventrouter.listenercount.md +55 -0
- package/docs/server.eventrouter.listeners.md +55 -0
- package/docs/server.eventrouter.md +40 -95
- package/docs/server.eventrouter.off.md +3 -3
- package/docs/{server.eventrouter.prependonce.md → server.eventrouter.off_1.md} +4 -10
- package/docs/server.eventrouter.offall.md +4 -4
- package/docs/server.eventrouter.on.md +3 -3
- package/docs/server.eventrouter.on_1.md +63 -0
- package/docs/server.eventrouter.once.md +3 -3
- package/docs/server.eventrouter.once_1.md +63 -0
- package/docs/{server.gameservereventtype.md → server.gameserverevent.md} +4 -4
- package/docs/server.gameservereventpayloads._gameserver.start_.md +15 -0
- package/docs/server.gameservereventpayloads._gameserver.stop_.md +15 -0
- package/docs/server.gameservereventpayloads.md +76 -0
- package/docs/server.light.md +7 -1
- package/docs/{server.lighteventtype.md → server.lightevent.md} +4 -18
- package/docs/server.lighteventpayloads._light.despawn_.md +15 -0
- package/docs/server.lighteventpayloads._light.set_angle_.md +16 -0
- package/docs/server.lighteventpayloads._light.set_attached_to_entity_.md +16 -0
- package/docs/server.lighteventpayloads._light.set_color_.md +16 -0
- package/docs/server.lighteventpayloads._light.set_distance_.md +16 -0
- package/docs/server.lighteventpayloads._light.set_intensity_.md +16 -0
- package/docs/server.lighteventpayloads._light.set_offset_.md +16 -0
- package/docs/server.lighteventpayloads._light.set_penumbra_.md +16 -0
- package/docs/server.lighteventpayloads._light.set_position_.md +16 -0
- package/docs/server.lighteventpayloads._light.set_tracked_entity_.md +16 -0
- package/docs/server.lighteventpayloads._light.set_tracked_position_.md +16 -0
- package/docs/server.lighteventpayloads._light.spawn_.md +15 -0
- package/docs/server.lighteventpayloads.md +266 -0
- package/docs/server.md +201 -84
- package/docs/server.player.md +7 -1
- package/docs/server.playercamera.md +7 -1
- package/docs/{server.playercameraeventtype.md → server.playercameraevent.md} +4 -4
- package/docs/server.playercameraeventpayloads._player_camera.look_at_entity_.md +16 -0
- package/docs/server.playercameraeventpayloads._player_camera.look_at_position_.md +16 -0
- package/docs/server.playercameraeventpayloads._player_camera.set_attached_to_entity_.md +16 -0
- package/docs/server.playercameraeventpayloads._player_camera.set_attached_to_position_.md +16 -0
- package/docs/server.playercameraeventpayloads._player_camera.set_film_offset_.md +16 -0
- package/docs/server.playercameraeventpayloads._player_camera.set_forward_offset_.md +16 -0
- package/docs/server.playercameraeventpayloads._player_camera.set_fov_.md +16 -0
- package/docs/server.playercameraeventpayloads._player_camera.set_mode_.md +16 -0
- package/docs/server.playercameraeventpayloads._player_camera.set_model_hidden_nodes_.md +16 -0
- package/docs/server.playercameraeventpayloads._player_camera.set_offset_.md +16 -0
- package/docs/server.playercameraeventpayloads._player_camera.set_tracked_entity_.md +16 -0
- package/docs/server.playercameraeventpayloads._player_camera.set_tracked_position_.md +16 -0
- package/docs/server.playercameraeventpayloads._player_camera.set_zoom_.md +16 -0
- package/docs/server.playercameraeventpayloads.md +285 -0
- package/docs/{server.playereventtype.md → server.playerevent.md} +4 -4
- package/docs/server.playereventpayloads._player.chat_message_send_.md +16 -0
- package/docs/server.playereventpayloads._player.joined_world_.md +16 -0
- package/docs/server.playereventpayloads._player.left_world_.md +16 -0
- package/docs/server.playereventpayloads._player.request_sync_.md +17 -0
- package/docs/server.playereventpayloads.md +114 -0
- package/docs/server.playermanager.md +4 -0
- package/docs/server.playermanagereventpayloads._player_manager.player_connected_.md +15 -0
- package/docs/server.playermanagereventpayloads._player_manager.player_disconnected_.md +15 -0
- package/docs/server.playermanagereventpayloads.md +76 -0
- package/docs/server.playerui.md +6 -1
- package/docs/{server.playeruieventtype.md → server.playeruievent.md} +4 -4
- package/docs/server.playeruieventpayloads._player_ui.load_.md +16 -0
- package/docs/server.playeruieventpayloads._player_ui.lock_pointer_.md +16 -0
- package/docs/server.playeruieventpayloads._player_ui.send_data_.md +16 -0
- package/docs/server.playeruieventpayloads.md +95 -0
- package/docs/server.rigidbody.md +2 -1
- package/docs/server.sceneui.md +7 -1
- package/docs/server.sceneuievent.md +131 -0
- package/docs/server.sceneuieventpayloads._scene_ui.load_.md +15 -0
- package/docs/server.sceneuieventpayloads._scene_ui.set_attached_to_entity_.md +16 -0
- package/docs/server.sceneuieventpayloads._scene_ui.set_offset_.md +16 -0
- package/docs/server.sceneuieventpayloads._scene_ui.set_position_.md +16 -0
- package/docs/server.sceneuieventpayloads._scene_ui.set_state_.md +16 -0
- package/docs/server.sceneuieventpayloads._scene_ui.set_view_distance_.md +16 -0
- package/docs/server.sceneuieventpayloads._scene_ui.unload_.md +15 -0
- package/docs/server.sceneuieventpayloads.md +171 -0
- package/docs/server.simulation.md +6 -1
- package/docs/server.simulationevent.md +89 -0
- package/docs/server.simulationeventpayloads._simulation.debug_raycast_.md +19 -0
- package/docs/server.simulationeventpayloads._simulation.debug_render_.md +17 -0
- package/docs/server.simulationeventpayloads._simulation.step_end_.md +16 -0
- package/docs/server.simulationeventpayloads._simulation.step_start_.md +16 -0
- package/docs/server.simulationeventpayloads.md +114 -0
- package/docs/server.world.md +7 -60
- package/docs/server.worldevent.md +131 -0
- package/docs/server.worldeventpayloads._world.set_ambient_light_color_.md +16 -0
- package/docs/server.worldeventpayloads._world.set_ambient_light_intensity_.md +16 -0
- package/docs/server.worldeventpayloads._world.set_directional_light_color_.md +16 -0
- package/docs/server.worldeventpayloads._world.set_directional_light_intensity_.md +16 -0
- package/docs/server.worldeventpayloads._world.set_directional_light_position_.md +16 -0
- package/docs/server.worldeventpayloads._world.start_.md +16 -0
- package/docs/server.worldeventpayloads._world.stop_.md +16 -0
- package/docs/server.worldeventpayloads.md +171 -0
- package/docs/server.worldloop.md +6 -1
- package/docs/{server.worldloopeventtype.md → server.worldloopevent.md} +4 -4
- package/docs/server.worldloopeventpayloads._world_loop.start_.md +15 -0
- package/docs/server.worldloopeventpayloads._world_loop.stop_.md +15 -0
- package/docs/server.worldloopeventpayloads._world_loop.tick_end_.md +16 -0
- package/docs/server.worldloopeventpayloads._world_loop.tick_error_.md +16 -0
- package/docs/server.worldloopeventpayloads._world_loop.tick_start_.md +16 -0
- package/docs/server.worldloopeventpayloads.md +133 -0
- package/examples/ai-agents/index.ts +9 -13
- package/examples/ai-agents/src/BaseAgent.ts +4 -2
- package/examples/ai-agents/src/behaviors/FishingBehavior.ts +2 -2
- package/examples/ai-agents/src/behaviors/FollowBehavior.ts +3 -3
- package/examples/ai-agents/src/behaviors/MiningBehavior.ts +2 -2
- package/examples/ai-agents/src/behaviors/PathfindingBehavior.ts +7 -7
- package/examples/big-world/index.ts +5 -4
- package/examples/block-entity/index.ts +12 -10
- package/examples/child-entity/index.ts +5 -4
- package/examples/custom-ui/index.ts +5 -4
- package/examples/entity-controller/index.ts +5 -4
- package/examples/entity-spawn/index.ts +8 -6
- package/examples/hole-in-wall-game/index.ts +9 -7
- package/examples/lighting/index.ts +5 -4
- package/examples/pathfinding/index.ts +5 -4
- package/examples/payload-game/index.ts +27 -23
- package/examples/wall-dodge-game/index.ts +8 -6
- package/examples/zombies-fps/classes/EnemyEntity.ts +10 -4
- package/examples/zombies-fps/classes/GamePlayerEntity.ts +7 -2
- package/examples/zombies-fps/classes/enemies/RipperEntity.ts +2 -1
- package/examples/zombies-fps/index.ts +5 -5
- package/package.json +1 -1
- package/server.api.json +9422 -7805
- package/server.d.ts +748 -472
- package/server.js +89 -89
- package/docs/server.audioeventpayload.md +0 -118
- package/docs/server.audioeventpayload.pause.audio.md +0 -11
- package/docs/server.audioeventpayload.pause.md +0 -53
- package/docs/server.audioeventpayload.play.audio.md +0 -11
- package/docs/server.audioeventpayload.play.md +0 -53
- package/docs/server.audioeventpayload.playrestart.audio.md +0 -11
- package/docs/server.audioeventpayload.playrestart.md +0 -53
- package/docs/server.audioeventpayload.setattachedtoentity.audio.md +0 -11
- package/docs/server.audioeventpayload.setattachedtoentity.entity.md +0 -11
- package/docs/server.audioeventpayload.setattachedtoentity.md +0 -70
- package/docs/server.audioeventpayload.setdetune.audio.md +0 -11
- package/docs/server.audioeventpayload.setdetune.detune.md +0 -11
- package/docs/server.audioeventpayload.setdetune.md +0 -70
- package/docs/server.audioeventpayload.setdistortion.audio.md +0 -11
- package/docs/server.audioeventpayload.setdistortion.distortion.md +0 -11
- package/docs/server.audioeventpayload.setdistortion.md +0 -70
- package/docs/server.audioeventpayload.setplaybackrate.audio.md +0 -11
- package/docs/server.audioeventpayload.setplaybackrate.md +0 -70
- package/docs/server.audioeventpayload.setplaybackrate.playbackrate.md +0 -11
- package/docs/server.audioeventpayload.setposition.audio.md +0 -11
- package/docs/server.audioeventpayload.setposition.md +0 -70
- package/docs/server.audioeventpayload.setposition.position.md +0 -11
- package/docs/server.audioeventpayload.setreferencedistance.audio.md +0 -11
- package/docs/server.audioeventpayload.setreferencedistance.md +0 -70
- package/docs/server.audioeventpayload.setreferencedistance.referencedistance.md +0 -11
- package/docs/server.audioeventpayload.setvolume.audio.md +0 -11
- package/docs/server.audioeventpayload.setvolume.md +0 -70
- package/docs/server.audioeventpayload.setvolume.volume.md +0 -11
- package/docs/server.baseentitycontroller.onattach.md +0 -13
- package/docs/server.baseentitycontroller.ondespawn.md +0 -13
- package/docs/server.baseentitycontroller.ondetach.md +0 -13
- package/docs/server.baseentitycontroller.onspawn.md +0 -13
- package/docs/server.baseentitycontroller.ontick.md +0 -13
- package/docs/server.baseentitycontroller.ontickwithplayerinput.md +0 -13
- package/docs/server.blocktype.onentitycollision.md +0 -18
- package/docs/server.blocktype.onentitycontactforce.md +0 -18
- package/docs/server.blocktyperegistryeventpayload.md +0 -37
- package/docs/server.blocktyperegistryeventpayload.registerblocktype.blocktype.md +0 -11
- package/docs/server.blocktyperegistryeventpayload.registerblocktype.blocktyperegistry.md +0 -11
- package/docs/server.blocktyperegistryeventpayload.registerblocktype.id.md +0 -11
- package/docs/server.blocktyperegistryeventpayload.registerblocktype.md +0 -87
- package/docs/server.chateventpayload.md +0 -46
- package/docs/server.chateventpayload.sendbroadcastmessage.color.md +0 -11
- package/docs/server.chateventpayload.sendbroadcastmessage.md +0 -91
- package/docs/server.chateventpayload.sendbroadcastmessage.message.md +0 -11
- package/docs/server.chateventpayload.sendbroadcastmessage.playerid.md +0 -11
- package/docs/server.chateventpayload.sendplayermessage.color.md +0 -11
- package/docs/server.chateventpayload.sendplayermessage.md +0 -89
- package/docs/server.chateventpayload.sendplayermessage.message.md +0 -11
- package/docs/server.chateventpayload.sendplayermessage.player.md +0 -11
- package/docs/server.chateventtype.md +0 -61
- package/docs/server.chatmanager.onbroadcastmessage.md +0 -13
- package/docs/server.chunkeventpayload.despawn.chunk.md +0 -11
- package/docs/server.chunkeventpayload.despawn.md +0 -53
- package/docs/server.chunkeventpayload.md +0 -55
- package/docs/server.chunkeventpayload.setblock.blocktypeid.md +0 -11
- package/docs/server.chunkeventpayload.setblock.chunk.md +0 -11
- package/docs/server.chunkeventpayload.setblock.globalcoordinate.md +0 -11
- package/docs/server.chunkeventpayload.setblock.localcoordinate.md +0 -11
- package/docs/server.chunkeventpayload.setblock.md +0 -104
- package/docs/server.chunkeventpayload.spawn.chunk.md +0 -11
- package/docs/server.chunkeventpayload.spawn.md +0 -53
- package/docs/server.entity.onblockcollision.md +0 -18
- package/docs/server.entity.onblockcontactforce.md +0 -18
- package/docs/server.entity.ondespawn.md +0 -13
- package/docs/server.entity.onentitycollision.md +0 -18
- package/docs/server.entity.onentitycontactforce.md +0 -18
- package/docs/server.entity.onspawn.md +0 -13
- package/docs/server.entity.ontick.md +0 -13
- package/docs/server.entityeventpayload.despawn.entity.md +0 -11
- package/docs/server.entityeventpayload.despawn.md +0 -53
- package/docs/server.entityeventpayload.md +0 -136
- package/docs/server.entityeventpayload.setmodelanimationsplaybackrate.entity.md +0 -11
- package/docs/server.entityeventpayload.setmodelanimationsplaybackrate.md +0 -70
- package/docs/server.entityeventpayload.setmodelanimationsplaybackrate.playbackrate.md +0 -11
- package/docs/server.entityeventpayload.setmodelhiddennodes.entity.md +0 -11
- package/docs/server.entityeventpayload.setmodelhiddennodes.md +0 -70
- package/docs/server.entityeventpayload.setmodelhiddennodes.modelhiddennodes.md +0 -11
- package/docs/server.entityeventpayload.setopacity.entity.md +0 -11
- package/docs/server.entityeventpayload.setopacity.md +0 -70
- package/docs/server.entityeventpayload.setopacity.opacity.md +0 -11
- package/docs/server.entityeventpayload.setparent.entity.md +0 -11
- package/docs/server.entityeventpayload.setparent.md +0 -87
- package/docs/server.entityeventpayload.setparent.parent.md +0 -11
- package/docs/server.entityeventpayload.setparent.parentnodename.md +0 -11
- package/docs/server.entityeventpayload.settintcolor.entity.md +0 -11
- package/docs/server.entityeventpayload.settintcolor.md +0 -70
- package/docs/server.entityeventpayload.settintcolor.tintcolor.md +0 -11
- package/docs/server.entityeventpayload.spawn.entity.md +0 -11
- package/docs/server.entityeventpayload.spawn.md +0 -53
- package/docs/server.entityeventpayload.startmodelloopedanimations.animations.md +0 -11
- package/docs/server.entityeventpayload.startmodelloopedanimations.entity.md +0 -11
- package/docs/server.entityeventpayload.startmodelloopedanimations.md +0 -70
- package/docs/server.entityeventpayload.startmodeloneshotanimations.animations.md +0 -11
- package/docs/server.entityeventpayload.startmodeloneshotanimations.entity.md +0 -11
- package/docs/server.entityeventpayload.startmodeloneshotanimations.md +0 -70
- package/docs/server.entityeventpayload.stopmodelanimations.animations.md +0 -11
- package/docs/server.entityeventpayload.stopmodelanimations.entity.md +0 -11
- package/docs/server.entityeventpayload.stopmodelanimations.md +0 -70
- package/docs/server.entityeventpayload.updateposition.entity.md +0 -11
- package/docs/server.entityeventpayload.updateposition.md +0 -70
- package/docs/server.entityeventpayload.updateposition.position.md +0 -11
- package/docs/server.entityeventpayload.updaterotation.entity.md +0 -11
- package/docs/server.entityeventpayload.updaterotation.md +0 -70
- package/docs/server.entityeventpayload.updaterotation.rotation.md +0 -11
- package/docs/server.eventrouter._constructor_.md +0 -49
- package/docs/server.eventrouter.logallevents.md +0 -13
- package/docs/server.eventrouter.logeventspayloads.md +0 -13
- package/docs/server.eventrouter.logignoreeventprefixes.md +0 -13
- package/docs/server.eventrouter.logignoreevents.md +0 -13
- package/docs/server.eventrouter.logunlistenedevents.md +0 -13
- package/docs/server.eventrouter.serverinstance.md +0 -13
- package/docs/server.gameservereventpayload.md +0 -46
- package/docs/server.gameservereventpayload.start.md +0 -53
- package/docs/server.gameservereventpayload.start.startedatms.md +0 -11
- package/docs/server.gameservereventpayload.stop.md +0 -53
- package/docs/server.gameservereventpayload.stop.stoppedatms.md +0 -11
- package/docs/server.lighteventpayload.despawn.light.md +0 -11
- package/docs/server.lighteventpayload.despawn.md +0 -53
- package/docs/server.lighteventpayload.md +0 -136
- package/docs/server.lighteventpayload.setangle.angle.md +0 -11
- package/docs/server.lighteventpayload.setangle.light.md +0 -11
- package/docs/server.lighteventpayload.setangle.md +0 -70
- package/docs/server.lighteventpayload.setattachedtoentity.entity.md +0 -11
- package/docs/server.lighteventpayload.setattachedtoentity.light.md +0 -11
- package/docs/server.lighteventpayload.setattachedtoentity.md +0 -70
- package/docs/server.lighteventpayload.setcolor.color.md +0 -11
- package/docs/server.lighteventpayload.setcolor.light.md +0 -11
- package/docs/server.lighteventpayload.setcolor.md +0 -70
- package/docs/server.lighteventpayload.setdistance.distance.md +0 -11
- package/docs/server.lighteventpayload.setdistance.light.md +0 -11
- package/docs/server.lighteventpayload.setdistance.md +0 -70
- package/docs/server.lighteventpayload.setintensity.intensity.md +0 -11
- package/docs/server.lighteventpayload.setintensity.light.md +0 -11
- package/docs/server.lighteventpayload.setintensity.md +0 -70
- package/docs/server.lighteventpayload.setoffset.light.md +0 -11
- package/docs/server.lighteventpayload.setoffset.md +0 -70
- package/docs/server.lighteventpayload.setoffset.offset.md +0 -11
- package/docs/server.lighteventpayload.setpenumbra.light.md +0 -11
- package/docs/server.lighteventpayload.setpenumbra.md +0 -70
- package/docs/server.lighteventpayload.setpenumbra.penumbra.md +0 -11
- package/docs/server.lighteventpayload.setposition.light.md +0 -11
- package/docs/server.lighteventpayload.setposition.md +0 -70
- package/docs/server.lighteventpayload.setposition.position.md +0 -11
- package/docs/server.lighteventpayload.settrackedentity.entity.md +0 -11
- package/docs/server.lighteventpayload.settrackedentity.light.md +0 -11
- package/docs/server.lighteventpayload.settrackedentity.md +0 -70
- package/docs/server.lighteventpayload.settrackedposition.light.md +0 -11
- package/docs/server.lighteventpayload.settrackedposition.md +0 -70
- package/docs/server.lighteventpayload.settrackedposition.position.md +0 -11
- package/docs/server.lighteventpayload.spawn.light.md +0 -11
- package/docs/server.lighteventpayload.spawn.md +0 -53
- package/docs/server.playercameraeventpayload.lookatentity.entity.md +0 -11
- package/docs/server.playercameraeventpayload.lookatentity.md +0 -70
- package/docs/server.playercameraeventpayload.lookatentity.playercamera.md +0 -11
- package/docs/server.playercameraeventpayload.lookatposition.md +0 -70
- package/docs/server.playercameraeventpayload.lookatposition.playercamera.md +0 -11
- package/docs/server.playercameraeventpayload.lookatposition.position.md +0 -11
- package/docs/server.playercameraeventpayload.md +0 -145
- package/docs/server.playercameraeventpayload.setattachedtoentity.entity.md +0 -11
- package/docs/server.playercameraeventpayload.setattachedtoentity.md +0 -70
- package/docs/server.playercameraeventpayload.setattachedtoentity.playercamera.md +0 -11
- package/docs/server.playercameraeventpayload.setattachedtoposition.md +0 -70
- package/docs/server.playercameraeventpayload.setattachedtoposition.playercamera.md +0 -11
- package/docs/server.playercameraeventpayload.setattachedtoposition.position.md +0 -11
- package/docs/server.playercameraeventpayload.setfilmoffset.filmoffset.md +0 -11
- package/docs/server.playercameraeventpayload.setfilmoffset.md +0 -70
- package/docs/server.playercameraeventpayload.setfilmoffset.playercamera.md +0 -11
- package/docs/server.playercameraeventpayload.setforwardoffset.forwardoffset.md +0 -11
- package/docs/server.playercameraeventpayload.setforwardoffset.md +0 -70
- package/docs/server.playercameraeventpayload.setforwardoffset.playercamera.md +0 -11
- package/docs/server.playercameraeventpayload.setfov.fov.md +0 -11
- package/docs/server.playercameraeventpayload.setfov.md +0 -70
- package/docs/server.playercameraeventpayload.setfov.playercamera.md +0 -11
- package/docs/server.playercameraeventpayload.setmode.md +0 -70
- package/docs/server.playercameraeventpayload.setmode.mode.md +0 -11
- package/docs/server.playercameraeventpayload.setmode.playercamera.md +0 -11
- package/docs/server.playercameraeventpayload.setmodelhiddennodes.md +0 -70
- package/docs/server.playercameraeventpayload.setmodelhiddennodes.modelhiddennodes.md +0 -11
- package/docs/server.playercameraeventpayload.setmodelhiddennodes.playercamera.md +0 -11
- package/docs/server.playercameraeventpayload.setoffset.md +0 -70
- package/docs/server.playercameraeventpayload.setoffset.offset.md +0 -11
- package/docs/server.playercameraeventpayload.setoffset.playercamera.md +0 -11
- package/docs/server.playercameraeventpayload.settrackedentity.entity.md +0 -11
- package/docs/server.playercameraeventpayload.settrackedentity.md +0 -70
- package/docs/server.playercameraeventpayload.settrackedentity.playercamera.md +0 -11
- package/docs/server.playercameraeventpayload.settrackedposition.md +0 -70
- package/docs/server.playercameraeventpayload.settrackedposition.playercamera.md +0 -11
- package/docs/server.playercameraeventpayload.settrackedposition.position.md +0 -11
- package/docs/server.playercameraeventpayload.setzoom.md +0 -70
- package/docs/server.playercameraeventpayload.setzoom.playercamera.md +0 -11
- package/docs/server.playercameraeventpayload.setzoom.zoom.md +0 -11
- package/docs/server.playereventpayload.chatmessagesend.md +0 -70
- package/docs/server.playereventpayload.chatmessagesend.message.md +0 -11
- package/docs/server.playereventpayload.chatmessagesend.player.md +0 -11
- package/docs/server.playereventpayload.joinedworld.md +0 -70
- package/docs/server.playereventpayload.joinedworld.player.md +0 -11
- package/docs/server.playereventpayload.joinedworld.world.md +0 -11
- package/docs/server.playereventpayload.leftworld.md +0 -70
- package/docs/server.playereventpayload.leftworld.player.md +0 -11
- package/docs/server.playereventpayload.leftworld.world.md +0 -11
- package/docs/server.playereventpayload.md +0 -64
- package/docs/server.playereventpayload.requestsync.md +0 -87
- package/docs/server.playereventpayload.requestsync.player.md +0 -11
- package/docs/server.playereventpayload.requestsync.receivedat.md +0 -11
- package/docs/server.playereventpayload.requestsync.receivedatms.md +0 -11
- package/docs/server.playeruieventpayload.load.htmluri.md +0 -11
- package/docs/server.playeruieventpayload.load.md +0 -70
- package/docs/server.playeruieventpayload.load.playerui.md +0 -11
- package/docs/server.playeruieventpayload.lockpointer.lock.md +0 -11
- package/docs/server.playeruieventpayload.lockpointer.md +0 -70
- package/docs/server.playeruieventpayload.lockpointer.playerui.md +0 -11
- package/docs/server.playeruieventpayload.md +0 -55
- package/docs/server.playeruieventpayload.senddata.data.md +0 -11
- package/docs/server.playeruieventpayload.senddata.md +0 -70
- package/docs/server.playeruieventpayload.senddata.playerui.md +0 -11
- package/docs/server.world.eventrouter.md +0 -13
- package/docs/server.world.onplayerjoin.md +0 -13
- package/docs/server.world.onplayerleave.md +0 -13
- package/docs/server.worldloopeventpayload.md +0 -73
- package/docs/server.worldloopeventpayload.start.md +0 -53
- package/docs/server.worldloopeventpayload.start.worldloop.md +0 -11
- package/docs/server.worldloopeventpayload.stop.md +0 -53
- package/docs/server.worldloopeventpayload.stop.worldloop.md +0 -11
- package/docs/server.worldloopeventpayload.tickend.md +0 -70
- package/docs/server.worldloopeventpayload.tickend.tickdurationms.md +0 -11
- package/docs/server.worldloopeventpayload.tickend.worldloop.md +0 -11
- package/docs/server.worldloopeventpayload.tickerror.error.md +0 -11
- package/docs/server.worldloopeventpayload.tickerror.md +0 -70
- package/docs/server.worldloopeventpayload.tickerror.worldloop.md +0 -11
- package/docs/server.worldloopeventpayload.tickstart.md +0 -70
- package/docs/server.worldloopeventpayload.tickstart.tickdeltams.md +0 -11
- 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) > [server](./server.md) > [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) > [server](./server.md) > [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md) > ["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) > [server](./server.md) > [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md) > ["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) > [server](./server.md) > [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>
|
package/docs/server.playerui.md
CHANGED
@@ -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) > [server](./server.md) > [
|
3
|
+
[Home](./index.md) > [server](./server.md) > [PlayerUIEvent](./server.playeruievent.md)
|
4
4
|
|
5
|
-
##
|
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
|
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) > [server](./server.md) > [PlayerUIEventPayloads](./server.playeruieventpayloads.md) > ["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) > [server](./server.md) > [PlayerUIEventPayloads](./server.playeruieventpayloads.md) > ["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) > [server](./server.md) > [PlayerUIEventPayloads](./server.playeruieventpayloads.md) > ["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) > [server](./server.md) > [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>
|
package/docs/server.rigidbody.md
CHANGED
@@ -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
|
|
package/docs/server.sceneui.md
CHANGED
@@ -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) > [server](./server.md) > [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) > [server](./server.md) > [SceneUIEventPayloads](./server.sceneuieventpayloads.md) > ["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) > [server](./server.md) > [SceneUIEventPayloads](./server.sceneuieventpayloads.md) > ["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) > [server](./server.md) > [SceneUIEventPayloads](./server.sceneuieventpayloads.md) > ["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) > [server](./server.md) > [SceneUIEventPayloads](./server.sceneuieventpayloads.md) > ["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) > [server](./server.md) > [SceneUIEventPayloads](./server.sceneuieventpayloads.md) > ["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) > [server](./server.md) > [SceneUIEventPayloads](./server.sceneuieventpayloads.md) > ["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
|
+
```
|