hytopia 0.1.75 → 0.1.77

package/boilerplate/index.ts

@@ -103,7 +103,7 @@ startServer(world => {
    * instance.
    */
   world.onPlayerLeave = player => {
-    world.entityManager.getAllPlayerEntities(player).forEach(entity => entity.despawn());
+    world.entityManager.getPlayerEntitiesByPlayer(player).forEach(entity => entity.despawn());
   };
 
   /**
@@ -111,7 +111,7 @@ startServer(world => {
    * "/rocket" in the game, they'll get launched into the air!
    */
   world.chatManager.registerCommand('/rocket', player => {
-    world.entityManager.getAllPlayerEntities(player).forEach(entity => {
+    world.entityManager.getPlayerEntitiesByPlayer(player).forEach(entity => {
       entity.applyImpulse({ x: 0, y: 20, z: 0 });
     });
   });

package/docs/server.collider.md

@@ -618,7 +618,7 @@ Sets the on collision callback for the collider.
 
 </td><td>
 
-Sets the relative position of the collider to its parent rigid body.
+Sets the position of the collider relative to its parent rigid body or the world origin.
 
 
 </td></tr>
@@ -632,7 +632,7 @@ Sets the relative position of the collider to its parent rigid body.
 
 </td><td>
 
-Sets the relative rotation of the collider.
+Sets the relative rotation of the collider to its parent rigid body or the world origin.
 
 
 </td></tr>

package/docs/server.collider.setrelativeposition.md

@@ -4,7 +4,7 @@
 
 ## Collider.setRelativePosition() method
 
-Sets the relative position of the collider to its parent rigid body.
+Sets the position of the collider relative to its parent rigid body or the world origin.
 
 **Signature:**
 
@@ -51,3 +51,7 @@ The relative position of the collider.
 
 void
 
+## Remarks
+
+Colliders can be added as a child of a rigid body, or to the world directly. This position is relative to the parent rigid body or the world origin.
+

package/docs/server.collider.setrelativerotation.md

@@ -4,7 +4,7 @@
 
 ## Collider.setRelativeRotation() method
 
-Sets the relative rotation of the collider.
+Sets the relative rotation of the collider to its parent rigid body or the world origin.
 
 **Signature:**
 
@@ -51,3 +51,7 @@ The relative rotation of the collider.
 
 void
 
+## Remarks
+
+Colliders can be added as a child of a rigid body, or to the world directly. This rotation is relative to the parent rigid body or the world origin.
+

package/docs/server.entitymanager.getallplayerentities.md

@@ -4,52 +4,16 @@
 
 ## EntityManager.getAllPlayerEntities() method
 
-Gets all spawned entities in the world assigned to a player.
+Gets all spawned player entities in the world.
 
 **Signature:**
 
 ```typescript
-getAllPlayerEntities(player: Player): PlayerEntity[];
+getAllPlayerEntities(): PlayerEntity[];
 ```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-player
-
-
-</td><td>
-
-[Player](./server.player.md)
-
-
-</td><td>
-
-The player to get the entities for.
-
-
-</td></tr>
-</tbody></table>
 **Returns:**
 
 [PlayerEntity](./server.playerentity.md)<!-- -->\[\]
 
-All spawned entities in the world assigned to the player.
+All spawned player entities in the world.
 

package/docs/server.entitymanager.getplayerentitiesbyplayer.md

@@ -0,0 +1,55 @@
+<!-- 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; [getPlayerEntitiesByPlayer](./server.entitymanager.getplayerentitiesbyplayer.md)
+
+## EntityManager.getPlayerEntitiesByPlayer() method
+
+Gets all spawned entities in the world assigned to the provided player.
+
+**Signature:**
+
+```typescript
+getPlayerEntitiesByPlayer(player: Player): PlayerEntity[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+player
+
+
+</td><td>
+
+[Player](./server.player.md)
+
+
+</td><td>
+
+The player to get the entities for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[PlayerEntity](./server.playerentity.md)<!-- -->\[\]
+
+All spawned entities in the world assigned to the player.
+

package/docs/server.entitymanager.md

@@ -107,7 +107,7 @@ Gets all spawned entities in the world.
 </td></tr>
 <tr><td>
 
-[getAllPlayerEntities(player)](./server.entitymanager.getallplayerentities.md)
+[getAllPlayerEntities()](./server.entitymanager.getallplayerentities.md)
 
 
 </td><td>
@@ -115,7 +115,7 @@ Gets all spawned entities in the world.
 
 </td><td>
 
-Gets all spawned entities in the world assigned to a player.
+Gets all spawned player entities in the world.
 
 
 </td></tr>
@@ -160,5 +160,19 @@ Gets all spawned entities in the world with a tag that includes a specific subst
 Gets a spawned entity in the world by its id.
 
 
+</td></tr>
+<tr><td>
+
+[getPlayerEntitiesByPlayer(player)](./server.entitymanager.getplayerentitiesbyplayer.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets all spawned entities in the world assigned to the provided player.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.player.id.md

@@ -4,10 +4,10 @@
 
 ## Player.id property
 
-The unique identifier for the player.
+The unique HYTOPIA UUID for the player.
 
 **Signature:**
 
 ```typescript
-readonly id: number;
+readonly id: string;
 ```

package/docs/server.player.md

@@ -74,12 +74,12 @@ The camera for the player.
 
 </td><td>
 
-number
+string
 
 
 </td><td>
 
-The unique identifier for the player.
+The unique HYTOPIA UUID for the player.
 
 
 </td></tr>
@@ -142,7 +142,7 @@ string
 
 </td><td>
 
-The username for the player.
+The unique HYTOPIA username for the player.
 
 
 </td></tr>

package/docs/server.player.username.md

@@ -4,7 +4,7 @@
 
 ## Player.username property
 
-The username for the player.
+The unique HYTOPIA username for the player.
 
 **Signature:**
 

package/docs/server.playermanager.getconnectedplayersbyworld.md

@@ -0,0 +1,55 @@
+<!-- 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; [getConnectedPlayersByWorld](./server.playermanager.getconnectedplayersbyworld.md)
+
+## PlayerManager.getConnectedPlayersByWorld() method
+
+Get all connected players in a specific world.
+
+**Signature:**
+
+```typescript
+getConnectedPlayersByWorld(world: World): Player[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+world
+
+
+</td><td>
+
+[World](./server.world.md)
+
+
+</td><td>
+
+The world to get connected players for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Player](./server.player.md)<!-- -->\[\]
+
+An array of all connected players in the world.
+

package/docs/server.playermanager.md

@@ -121,5 +121,19 @@ Get a connected player by their username (case insensitive).
 Get all connected players.
 
 
+</td></tr>
+<tr><td>
+
+[getConnectedPlayersByWorld(world)](./server.playermanager.getconnectedplayersbyworld.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Get all connected players in a specific world.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.sceneuimanager.getsceneuibyid.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUIManager](./server.sceneuimanager.md) &gt; [getSceneUIById](./server.sceneuimanager.getsceneuibyid.md)
+
+## SceneUIManager.getSceneUIById() method
+
+Retrieves a SceneUI instance by its unique identifier (id).
+
+**Signature:**
+
+```typescript
+getSceneUIById(id: number): SceneUI | undefined;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+id
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The unique identifier (id) of the SceneUI to retrieve.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[SceneUI](./server.sceneui.md) \| undefined
+
+The SceneUI instance if found, otherwise undefined.
+

package/docs/server.sceneuimanager.md

@@ -109,6 +109,20 @@ Retrieves all loaded SceneUI instances attached to a specific entity.
 Retrieves all loaded SceneUI instances for the world.
 
 
+</td></tr>
+<tr><td>
+
+[getSceneUIById(id)](./server.sceneuimanager.getsceneuibyid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves a SceneUI instance by its unique identifier (id).
+
+
 </td></tr>
 <tr><td>
 

package/examples/big-world/index.ts

@@ -36,6 +36,6 @@ startServer(world => {
 
   // Despawn all player entities when a player leaves the game.
   world.onPlayerLeave = player => {
-    world.entityManager.getAllPlayerEntities(player).forEach(entity => entity.despawn());
+    world.entityManager.getPlayerEntitiesByPlayer(player).forEach(entity => entity.despawn());
   };
 });

package/examples/block-entity/index.ts

@@ -30,7 +30,7 @@ startServer(world => {
   };
 
   world.onPlayerLeave = player => {
-    world.entityManager.getAllPlayerEntities(player).forEach(entity => entity.despawn());
+    world.entityManager.getPlayerEntitiesByPlayer(player).forEach(entity => entity.despawn());
   };
 
   /**
@@ -41,7 +41,7 @@ startServer(world => {
     blockHalfExtents: { x: 1, y: 0.5, z: 1 },
     rigidBodyOptions: {
       type: RigidBodyType.KINEMATIC_VELOCITY, // Kinematic means platform won't be effected by external physics, including gravity
-      linearVelocity: { x: 0, y: 0, z: 3 }, // A starting velocity that won't change because it's kinematic
+      linearVelocity: { x: 0, y: 0, z: 3 }, // A starting velocity that won't change until we change it, because it's kinematic
     },
   });
 
@@ -162,7 +162,7 @@ startServer(world => {
       const targetPlayer = connectedPlayers[Math.floor(Math.random() * connectedPlayers.length)];
 
       // get the player's entity
-      const targetPlayerEntity = world.entityManager.getAllPlayerEntities(targetPlayer)[0];
+      const targetPlayerEntity = world.entityManager.getPlayerEntitiesByPlayer(targetPlayer)[0];
 
       if (!targetPlayerEntity) { return; } // if the player doesn't have an entity, don't pathfind.
 

package/examples/custom-ui/assets/ui/index.html

@@ -1,91 +1,74 @@
-<html>
-  <body>
-    <!-- 
-      We MUST always import the Hytopia UI library! 
-      Importing this library also imports the hytopia global.
+<script>
+  // Handle received data from server
+  hytopia.onData(data => {
+    if (data.type === 'playerList') {
+      const { list } = data;
 
-      If we were using React, or Svelte, or another framework, we
-      can install the HYTPIA UI library as a package and import it
-      with `npm install hytopia-ui` and then import it as
-      `import hytopia from 'hytopia-ui';`
-    -->
-    <script src="https://unpkg.com/hytopia-ui@latest/dist/index.umd.js"></script>
+      // Update player count
+      document.getElementById('player-count').textContent = `Players Connected: ${list.length}`;
 
-    <script>
-      document.addEventListener('DOMContentLoaded', () => {
-        // Handle received data from server
-        hytopia.ui.onData = data => {
-          if (data.type === 'playerList') {
-            const { list } = data;
+      // Clear and rebuild player list
+      const playerListElement = document.getElementById('player-list');
+      playerListElement.innerHTML = '';
 
-            // Update player count
-            document.getElementById('player-count').textContent = `Players Connected: ${list.length}`;
-
-            // Clear and rebuild player list
-            const playerListElement = document.getElementById('player-list');
-            playerListElement.innerHTML = '';
-
-            // Add each player to the list
-            list.forEach(player => {
-              const pos = player.position;
-              const playerRow = document.createElement('div');
-              playerRow.className = 'player-row';
-              playerRow.textContent = `${player.username}: x:${pos.x.toFixed(1)}, y:${pos.y.toFixed(1)}, z:${pos.z.toFixed(1)}`;
-              playerListElement.appendChild(playerRow);
-            });
-          }
-        }
-
-        // Send data to server on teleport btn press
-        document.getElementById('teleport-btn').addEventListener('click', () => {
-          // We can send any arbitrary object to the server. We as the developer define
-          // whatever schema we want to use for data between client and server.
-          // For now we'll just use a "type" property we made up so the server knows
-          // what to do with the data.
-          hytopia.ui.sendData({ type: 'teleport' });
-        });
+      // Add each player to the list
+      list.forEach(player => {
+        const pos = player.position;
+        const playerRow = document.createElement('div');
+        playerRow.className = 'player-row';
+        playerRow.textContent = `${player.username}: x:${pos.x.toFixed(1)}, y:${pos.y.toFixed(1)}, z:${pos.z.toFixed(1)}`;
+        playerListElement.appendChild(playerRow);
       });
-    </script>
+    }
+  });
+
+  // Send data to server on teleport btn press
+  document.getElementById('teleport-btn').addEventListener('click', () => {
+    // We can send any arbitrary object to the server. We as the developer define
+    // whatever schema we want to use for data between client and server.
+    // For now we'll just use a "type" property we made up so the server knows
+    // what to do with the data.
+    hytopia.sendData({ type: 'teleport' });
+  });
+</script>
 
-    <div id="player-panel">
-      <div id="player-count">Players Connected: 0</div>
-      <div id="player-list"></div>
-      <button id="teleport-btn">Click to Teleport!</button>
-    </div>
+<div id="player-panel">
+  <div id="player-count">Players Connected: 0</div>
+  <div id="player-list"></div>
+  <button id="teleport-btn">Click to Teleport!</button>
+</div>
 
-    <style>
-      #player-panel {
-        position: absolute;
-        right: 20px;
-        top: 20px;
-        background-color: rgba(0, 0, 0, 0.7);
-        color: white;
-        padding: 15px;
-        border-radius: 8px;
-        min-width: 200px;
-        font-family: Arial, sans-serif;
-        letter-spacing: 0.5px;
-      }
-      .player-row {
-        margin: 8px 0;
-      }
-      #teleport-btn {
-        width: 100%;
-        padding: 8px;
-        margin-top: 15px;
-        background-color: #4CAF50;
-        color: white;
-        border: none;
-        border-radius: 4px;
-        cursor: pointer;
-        font-family: Arial, sans-serif;
-        font-weight: bold;
-        text-transform: uppercase;
-        letter-spacing: 1px;
-      }
-      #teleport-btn:hover {
-        background-color: #45a049;
-      }
-    </style>
-  </body>
-</html>
+<style>
+  #player-panel {
+    position: absolute;
+    right: 20px;
+    top: 20px;
+    background-color: rgba(0, 0, 0, 0.7);
+    color: white;
+    padding: 15px;
+    border-radius: 8px;
+    min-width: 200px;
+    font-family: Arial, sans-serif;
+    letter-spacing: 0.5px;
+  }
+  .player-row {
+    margin: 8px 0;
+  }
+  #teleport-btn {
+    width: 100%;
+    padding: 8px;
+    margin-top: 15px;
+    background-color: #4CAF50;
+    color: white;
+    border: none;
+    border-radius: 4px;
+    cursor: pointer;
+    font-family: Arial, sans-serif;
+    font-weight: bold;
+    text-transform: uppercase;
+    letter-spacing: 1px;
+  }
+  #teleport-btn:hover {
+    background-color: #45a049;
+  }
+</style>

package/examples/custom-ui/index.ts

@@ -51,7 +51,7 @@ startServer(world => {
   };
 
   world.onPlayerLeave = player => {
-    world.entityManager.getAllPlayerEntities(player).forEach(entity => entity.despawn());
+    world.entityManager.getPlayerEntitiesByPlayer(player).forEach(entity => entity.despawn());
     // Remove the player entity from our map for our list.
     playerEntityMap.delete(player);
   };

package/examples/entity-controller/index.ts

@@ -33,6 +33,6 @@ startServer(world => {
   };
   
   world.onPlayerLeave = player => {
-    world.entityManager.getAllPlayerEntities(player).forEach(entity => entity.despawn());
+    world.entityManager.getPlayerEntitiesByPlayer(player).forEach(entity => entity.despawn());
   };
 });

package/examples/entity-spawn/index.ts

@@ -80,6 +80,6 @@ function setup(world: World) {
 
   // Despawn all player entities when a player leaves the game.
   world.onPlayerLeave = player => {
-    world.entityManager.getAllPlayerEntities(player).forEach(entity => entity.despawn());
+    world.entityManager.getPlayerEntitiesByPlayer(player).forEach(entity => entity.despawn());
   };
 }

package/examples/hole-in-wall-game/assets/ui/index.html

@@ -62,10 +62,11 @@
         const gameCountdownStartTime = data.gameCountdownStartTime;
         const countdownSeconds = data.countdown;
         
+        let timeLeft = countdownSeconds;
         const updateCountdown = () => {
           if (timeLeft > 0 && gameState === 'starting') {
             const now = Date.now();
-            const timeLeft = Math.max(0, Math.ceil((gameCountdownStartTime + (countdownSeconds * 1000) - now) / 1000));
+            timeLeft = Math.max(0, Math.ceil((gameCountdownStartTime + (countdownSeconds * 1000) - now) / 1000));
             updateGameStatus(`GAME STARTING IN ${timeLeft}...`);
             setTimeout(updateCountdown, 1000);
           }