hytopia 0.5.0-dev → 0.5.0-dev3

package/boilerplate/index.ts

@@ -26,7 +26,7 @@
 import {
   startServer,
   Audio,
-  PlayerEntity,
+  DefaultPlayerEntity,
   PlayerEvent,
 } from 'hytopia';
 
@@ -77,12 +77,9 @@ startServer(world => {
    * here: https://dev.hytopia.com/sdk-guides/events
    */
   world.on(PlayerEvent.JOINED_WORLD, ({ player }) => {
-    const playerEntity = new PlayerEntity({
+    const playerEntity = new DefaultPlayerEntity({
       player,
       name: 'Player',
-      modelUri: 'models/players/player.gltf',
-      modelLoopedAnimations: [ 'idle' ],
-      modelScale: 0.5,
     });
   
     playerEntity.spawn(world, { x: 0, y: 10, z: 0 });

package/docs/server.chunklattice.chunkcount.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ChunkLattice](./server.chunklattice.md) &gt; [chunkCount](./server.chunklattice.chunkcount.md)
+
+## ChunkLattice.chunkCount property
+
+The number of chunks in the lattice.
+
+**Signature:**
+
+```typescript
+get chunkCount(): number;
+```

package/docs/server.chunklattice.md

@@ -47,6 +47,52 @@ Description
 Creates a new chunk lattice instance.
 
 
+</td></tr>
+</tbody></table>
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[chunkCount](./server.chunklattice.chunkcount.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The number of chunks in the lattice.
+
+
 </td></tr>
 </tbody></table>
 

package/docs/server.defaultplayerentitycontroller.canswim.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [canSwim](./server.defaultplayerentitycontroller.canswim.md)
+
+## DefaultPlayerEntityController.canSwim property
+
+A function allowing custom logic to determine if the entity can swim.
+
+**Signature:**
+
+```typescript
+canSwim: (controller: DefaultPlayerEntityController) => boolean;
+```

package/docs/server.defaultplayerentitycontroller.md

@@ -145,6 +145,25 @@ A function allowing custom logic to determine if the entity can jump.
 A function allowing custom logic to determine if the entity can run.
 
 
+</td></tr>
+<tr><td>
+
+[canSwim](./server.defaultplayerentitycontroller.canswim.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(controller: [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md)<!-- -->) =&gt; boolean
+
+
+</td><td>
+
+A function allowing custom logic to determine if the entity can swim.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.defaultplayerentitycontrolleroptions.canswim.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [canSwim](./server.defaultplayerentitycontrolleroptions.canswim.md)
+
+## DefaultPlayerEntityControllerOptions.canSwim property
+
+A function allowing custom logic to determine if the entity can swim.
+
+**Signature:**
+
+```typescript
+canSwim?: () => boolean;
+```

package/docs/server.defaultplayerentitycontrolleroptions.md

@@ -91,6 +91,25 @@ _(Optional)_ A function allowing custom logic to determine if the entity can jum
 _(Optional)_ A function allowing custom logic to determine if the entity can run.
 
 
+</td></tr>
+<tr><td>
+
+[canSwim?](./server.defaultplayerentitycontrolleroptions.canswim.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; boolean
+
+
+</td><td>
+
+_(Optional)_ A function allowing custom logic to determine if the entity can swim.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entitymanager.entitycount.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityManager](./server.entitymanager.md) &gt; [entityCount](./server.entitymanager.entitycount.md)
+
+## EntityManager.entityCount property
+
+The number of spawned entities in the world.
+
+**Signature:**
+
+```typescript
+get entityCount(): number;
+```

package/docs/server.entitymanager.md

@@ -52,6 +52,27 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[entityCount](./server.entitymanager.entitycount.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The number of spawned entities in the world.
+
+
+</td></tr>
+<tr><td>
+
 [world](./server.entitymanager.world.md)
 
 

package/docs/server.eventpayloads.md

@@ -9,7 +9,7 @@ The payloads for all events in the game server.
 **Signature:**
 
 ```typescript
-export interface EventPayloads extends AudioEventPayloads, BaseEntityControllerEventPayloads, BlockTypeEventPayloads, BlockTypeRegistryEventPayloads, ChatEventPayloads, ChunkEventPayloads, ConnectionEventPayloads, EntityEventPayloads, GameServerEventPayloads, PlayerCameraEventPayloads, PlayerEventPayloads, PlayerManagerEventPayloads, PlayerUIEventPayloads, SceneUIEventPayloads, SimulationEventPayloads, SocketEventPayloads, LightEventPayloads, WebServerEventPayloads, WorldEventPayloads, WorldLoopEventPayloads 
+export interface EventPayloads extends AudioEventPayloads, BaseEntityControllerEventPayloads, BlockTypeEventPayloads, BlockTypeRegistryEventPayloads, ChatEventPayloads, ChunkEventPayloads, ConnectionEventPayloads, EntityEventPayloads, GameServerEventPayloads, PlayerCameraEventPayloads, PlayerEventPayloads, PlayerManagerEventPayloads, PlayerUIEventPayloads, SceneUIEventPayloads, SimulationEventPayloads, SocketEventPayloads, LightEventPayloads, WebServerEventPayloads, WorldEventPayloads, WorldLoopEventPayloads, WorldManagerEventPayloads 
 ```
-**Extends:** [AudioEventPayloads](./server.audioeventpayloads.md)<!-- -->, [BaseEntityControllerEventPayloads](./server.baseentitycontrollereventpayloads.md)<!-- -->, [BlockTypeEventPayloads](./server.blocktypeeventpayloads.md)<!-- -->, [BlockTypeRegistryEventPayloads](./server.blocktyperegistryeventpayloads.md)<!-- -->, [ChatEventPayloads](./server.chateventpayloads.md)<!-- -->, [ChunkEventPayloads](./server.chunkeventpayloads.md)<!-- -->, ConnectionEventPayloads, [EntityEventPayloads](./server.entityeventpayloads.md)<!-- -->, [GameServerEventPayloads](./server.gameservereventpayloads.md)<!-- -->, [PlayerCameraEventPayloads](./server.playercameraeventpayloads.md)<!-- -->, [PlayerEventPayloads](./server.playereventpayloads.md)<!-- -->, [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md)<!-- -->, [PlayerUIEventPayloads](./server.playeruieventpayloads.md)<!-- -->, [SceneUIEventPayloads](./server.sceneuieventpayloads.md)<!-- -->, [SimulationEventPayloads](./server.simulationeventpayloads.md)<!-- -->, SocketEventPayloads, [LightEventPayloads](./server.lighteventpayloads.md)<!-- -->, WebServerEventPayloads, [WorldEventPayloads](./server.worldeventpayloads.md)<!-- -->, [WorldLoopEventPayloads](./server.worldloopeventpayloads.md)
+**Extends:** [AudioEventPayloads](./server.audioeventpayloads.md)<!-- -->, [BaseEntityControllerEventPayloads](./server.baseentitycontrollereventpayloads.md)<!-- -->, [BlockTypeEventPayloads](./server.blocktypeeventpayloads.md)<!-- -->, [BlockTypeRegistryEventPayloads](./server.blocktyperegistryeventpayloads.md)<!-- -->, [ChatEventPayloads](./server.chateventpayloads.md)<!-- -->, [ChunkEventPayloads](./server.chunkeventpayloads.md)<!-- -->, ConnectionEventPayloads, [EntityEventPayloads](./server.entityeventpayloads.md)<!-- -->, [GameServerEventPayloads](./server.gameservereventpayloads.md)<!-- -->, [PlayerCameraEventPayloads](./server.playercameraeventpayloads.md)<!-- -->, [PlayerEventPayloads](./server.playereventpayloads.md)<!-- -->, [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md)<!-- -->, [PlayerUIEventPayloads](./server.playeruieventpayloads.md)<!-- -->, [SceneUIEventPayloads](./server.sceneuieventpayloads.md)<!-- -->, [SimulationEventPayloads](./server.simulationeventpayloads.md)<!-- -->, SocketEventPayloads, [LightEventPayloads](./server.lighteventpayloads.md)<!-- -->, WebServerEventPayloads, [WorldEventPayloads](./server.worldeventpayloads.md)<!-- -->, [WorldLoopEventPayloads](./server.worldloopeventpayloads.md)<!-- -->, [WorldManagerEventPayloads](./server.worldmanagereventpayloads.md)
 

package/docs/server.gameserver.md

@@ -129,7 +129,7 @@ The web server for the game server.
 </td></tr>
 <tr><td>
 
-[worlds](./server.gameserver.worlds.md)
+[worldManager](./server.gameserver.worldmanager.md)
 
 
 </td><td>
@@ -139,12 +139,12 @@ The web server for the game server.
 
 </td><td>
 
-{ \[id: string\]: [World](./server.world.md)<!-- -->; }
+[WorldManager](./server.worldmanager.md)
 
 
 </td><td>
 
-The worlds managed by the game server.
+The world manager for the game server
 
 
 </td></tr>

package/docs/server.gameserver.worldmanager.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [GameServer](./server.gameserver.md) &gt; [worldManager](./server.gameserver.worldmanager.md)
+
+## GameServer.worldManager property
+
+The world manager for the game server
+
+**Signature:**
+
+```typescript
+get worldManager(): WorldManager;
+```

package/docs/server.md

@@ -456,6 +456,17 @@ Represents a world in the game server.
 Manages the tick loop for a world.
 
 
+</td></tr>
+<tr><td>
+
+[WorldManager](./server.worldmanager.md)
+
+
+</td><td>
+
+Manages all worlds in a game server.
+
+
 </td></tr>
 </tbody></table>
 
@@ -673,6 +684,17 @@ The mode of the camera.
 Event types a Player can emit. See [PlayerEventPayloads](./server.playereventpayloads.md) for the payloads.
 
 
+</td></tr>
+<tr><td>
+
+[PlayerManagerEvent](./server.playermanagerevent.md)
+
+
+</td><td>
+
+Event types a PlayerManager can emit. See [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md) for the payloads.
+
+
 </td></tr>
 <tr><td>
 
@@ -739,6 +761,17 @@ Event types a World instance can emit. See [WorldEventPayloads](./server.worldev
 Event types a WorldLoop instance can emit. See [WorldLoopEventPayloads](./server.worldloopeventpayloads.md) for the payloads.
 
 
+</td></tr>
+<tr><td>
+
+[WorldManagerEvent](./server.worldmanagerevent.md)
+
+
+</td><td>
+
+Event types a WorldManager instance can emit to the global event router. See [WorldManagerEventPayloads](./server.worldmanagereventpayloads.md) for the payloads.
+
+
 </td></tr>
 </tbody></table>
 
@@ -1308,6 +1341,17 @@ Event payloads for World emitted events.
 Event payloads for WorldLoop emitted events.
 
 
+</td></tr>
+<tr><td>
+
+[WorldManagerEventPayloads](./server.worldmanagereventpayloads.md)
+
+
+</td><td>
+
+Event payloads for WorldManager emitted events.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.player.md

@@ -259,7 +259,7 @@ Joins a player to a world.
 </td></tr>
 <tr><td>
 
-[leaveWorld()](./server.player.leaveworld.md)
+[resetInputs()](./server.player.resetinputs.md)
 
 
 </td><td>
@@ -267,7 +267,7 @@ Joins a player to a world.
 
 </td><td>
 
-Removes the player from the current [World](./server.world.md) they are in.
+Resets all inputs keys
 
 
 </td></tr>

package/docs/server.player.resetinputs.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Player](./server.player.md) &gt; [resetInputs](./server.player.resetinputs.md)
+
+## Player.resetInputs() method
+
+Resets all inputs keys
+
+**Signature:**
+
+```typescript
+resetInputs(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.playercamera.md

@@ -396,6 +396,20 @@ Makes the camera look at an entity. If the camera was previously tracking an ent
 Makes the camera look at a position. If the camera was previously tracking an entity or position, it will stop tracking.
 
 
+</td></tr>
+<tr><td>
+
+[reset()](./server.playercamera.reset.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Resets the camera to its default, unattached, spectator mode state.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playercamera.reset.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCamera](./server.playercamera.md) &gt; [reset](./server.playercamera.reset.md)
+
+## PlayerCamera.reset() method
+
+Resets the camera to its default, unattached, spectator mode state.
+
+**Signature:**
+
+```typescript
+reset(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.playerevent.md

@@ -71,6 +71,20 @@ LEFT\_WORLD
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+RECONNECTED\_WORLD
+
+
+</td><td>
+
+`"PLAYER.RECONNECTED_WORLD"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playereventpayloads._player.reconnected_world_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEventPayloads](./server.playereventpayloads.md) &gt; ["PLAYER.RECONNECTED\_WORLD"](./server.playereventpayloads._player.reconnected_world_.md)
+
+## PlayerEventPayloads."PLAYER.RECONNECTED\_WORLD" property
+
+Emitted when a player reconnects to a world after a disconnect.
+
+**Signature:**
+
+```typescript
+[PlayerEvent.RECONNECTED_WORLD]: {
+        player: Player;
+        world: World;
+    };
+```

package/docs/server.playereventpayloads.md

@@ -91,6 +91,25 @@ Emitted when a player joins a world.
 Emitted when a player leaves a world.
 
 
+</td></tr>
+<tr><td>
+
+["PLAYER.RECONNECTED\_WORLD"](./server.playereventpayloads._player.reconnected_world_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ player: [Player](./server.player.md)<!-- -->; world: [World](./server.world.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when a player reconnects to a world after a disconnect.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playermanager.md

@@ -18,7 +18,7 @@ The PlayerManager is created internally as a global singleton accessible with th
 
 <h2>Events</h2>
 
-This class is an EventRouter, and instances of it emit events with payloads listed under [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md)
+This class emits global events with payloads listed under [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md)
 
 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.
 
@@ -77,6 +77,27 @@ Description
 The global PlayerManager instance as a singleton.
 
 
+</td></tr>
+<tr><td>
+
+[playerCount](./server.playermanager.playercount.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The number of players currently connected to the server.
+
+
 </td></tr>
 </tbody></table>
 

package/docs/server.playermanager.playercount.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerManager](./server.playermanager.md) &gt; [playerCount](./server.playermanager.playercount.md)
+
+## PlayerManager.playerCount property
+
+The number of players currently connected to the server.
+
+**Signature:**
+
+```typescript
+get playerCount(): number;
+```

package/docs/server.playermanagerevent.md

@@ -0,0 +1,75 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerManagerEvent](./server.playermanagerevent.md)
+
+## PlayerManagerEvent enum
+
+Event types a PlayerManager can emit. See [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md) for the payloads.
+
+**Signature:**
+
+```typescript
+export declare enum PlayerManagerEvent 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+PLAYER\_CONNECTED
+
+
+</td><td>
+
+`"PLAYER_MANAGER.PLAYER_CONNECTED"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+PLAYER\_DISCONNECTED
+
+
+</td><td>
+
+`"PLAYER_MANAGER.PLAYER_DISCONNECTED"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+PLAYER\_RECONNECTED
+
+
+</td><td>
+
+`"PLAYER_MANAGER.PLAYER_RECONNECTED"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.playermanagereventpayloads._player_manager.player_reconnected_.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md) &gt; ["PLAYER\_MANAGER.PLAYER\_RECONNECTED"](./server.playermanagereventpayloads._player_manager.player_reconnected_.md)
+
+## PlayerManagerEventPayloads."PLAYER\_MANAGER.PLAYER\_RECONNECTED" property
+
+Emitted when a player reconnects to the server.
+
+**Signature:**
+
+```typescript
+[PlayerManagerEvent.PLAYER_RECONNECTED]: {
+        player: Player;
+    };
+```

package/docs/server.playermanagereventpayloads.md

@@ -72,5 +72,24 @@ Emitted when a player connects to the server.
 Emitted when a player disconnects from the server.
 
 
+</td></tr>
+<tr><td>
+
+["PLAYER\_MANAGER.PLAYER\_RECONNECTED"](./server.playermanagereventpayloads._player_manager.player_reconnected_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ player: [Player](./server.player.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when a player reconnects to the server.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.world.md

@@ -447,6 +447,27 @@ string
 The URI of the skybox cubemap for the world.
 
 
+</td></tr>
+<tr><td>
+
+[tag](./server.world.tag.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+An arbitrary identifier tag of the world. Useful for your own logic.
+
+
 </td></tr>
 </tbody></table>