hytopia 0.1.63 → 0.1.65

package/docs/server.collider.md

@@ -449,6 +449,38 @@ Enables or disables collision events for the collider. This is automatically ena
 Enables or disables contact force events for the collider. This is automatically enabled if an on contact force callback is set.
 
 
+</td></tr>
+<tr><td>
+
+[optionsFromBlockHalfExtents(halfExtents)](./server.collider.optionsfromblockhalfextents.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Creates a collider options object from a block's half extents.
+
+
+</td></tr>
+<tr><td>
+
+[optionsFromModelUri(modelUri, scale)](./server.collider.optionsfrommodeluri.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Creates a collider options object from a modelUri with best approximate shape and size.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.collider.optionsfromblockhalfextents.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; [Collider](./server.collider.md) &gt; [optionsFromBlockHalfExtents](./server.collider.optionsfromblockhalfextents.md)
+
+## Collider.optionsFromBlockHalfExtents() method
+
+Creates a collider options object from a block's half extents.
+
+**Signature:**
+
+```typescript
+static optionsFromBlockHalfExtents(halfExtents: Vector3Like): ColliderOptions;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+halfExtents
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The half extents of the block.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[ColliderOptions](./server.collideroptions.md)
+
+The collider options object.
+

package/docs/server.collider.optionsfrommodeluri.md

@@ -0,0 +1,71 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Collider](./server.collider.md) &gt; [optionsFromModelUri](./server.collider.optionsfrommodeluri.md)
+
+## Collider.optionsFromModelUri() method
+
+Creates a collider options object from a modelUri with best approximate shape and size.
+
+**Signature:**
+
+```typescript
+static optionsFromModelUri(modelUri: string, scale?: number): ColliderOptions;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+modelUri
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The URI of the model.
+
+
+</td></tr>
+<tr><td>
+
+scale
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[ColliderOptions](./server.collideroptions.md)
+
+The collider options object.
+

package/docs/server.gameserver.md

@@ -63,6 +63,27 @@ Description
 The singleton instance of the game server.
 
 
+</td></tr>
+<tr><td>
+
+[modelManager](./server.gameserver.modelmanager.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[ModelManager](./server.modelmanager.md)
+
+
+</td><td>
+
+The model manager for the game server.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.gameserver.modelmanager.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; [modelManager](./server.gameserver.modelmanager.md)
+
+## GameServer.modelManager property
+
+The model manager for the game server.
+
+**Signature:**
+
+```typescript
+get modelManager(): ModelManager;
+```

package/docs/server.md

@@ -170,6 +170,17 @@ Manages event emission and assigned listener callbacks.
 Manages the game and associated worlds and systems.
 
 
+</td></tr>
+<tr><td>
+
+[ModelManager](./server.modelmanager.md)
+
+
+</td><td>
+
+Manages model data for all known models of the game.
+
+
 </td></tr>
 <tr><td>
 
@@ -901,17 +912,6 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[DEFAULT\_BLOCK\_ENTITY\_RIGID\_BODY\_OPTIONS](./server.default_block_entity_rigid_body_options.md)
-
-
-</td><td>
-
-The default rigid body options for a block entity when EntityOptions.rigidBodyOptions is not provided.
-
-
-</td></tr>
-<tr><td>
-
 [DEFAULT\_ENTITY\_RIGID\_BODY\_OPTIONS](./server.default_entity_rigid_body_options.md)
 
 

package/docs/server.modelmanager.getboundingbox.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; [ModelManager](./server.modelmanager.md) &gt; [getBoundingBox](./server.modelmanager.getboundingbox.md)
+
+## ModelManager.getBoundingBox() method
+
+Retrieves the bounding box of a model.
+
+**Signature:**
+
+```typescript
+getBoundingBox(modelUri: string): ModelBoundingBox;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+modelUri
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The URI of the model to retrieve the bounding box for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+ModelBoundingBox
+
+The bounding box of the model.
+

package/docs/server.modelmanager.instance.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; [ModelManager](./server.modelmanager.md) &gt; [instance](./server.modelmanager.instance.md)
+
+## ModelManager.instance property
+
+The global PlayerManager instance as a singleton.
+
+**Signature:**
+
+```typescript
+static readonly instance: ModelManager;
+```

package/docs/server.modelmanager.md

@@ -0,0 +1,111 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ModelManager](./server.modelmanager.md)
+
+## ModelManager class
+
+Manages model data for all known models of the game.
+
+**Signature:**
+
+```typescript
+export default class ModelManager 
+```
+
+## Remarks
+
+The ModelManager is created internally as a global singletone accessible with the static property `ModelManager.instance`<!-- -->.
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ModelManager` class.
+
+## Example
+
+
+```typescript
+import { ModelManager } from 'hytopia';
+
+const modelManager = ModelManager.instance;
+const boundingBox = modelManager.getBoundingBox('models/player.gltf');
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[instance](./server.modelmanager.instance.md)
+
+
+</td><td>
+
+`static`
+
+`readonly`
+
+
+</td><td>
+
+[ModelManager](./server.modelmanager.md)
+
+
+</td><td>
+
+The global PlayerManager instance as a singleton.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getBoundingBox(modelUri)](./server.modelmanager.getboundingbox.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves the bounding box of a model.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.rigidbodyoptions.md

@@ -398,7 +398,7 @@ _(Optional)_ The soft continuous collision detection prediction of the rigid bod
 </td></tr>
 <tr><td>
 
-[type](./server.rigidbodyoptions.type.md)
+[type?](./server.rigidbodyoptions.type.md)
 
 
 </td><td>
@@ -411,7 +411,7 @@ _(Optional)_ The soft continuous collision detection prediction of the rigid bod
 
 </td><td>
 
-The type of the rigid body.
+_(Optional)_ The type of the rigid body.
 
 
 </td></tr>

package/docs/server.rigidbodyoptions.type.md

@@ -9,5 +9,5 @@ The type of the rigid body.
 **Signature:**
 
 ```typescript
-type: RigidBodyType;
+type?: RigidBodyType;
 ```

package/examples/entity-spawn/index.ts

@@ -5,6 +5,7 @@ import {
   PlayerEntity,
   RigidBodyType,
   World,
+  Collider,
 } from 'hytopia';
 
 import worldMap from './assets/map.json';
@@ -30,16 +31,8 @@ startServer(world => {
       // set any colliders, the entity will not be affected by physics.
       // Learn more about collider options here: https://github.com/hytopiagg/sdk/blob/main/docs/server.collideroptions.md
       colliders: [
-        {
-          shape: ColliderShape.ROUND_CYLINDER,
-          // We manually set the collider sizings to match the model, 
-          // this gives the most control. There is currently no way 
-          // to automatically size colliders to a model.
-          radius: 3, 
-          halfHeight: 1.7,
-          borderRadius: 0.2,
-          tag: 'hitbox', // Tags can be useful for our own logic, they serve no other purpose.
-        },
+        // Get hitbox collider as collider options based on the model & scale.
+        Collider.optionsFromModelUri('models/spider.gltf', 3),
         {
           shape: ColliderShape.CYLINDER,
           halfHeight: 1.7,

package/examples/payload-game/index.ts

@@ -30,6 +30,7 @@ import {
   Vector3,
   World,
   startServer,
+  Collider,
 } from 'hytopia';
 
 import type {
@@ -224,17 +225,6 @@ function spawnBullet(world: World, coordinate: Vector3Like, direction: Vector3Li
         z: direction.z * BULLET_SPEED,
       },
       rotation: getRotationFromDirection(direction), // Get the rotation from the direction vector so it's facing the right way we shot it
-      colliders: [
-        {
-          shape: ColliderShape.BALL,
-          radius: 0.1,
-          isSensor: true,
-          collisionGroups: {
-            belongsTo: [ CollisionGroup.ENTITY_SENSOR ],
-            collidesWith: [ CollisionGroup.ENTITY, CollisionGroup.BLOCK ],
-          },
-        },
-      ],
     },
   });
 
@@ -301,14 +291,8 @@ function spawnPayloadEntity(world: World) {
     rigidBodyOptions: {
       type: RigidBodyType.KINEMATIC_POSITION,
       colliders: [
-        {
-          shape: ColliderShape.BLOCK,
-          halfExtents: { x: 0.9, y: 1.6, z: 2.5 }, // Note: We manually set the collider size, the SDK currently does not support automatic sizing of colliders to a model.
-          collisionGroups: {
-            belongsTo: [ CollisionGroup.ALL ],
-            collidesWith: [ CollisionGroup.ENTITY, CollisionGroup.ENTITY_SENSOR, CollisionGroup.PLAYER ],
-          },
-        },
+        // Get hitbox collider as collider options based on the model & scale.
+        Collider.optionsFromModelUri('models/payload.gltf', 0.7),
         {
           shape: ColliderShape.BLOCK, // Create a proximity sensor for movement when players are near.
           halfExtents: { x: 3.75, y: 2, z: 6 },
@@ -359,17 +343,8 @@ function spawnSpider(world: World, coordinate: Vector3Like) {
       type: RigidBodyType.DYNAMIC,
       enabledRotations: { x: false, y: true, z: false },
       colliders: [
-        {
-          shape: ColliderShape.ROUND_CYLINDER,
-          borderRadius: 0.1 * randomScaleMultiplier,
-          halfHeight: 0.225 * randomScaleMultiplier,
-          radius: 0.5 * randomScaleMultiplier,
-          tag: 'body', // Note we use tags here, they don't really serve a purpose in this example other than showing that they can be used.
-          collisionGroups: {
-            belongsTo: [ CollisionGroup.ENTITY ],
-            collidesWith: [ CollisionGroup.BLOCK, CollisionGroup.ENTITY_SENSOR, CollisionGroup.PLAYER ],
-          },
-        },
+        // Get hitbox collider as collider options based on the model & scale.
+        Collider.optionsFromModelUri('models/spider.gltf', baseScale * randomScaleMultiplier),
         {
           shape: ColliderShape.CYLINDER,
           radius: 20,

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

@@ -8,10 +8,10 @@ import {
   startServer,
   Player,
   PlayerEntity,
-  PlayerEntityController,
   RigidBodyType,
   SimpleEntityController,
   World,
+  Collider,
 } from 'hytopia';
 
 import worldMap from './assets/map.json';
@@ -75,12 +75,7 @@ function setupJoinNPC(world: World) {
       type: RigidBodyType.FIXED, // It won't ever move, so we can use a fixed body
       rotation: { x: 0, y: 1, z: 0, w: 0 }, // Rotate the NPC to face the player
       colliders: [
-        { // Hitbox/body collider
-          shape: ColliderShape.CYLINDER,
-          radius: 0.3,
-          halfHeight: 1.2,
-          tag: 'body',
-        },
+        Collider.optionsFromModelUri('models/mindflayer.gltf', 0.5), // Uses the model's bounding box to create the hitbox collider
         { // Create a sensor that teleports the player into the game
           shape: ColliderShape.BLOCK,
           halfExtents: { x: 1.5, y: 1, z: 1.5 }, // size it slightly smaller than the platform the join NPC is standing on
@@ -180,7 +175,13 @@ function startBlockSpawner(world: World) {
   
       blockEntity.onTick = () => {
         if (blockEntity.isSpawned && blockEntity.position.z > GAME_BLOCK_DESPAWN_Z) {
-          // TODO: drop it out of the world, despawn to fix platform collision bug
+          // Make it "fall" out of the world for a nice effect and prevent
+          // player collision platforming sensors from not getting their off
+          // event triggered because of despawning before uncontact.
+          blockEntity.setLinearVelocity({ x: 0, y: -5, z: 0 });
+        }
+
+        if (blockEntity.isSpawned && blockEntity.position.y < -5) {
           blockEntity.despawn();
         }
       };
@@ -260,11 +261,9 @@ function onPlayerJoin(world: World, player: Player) {
     modelScale: 0.5,
   });
 
-  (playerEntity.controller as PlayerEntityController).sticksToPlatforms = false;
-
   playerEntity.onTick = () => {
-    if (playerEntity.position.y < -3) {
-      // Assume the player has fallen off the map in the game
+    if (playerEntity.position.y < -3 || playerEntity.position.y > 10) {
+      // Assume the player has fallen off the map or shot over the wall
       endGame(playerEntity);
     }
   };
@@ -310,7 +309,7 @@ function getRandomSpawnCoordinate() {
 
 function updateTopScores() {
   const topScores = Array.from(PLAYER_TOP_SCORES.entries())
-    .sort((a, b) => a[1] - b[1])
+    .sort((a, b) => b[1] - a[1])
     .map(([ player, score ]) => ({ player, score }));
 
   // Get the top 10 highest scores

package/package.json

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