hytopia 0.1.76 → 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.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.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/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/index.ts

@@ -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.76",
+  "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

@@ -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",
@@ -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)",