npm - hytopia - Versions diffs - 0.1.75 → 0.1.76 - Mend

hytopia 0.1.75 → 0.1.76

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 (13) hide show

package/docs/server.collider.md +2 -2
package/docs/server.collider.setrelativeposition.md +5 -1
package/docs/server.collider.setrelativerotation.md +5 -1
package/docs/server.player.id.md +2 -2
package/docs/server.player.md +3 -3
package/docs/server.player.username.md +1 -1
package/examples/custom-ui/assets/ui/index.html +68 -85
package/examples/hole-in-wall-game/assets/ui/index.html +2 -1
package/examples/hole-in-wall-game/index.ts +2 -2
package/package.json +1 -1
package/server.api.json +5 -5
package/server.d.ts +15 -5
package/server.js +1 -1

package/docs/server.collider.md CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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.player.id.md CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

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

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

@@ -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/hole-in-wall-game/assets/ui/index.html CHANGED Viewed

@@ -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);
           }

package/examples/hole-in-wall-game/index.ts CHANGED Viewed

@@ -98,8 +98,8 @@ function onPlayerJoin(world: World, player: Player) {
   playerEntity.spawn(world, GAME_CONFIG.POSITIONS.PLAYER_SPAWN);
   playerEntity.setCollisionGroupsForSolidColliders({
-    belongsTo: [CollisionGroup.ENTITY, CollisionGroup.PLAYER],
-    collidesWith: [CollisionGroup.BLOCK, CollisionGroup.ENTITY_SENSOR, GAME_CONFIG.WALL_COLLISION_GROUP],
+    belongsTo: [CollisionGroup.PLAYER],
+    collidesWith: [CollisionGroup.BLOCK, CollisionGroup.ENTITY, CollisionGroup.ENTITY_SENSOR, GAME_CONFIG.WALL_COLLISION_GROUP],
   });
   playerEntity.setCollisionGroupsForSensorColliders({

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.1.75",
+  "version": "0.1.76",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "main": "server.js",
   "bin": {

package/server.api.json CHANGED Viewed

@@ -7626,7 +7626,7 @@
             {
               "kind": "Method",
               "canonicalReference": "server!Collider#setRelativePosition:member(1)",
-              "docComment": "/**\n * Sets the relative position of the collider to its parent rigid body.\n *\n * @param position - The relative position of the collider.\n */\n",
+              "docComment": "/**\n * Sets the position of the collider relative to its parent rigid body or the world origin.\n *\n * @remarks\n *\n * 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.\n *\n * @param position - The relative position of the collider.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -7675,7 +7675,7 @@
             {
               "kind": "Method",
               "canonicalReference": "server!Collider#setRelativeRotation:member(1)",
-              "docComment": "/**\n * Sets the relative rotation of the collider.\n *\n * @param rotation - The relative rotation of the collider.\n */\n",
+              "docComment": "/**\n * Sets the relative rotation of the collider to its parent rigid body or the world origin.\n *\n * @remarks\n *\n * 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.\n *\n * @param rotation - The relative rotation of the collider.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -16956,7 +16956,7 @@
             {
               "kind": "Property",
               "canonicalReference": "server!Player#id:member",
-              "docComment": "/**\n * The unique identifier for the player.\n */\n",
+              "docComment": "/**\n * The unique HYTOPIA UUID for the player.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -16964,7 +16964,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "number"
+                  "text": "string"
                 },
                 {
                   "kind": "Content",
@@ -17128,7 +17128,7 @@
             {
               "kind": "Property",
               "canonicalReference": "server!Player#username:member",
-              "docComment": "/**\n * The username for the player.\n */\n",
+              "docComment": "/**\n * The unique HYTOPIA username for the player.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",

package/server.d.ts CHANGED Viewed

@@ -983,12 +983,22 @@ export declare class Collider {
      */
     setOnCollision(callback: CollisionCallback | undefined): void;
     /**
-     * Sets the relative rotation of the collider.
+     * Sets the relative rotation of the collider to its parent rigid body or the world origin.
+     *
+     * @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.
+     *
      * @param rotation - The relative rotation of the collider.
      */
     setRelativeRotation(rotation: QuaternionLike): void;
     /**
-     * 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.
+     *
+     * @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.
+     *
      * @param position - The relative position of the collider.
      */
     setRelativePosition(position: Vector3Like): void;
@@ -2157,9 +2167,9 @@ export declare type MoveOptions = {
  * @public
  */
 export declare class Player {
-    /** The unique identifier for the player. */
-    readonly id: number;
-    /** The username for the player. */
+    /** The unique HYTOPIA UUID for the player. */
+    readonly id: string;
+    /** The unique HYTOPIA username for the player. */
     readonly username: string;
     /** The camera for the player. */
     readonly camera: PlayerCamera;