hytopia 0.1.38 → 0.1.40

package/docs/server.hytopia.collidershape.md

@@ -113,5 +113,19 @@ ROUND\_CYLINDER
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+TRIMESH
+
+
+</td><td>
+
+`"trimesh"`
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>

package/docs/server.hytopia.collisioncallback.md

@@ -9,7 +9,7 @@ A callback function that is called when a collision occurs.
 **Signature:**
 
 ```typescript
-export type CollisionCallback = (other: BlockType | Entity, started: boolean) => void;
+export type CollisionCallback = ((other: BlockType | Entity, started: boolean) => void) | ((other: BlockType | Entity, started: boolean, colliderHandleA: number, colliderHandleB: number) => void);
 ```
 **References:** [BlockType](./server.blocktype.md)<!-- -->, [Entity](./server.entity.md)
 

package/docs/server.hytopia.defaultcharactercontroller.createcolliders.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [DefaultCharacterController](./server.hytopia.defaultcharactercontroller.md) &gt; [createColliders](./server.hytopia.defaultcharactercontroller.createcolliders.md)
+
+## HYTOPIA.DefaultCharacterController.createColliders() method
+
+Creates the colliders for the character controller, overriding the default implementation.
+
+**Signature:**
+
+```typescript
+createColliders(): Collider[];
+```
+**Returns:**
+
+[Collider](./server.collider.md)<!-- -->\[\]
+
+An array of colliders.
+

package/docs/server.hytopia.defaultcharactercontroller.md

@@ -290,7 +290,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[createSensorColliders()](./server.hytopia.defaultcharactercontroller.createsensorcolliders.md)
+[createColliders()](./server.hytopia.defaultcharactercontroller.createcolliders.md)
 
 
 </td><td>
@@ -298,7 +298,7 @@ Description
 
 </td><td>
 
-Creates the sensor colliders for the character controller, overriding the default implementation.
+Creates the colliders for the character controller, overriding the default implementation.
 
 
 </td></tr>

package/docs/server.hytopia.entity.isblockentity.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; [HYTOPIA](./server.hytopia.md) &gt; [Entity](./server.hytopia.entity.md) &gt; [isBlockEntity](./server.hytopia.entity.isblockentity.md)
+
+## HYTOPIA.Entity.isBlockEntity property
+
+Whether the entity is a block entity.
+
+**Signature:**
+
+```typescript
+get isBlockEntity(): boolean;
+```

package/docs/server.hytopia.entity.ismodelentity.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; [HYTOPIA](./server.hytopia.md) &gt; [Entity](./server.hytopia.entity.md) &gt; [isModelEntity](./server.hytopia.entity.ismodelentity.md)
+
+## HYTOPIA.Entity.isModelEntity property
+
+Whether the entity is a model entity.
+
+**Signature:**
+
+```typescript
+get isModelEntity(): boolean;
+```

package/docs/server.hytopia.entity.md

@@ -204,6 +204,48 @@ number \| undefined
 The unique identifier for the entity.
 
 
