hytopia 0.1.75 → 0.1.77

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

@@ -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({
@@ -115,7 +115,7 @@ function onPlayerJoin(world: World, player: Player) {
 }
 
 function onPlayerLeave(world: World, player: Player) {
-  world.entityManager.getAllPlayerEntities(player).forEach(entity => {
+  world.entityManager.getPlayerEntitiesByPlayer(player).forEach(entity => {
     removePlayerFromQueue(entity);
     killPlayer(entity);
     entity.despawn();

package/examples/lighting/index.ts

@@ -109,7 +109,7 @@ 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());
   };
 
   // Play some music on game start

package/examples/payload-game/index.ts

@@ -151,7 +151,7 @@ startServer(world => { // Perform our game setup logic in the startServer init c
     // We apply a translation prior to despawn because of a bug in the RAPIER
     // physics engine we use where entities despawned to not trigger a collision
     // event for leaving a sensor. This is a workaround till a better solution is found.
-    world.entityManager.getAllPlayerEntities(player).forEach(entity => {
+    world.entityManager.getPlayerEntitiesByPlayer(player).forEach(entity => {
       entity.setPosition({ x: 0, y: 100, z: 0 });
       setTimeout(() => entity.despawn(), 50); // Despawn after a short delay so we step the physics after translating it so leaving the sensor registers.
     });

package/examples/wall-dodge-game/index.ts

@@ -277,7 +277,7 @@ function onPlayerJoin(world: World, player: Player) {
  * cleanup when they leave the game. 
  */
 function onPlayerLeave(world: World, player: Player) {
-  world.entityManager.getAllPlayerEntities(player).forEach(entity => {
+  world.entityManager.getPlayerEntitiesByPlayer(player).forEach(entity => {
     endGame(entity); // explicitly end their game if they leave
     entity.despawn(); // despawn their entity
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.1.75",
+  "version": "0.1.77",
   "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

@@ -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",
@@ -12080,20 +12080,11 @@
             {
               "kind": "Method",
               "canonicalReference": "server!EntityManager#getAllPlayerEntities:member(1)",
-              "docComment": "/**\n * Gets all spawned entities in the world assigned to a player.\n *\n * @param player - The player to get the entities for.\n *\n * @returns All spawned entities in the world assigned to the player.\n */\n",
+              "docComment": "/**\n * Gets all spawned player entities in the world.\n *\n * @returns All spawned player entities in the world.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "getAllPlayerEntities(player: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Player",
-                  "canonicalReference": "server!Player:class"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
+                  "text": "getAllPlayerEntities(): "
                 },
                 {
                   "kind": "Reference",
@@ -12111,22 +12102,13 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 5
+                "startIndex": 1,
+                "endIndex": 3
               },
               "releaseTag": "Public",
               "isProtected": false,
               "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "player",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                }
-              ],
+              "parameters": [],
               "isOptional": false,
               "isAbstract": false,
               "name": "getAllPlayerEntities"
@@ -12307,6 +12289,60 @@
               "isAbstract": false,
               "name": "getEntity"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!EntityManager#getPlayerEntitiesByPlayer:member(1)",
+              "docComment": "/**\n * Gets all spawned entities in the world assigned to the provided player.\n *\n * @param player - The player to get the entities for.\n *\n * @returns All spawned entities in the world assigned to the player.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getPlayerEntitiesByPlayer(player: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Player",
+                  "canonicalReference": "server!Player:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PlayerEntity",
+                  "canonicalReference": "server!PlayerEntity:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "player",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getPlayerEntitiesByPlayer"
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!EntityManager#world:member",
@@ -16956,7 +16992,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 +17000,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "number"
+                  "text": "string"
                 },
                 {
                   "kind": "Content",
@@ -17128,7 +17164,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",
@@ -21212,6 +21248,60 @@
               "isAbstract": false,
               "name": "getConnectedPlayers"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!PlayerManager#getConnectedPlayersByWorld:member(1)",
+              "docComment": "/**\n * Get all connected players in a specific world.\n *\n * @param world - The world to get connected players for.\n *\n * @returns An array of all connected players in the world.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getConnectedPlayersByWorld(world: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "World",
+                  "canonicalReference": "server!World:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Player",
+                  "canonicalReference": "server!Player:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "world",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getConnectedPlayersByWorld"
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!PlayerManager.instance:member",
@@ -28037,6 +28127,59 @@
               "isAbstract": false,
               "name": "getAllSceneUIs"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!SceneUIManager#getSceneUIById:member(1)",
+              "docComment": "/**\n * Retrieves a SceneUI instance by its unique identifier (id).\n *\n * @param id - The unique identifier (id) of the SceneUI to retrieve.\n *\n * @returns The SceneUI instance if found, otherwise undefined.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getSceneUIById(id: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "SceneUI",
+                  "canonicalReference": "server!SceneUI:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "id",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getSceneUIById"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!SceneUIManager#unloadEntityAttachedSceneUIs:member(1)",

package/server.d.ts

@@ -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;
@@ -1564,11 +1574,16 @@ export declare class EntityManager {
      */
     getAllEntities(): Entity[];
     /**
-     * Gets all spawned entities in the world assigned to a player.
+     * Gets all spawned player entities in the world.
+     * @returns All spawned player entities in the world.
+     */
+    getAllPlayerEntities(): PlayerEntity[];
+    /**
+     * Gets all spawned entities in the world assigned to the provided player.
      * @param player - The player to get the entities for.
      * @returns All spawned entities in the world assigned to the player.
      */
-    getAllPlayerEntities(player: Player): PlayerEntity[];
+    getPlayerEntitiesByPlayer(player: Player): PlayerEntity[];
     /**
      * Gets a spawned entity in the world by its id.
      * @param id - The id of the entity to get.
@@ -2157,9 +2172,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;
@@ -2640,6 +2655,12 @@ export declare class PlayerManager {
      * @returns An array of all connected players.
      */
     getConnectedPlayers(): Player[];
+    /**
+     * Get all connected players in a specific world.
+     * @param world - The world to get connected players for.
+     * @returns An array of all connected players in the world.
+     */
+    getConnectedPlayersByWorld(world: World): Player[];
     /**
      * Get a connected player by their username (case insensitive).
      * @param username - The username of the player to get.
@@ -3438,6 +3459,13 @@ export declare class SceneUIManager {
      * @returns An array of SceneUI instances.
      */
     getAllEntityAttachedSceneUIs(entity: Entity): SceneUI[];
+    /**
+     * Retrieves a SceneUI instance by its unique identifier (id).
+     *
+     * @param id - The unique identifier (id) of the SceneUI to retrieve.
+     * @returns The SceneUI instance if found, otherwise undefined.
+     */
+    getSceneUIById(id: number): SceneUI | undefined;
 
     /**
      * Unloads and unregisters all SceneUI instances attached to a specific entity.