+</td></tr>
+<tr><td>
+
+[isBlockEntity](./server.hytopia.entity.isblockentity.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the entity is a block entity.
+
+
+</td></tr>
+<tr><td>
+
+[isModelEntity](./server.hytopia.entity.ismodelentity.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the entity is a model entity.
+
+
 </td></tr>
 <tr><td>
 
@@ -341,7 +383,7 @@ The name of the entity.
 
 </td><td>
 
-(entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, started: boolean) =&gt; void
+((entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, started: boolean) =&gt; void) \| ((entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, started: boolean, colliderHandleA: number, colliderHandleB: number) =&gt; void)
 
 
 </td><td>
@@ -398,7 +440,7 @@ _(Optional)_ A function that is called when the entity is despawned.
 
 </td><td>
 
-(entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void
+((entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void) \| ((entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, started: boolean, colliderHandleA: number, colliderHandleB: number) =&gt; void)
 
 
 </td><td>

package/docs/server.hytopia.entity.onblockcollision.md

@@ -9,5 +9,10 @@ A function that is called when the entity collides with a block.
 **Signature:**
 
 ```typescript
-onBlockCollision?: (entity: Entity, blockType: BlockType, started: boolean) => void;
+onBlockCollision?: ((entity: Entity, blockType: BlockType, started: boolean) => void) | ((entity: Entity, blockType: BlockType, started: boolean, colliderHandleA: number, colliderHandleB: number) => void);
 ```
+
+## Remarks
+
+This must be set before the entity is spawned.
+

package/docs/server.hytopia.entity.onblockcontactforce.md

@@ -11,3 +11,8 @@ A function that is called when the entity collides with a block.
 ```typescript
 onBlockContactForce?: (entity: Entity, blockType: BlockType, contactForceData: ContactForceData) => void;
 ```
+
+## Remarks
+
+This must be set before the entity is spawned.
+

package/docs/server.hytopia.entity.onentitycollision.md

@@ -9,5 +9,10 @@ A function that is called when the entity collides with another entity.
 **Signature:**
 
 ```typescript
-onEntityCollision?: (entity: Entity, otherEntity: Entity, started: boolean) => void;
+onEntityCollision?: ((entity: Entity, otherEntity: Entity, started: boolean) => void) | ((entity: Entity, otherEntity: Entity, started: boolean, colliderHandleA: number, colliderHandleB: number) => void);
 ```
+
+## Remarks
+
+This must be set before the entity is spawned.
+

package/docs/server.hytopia.entity.onentitycontactforce.md

@@ -11,3 +11,8 @@ A function that is called when the entity contacts another entity.
 ```typescript
 onEntityContactForce?: (entity: Entity, otherEntity: Entity, contactForceData: ContactForceData) => void;
 ```
+
+## Remarks
+
+This must be set before the entity is spawned.
+

package/docs/server.hytopia.entity.startmodelloopedanimations.md

@@ -51,3 +51,7 @@ The animations to start.
 
 void
 
+## Remarks
+
+This method will be ignored and do nothing if the entity is a block entity.
+

package/docs/server.hytopia.entity.startmodeloneshotanimations.md

@@ -51,3 +51,7 @@ The animations to start.
 
 void
 
+## Remarks
+
+This method will be ignored and do nothing if the entity is a block entity.
+

package/docs/server.hytopia.entity.stopmodelanimations.md

@@ -51,3 +51,7 @@ The animations to stop.
 
 void
 
+## Remarks
+
+This method will be ignored and do nothing if the entity is a block entity.
+

package/docs/server.hytopia.md

@@ -387,6 +387,17 @@ Event types a ChatManager instance can emit.
 Event types a Chunk instance can emit.
 
 
+</td></tr>
+<tr><td>
+
+[CoefficientCombineRule](./server.hytopia.coefficientcombinerule.md)
+
+
+</td><td>
+
+The coefficient for friction or bounciness combine rule.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.hytopia.simulation.getcontactmanifolds.md

@@ -0,0 +1,75 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Simulation](./server.hytopia.simulation.md) &gt; [getContactManifolds](./server.hytopia.simulation.getcontactmanifolds.md)
+
+## HYTOPIA.Simulation.getContactManifolds() method
+
+Gets the contact manifolds for a pair of colliders.
+
+**Signature:**
+
+```typescript
+getContactManifolds(colliderHandleA: RAPIER.ColliderHandle, colliderHandleB: RAPIER.ColliderHandle): ContactManifold[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+colliderHandleA
+
+
+</td><td>
+
+RAPIER.ColliderHandle
+
+
+</td><td>
+
+The handle of the first collider.
+
+
+</td></tr>
+<tr><td>
+
+colliderHandleB
+
+
+</td><td>
+
+RAPIER.ColliderHandle
+
+
+</td><td>
+
+The handle of the second collider.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+ContactManifold\[\]
+
+The contact manifolds, or an empty array if no contact.
+
+## Remarks
+
+Contact manifolds will not be returned for contacts that involve sensors.
+

package/docs/server.hytopia.simulation.md

@@ -172,6 +172,20 @@ Casts a ray through the simulation.
 Enables or disables debug rendering for the simulation. When enabled, all colliders, rigid body and raycast outlines will be rendered in the world. Do not enable this in production. In large worlds enabling this can cause noticable lag and RTT spikes.
 
 
+</td></tr>
+<tr><td>
+
+[getContactManifolds(colliderHandleA, colliderHandleB)](./server.hytopia.simulation.getcontactmanifolds.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the contact manifolds for a pair of colliders.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.md

@@ -387,6 +387,17 @@ Event types a ChatManager instance can emit.
 Event types a Chunk instance can emit.
 
 
+</td></tr>
+<tr><td>
+
+[CoefficientCombineRule](./server.coefficientcombinerule.md)
+
+
+</td><td>
+
+The coefficient for friction or bounciness combine rule.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.simulation.getcontactmanifolds.md

@@ -0,0 +1,75 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Simulation](./server.simulation.md) &gt; [getContactManifolds](./server.simulation.getcontactmanifolds.md)
+
+## Simulation.getContactManifolds() method
+
+Gets the contact manifolds for a pair of colliders.
+
+**Signature:**
+
+```typescript
+getContactManifolds(colliderHandleA: RAPIER.ColliderHandle, colliderHandleB: RAPIER.ColliderHandle): ContactManifold[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+colliderHandleA
+
+
+</td><td>
+
+RAPIER.ColliderHandle
+
+
+</td><td>
+
+The handle of the first collider.
+
+
+</td></tr>
+<tr><td>
+
+colliderHandleB
+
+
+</td><td>
+
+RAPIER.ColliderHandle
+
+
+</td><td>
+
+The handle of the second collider.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+ContactManifold\[\]
+
+The contact manifolds, or an empty array if no contact.
+
+## Remarks
+
+Contact manifolds will not be returned for contacts that involve sensors.
+

package/docs/server.simulation.md

@@ -172,6 +172,20 @@ Casts a ray through the simulation.
 Enables or disables debug rendering for the simulation. When enabled, all colliders, rigid body and raycast outlines will be rendered in the world. Do not enable this in production. In large worlds enabling this can cause noticable lag and RTT spikes.
 
 
+</td></tr>
+<tr><td>
+
+[getContactManifolds(colliderHandleA, colliderHandleB)](./server.simulation.getcontactmanifolds.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the contact manifolds for a pair of colliders.
+
+
 </td></tr>
 <tr><td>
 

package/examples/big-world/README.md

@@ -0,0 +1,15 @@
+# big-world
+
+To install dependencies:
+
+```bash
+bun install
+```
+
+To run:
+
+```bash
+bun run index.ts
+```
+
+This project was created using `bun init` in bun v1.1.26. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.

package/examples/big-world/index.ts

@@ -0,0 +1,41 @@
+import {
+  startServer,
+  PlayerEntity,
+} from 'hytopia';
+
+import worldMap from './assets/map.json';
+
+/**
+ * This example loads and simulates extremely large map that is
+ * 750^2 blocks in area. Approximately 2,000,000+ blocks are loaded,
+ * resulting in thousands of chunks and a large amount of physics vertices.
+ * 
+ * This example is meant to showcase the performance of the server.
+ * When dealing with large fully simulated worlds, as well as benchmark
+ * and test client performance.
+ * 
+ * Client load times may take a few seconds because batch
+ * loading is not yet implemented.
+ */
+
+startServer(world => {
+  world.loadMap(worldMap);
+
+  // Spawn a player entity when a player joins the game.
+  world.onPlayerJoin = player => {
+    const playerEntity = new PlayerEntity({
+      player,
+      name: 'Player',
+      modelUri: 'models/player.gltf',
+      modelLoopedAnimations: [ 'idle' ],
+      modelScale: 0.5,
+    });
+  
+    playerEntity.spawn(world, { x: 0, y: 10, z: 0 });
+  };
+
+  // Despawn all player entities when a player leaves the game.
+  world.onPlayerLeave = player => {
+    world.entityManager.getAllPlayerEntities(player).forEach(entity => entity.despawn());
+  };
+});

package/examples/block-entity/index.ts

@@ -12,7 +12,10 @@ import worldMap from './assets/map.json';
 
 startServer(world => {
   // Boilerplate
-  world.simulation.enableDebugRendering(true);
+  
+  // Uncomment this to visualize physics vertices, will cause noticable lag.
+  // world.simulation.enableDebugRendering(true);
+  
   world.loadMap(worldMap);
   world.onPlayerJoin = player => {
     const playerEntity = new PlayerEntity({

package/examples/character-controller/MyCharacterController.ts

@@ -5,6 +5,7 @@ import {
   Collider,
   Entity,
   ColliderShape,
+  CoefficientCombineRule,
   BlockType,
 } from 'hytopia';
 
@@ -47,14 +48,14 @@ export default class MyCharacterController extends BaseCharacterController {
   public get platform(): Entity | undefined { return this._platform; }
 
   /**
-   * Create the sensor colliders for the character controller.
+   * Create the colliders for the character controller.
    */
-  public createSensorColliders(): Collider[] {
+  public createColliders(): Collider[] {
     if (!this.entity.isSpawned) {
       throw new Error('CharacterController.createSensorColliders(): Entity is not spawned!');
     }
 
-    const sensorColliders: Collider[] = [];
+    const colliders: Collider[] = [];
 
     /**
      * Our ground sensor detects when we're on the ground.
@@ -63,7 +64,7 @@ export default class MyCharacterController extends BaseCharacterController {
      * by the DEFAULT_ENTITY_RIGID_BODY_OPTIONS constant of
      * the hytopia package.
      */
-    sensorColliders.push(new Collider({
+    colliders.push(new Collider({
       shape: ColliderShape.CYLINDER,
       radius: 0.30,
       halfHeight: 0.125,
@@ -95,7 +96,26 @@ export default class MyCharacterController extends BaseCharacterController {
       },
     }));
 
-    return sensorColliders;
+    /**
+     * A wall collider slightly larger than our player hitbox with
+     * a collision group that only collides with blocks. This prevent
+     * sticking and friction to blocks as a player moves, creating
+     * a smooth slide effect on walls that we jump into, etc.
+     */
+    colliders.push(new Collider({
+      shape: ColliderShape.CAPSULE,
+      halfHeight: 0.30,
+      radius: 0.37,
+      collisionGroups: {
+        belongsTo: [ CollisionGroup.ENTITY_SENSOR ],
+        collidesWith: [ CollisionGroup.BLOCK ],
+      },
+      friction: 0,
+      frictionCombineRule: CoefficientCombineRule.Min,
+      tag: 'wallCollider',
+    }));
+
+    return colliders;
   }
 
   /**

package/examples/character-controller/index.ts

@@ -8,7 +8,9 @@ import MyCharacterController from './MyCharacterController';
 import worldMap from './assets/map.json';
 
 startServer(world => {
-  world.simulation.enableDebugRendering(true);
+  // Uncomment this to visualize physics vertices, will cause noticable lag.
+  // world.simulation.enableDebugRendering(true);
+  
   world.loadMap(worldMap);
 
   world.onPlayerJoin = player => {

package/examples/entity-spawn/index.ts

@@ -67,7 +67,9 @@ startServer(world => {
  * Boilerplate setup for our example
  */
 function setup(world: World) {
-  world.simulation.enableDebugRendering(true);
+  // Uncomment this to visualize physics vertices, will cause noticable lag.
+  // world.simulation.enableDebugRendering(true);
+  
   world.loadMap(worldMap);
 
   // Spawn a player entity when a player joins the game.

package/examples/payload-game/index.ts

@@ -90,8 +90,8 @@ let targetWaypointCoordinateIndex = 0; // Current waypoint coordinate index for
 startServer(world => { // Perform our game setup logic in the startServer init callback here.
   const chatManager = world.chatManager;
 
-  // Enable debug rendering
-  //  world.simulation.enableDebugRendering(true);
+  // Uncomment this to visualize physics vertices, will cause noticable lag.
+  // world.simulation.enableDebugRendering(true);
 
   // Load Map
   world.loadMap(map);

package/package.json

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