hytopia 0.1.37 → 0.1.40

package/docs/{server.playercamera.sethiddenmodelnodes.md → server.playercamera.setmodelhiddennodes.md}

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCamera](./server.playercamera.md) &gt; [setHiddenModelNodes](./server.playercamera.sethiddenmodelnodes.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCamera](./server.playercamera.md) &gt; [setModelHiddenNodes](./server.playercamera.setmodelhiddennodes.md)
 
-## PlayerCamera.setHiddenModelNodes() method
+## PlayerCamera.setModelHiddenNodes() method
 
 Sets the nodes of the model the camera is attached to that will not be rendered for the player. Uses case insensitive substring matching.
 
 **Signature:**
 
 ```typescript
-setHiddenModelNodes(hiddenModelNodes: string[]): void;
+setModelHiddenNodes(modelHiddenNodes: string[]): void;
 ```
 
 ## Parameters
@@ -32,7 +32,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-hiddenModelNodes
+modelHiddenNodes
 
 
 </td><td>

package/docs/server.playercameraeventpayload.md

@@ -90,7 +90,7 @@ Description
 </td></tr>
 <tr><td>
 
-[SetHiddenModelNodes](./server.playercameraeventpayload.sethiddenmodelnodes.md)
+[SetMode](./server.playercameraeventpayload.setmode.md)
 
 
 </td><td>
@@ -99,7 +99,7 @@ Description
 </td></tr>
 <tr><td>
 
-[SetMode](./server.playercameraeventpayload.setmode.md)
+[SetModelHiddenNodes](./server.playercameraeventpayload.setmodelhiddennodes.md)
 
 
 </td><td>

package/docs/{server.playercameraeventpayload.sethiddenmodelnodes.md → server.playercameraeventpayload.setmodelhiddennodes.md}

@@ -1,13 +1,13 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCameraEventPayload](./server.playercameraeventpayload.md) &gt; [SetHiddenModelNodes](./server.playercameraeventpayload.sethiddenmodelnodes.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCameraEventPayload](./server.playercameraeventpayload.md) &gt; [SetModelHiddenNodes](./server.playercameraeventpayload.setmodelhiddennodes.md)
 
-## PlayerCameraEventPayload.SetHiddenModelNodes interface
+## PlayerCameraEventPayload.SetModelHiddenNodes interface
 
 **Signature:**
 
 ```typescript
-interface SetHiddenModelNodes 
+interface SetModelHiddenNodes 
 ```
 
 ## Properties
@@ -35,7 +35,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[hiddenModelNodes](./server.playercameraeventpayload.sethiddenmodelnodes.hiddenmodelnodes.md)
+[modelHiddenNodes](./server.playercameraeventpayload.setmodelhiddennodes.modelhiddennodes.md)
 
 
 </td><td>
@@ -43,7 +43,7 @@ Description
 
 </td><td>
 
-string\[\]
+Set&lt;string&gt;
 
 
 </td><td>
@@ -52,7 +52,7 @@ string\[\]
 </td></tr>
 <tr><td>
 
-[playerCamera](./server.playercameraeventpayload.sethiddenmodelnodes.playercamera.md)
+[playerCamera](./server.playercameraeventpayload.setmodelhiddennodes.playercamera.md)
 
 
 </td><td>

package/docs/server.playercameraeventpayload.setmodelhiddennodes.modelhiddennodes.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCameraEventPayload](./server.playercameraeventpayload.md) &gt; [SetModelHiddenNodes](./server.playercameraeventpayload.setmodelhiddennodes.md) &gt; [modelHiddenNodes](./server.playercameraeventpayload.setmodelhiddennodes.modelhiddennodes.md)
+
+## PlayerCameraEventPayload.SetModelHiddenNodes.modelHiddenNodes property
+
+**Signature:**
+
+```typescript
+modelHiddenNodes: Set<string>;
+```

package/docs/{server.playercameraeventpayload.sethiddenmodelnodes.playercamera.md → server.playercameraeventpayload.setmodelhiddennodes.playercamera.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCameraEventPayload](./server.playercameraeventpayload.md) &gt; [SetHiddenModelNodes](./server.playercameraeventpayload.sethiddenmodelnodes.md) &gt; [playerCamera](./server.playercameraeventpayload.sethiddenmodelnodes.playercamera.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCameraEventPayload](./server.playercameraeventpayload.md) &gt; [SetModelHiddenNodes](./server.playercameraeventpayload.setmodelhiddennodes.md) &gt; [playerCamera](./server.playercameraeventpayload.setmodelhiddennodes.playercamera.md)
 
-## PlayerCameraEventPayload.SetHiddenModelNodes.playerCamera property
+## PlayerCameraEventPayload.SetModelHiddenNodes.playerCamera property
 
 **Signature:**
 

package/docs/server.playercameraeventtype.md

@@ -130,12 +130,12 @@ SET\_FOV
 </td></tr>
 <tr><td>
 
-SET\_HIDDEN\_MODEL\_NODES
+SET\_MODE
 
 
 </td><td>
 
-`"PLAYER_CAMERA.SET_HIDDEN_MODEL_NODES"`
+`"PLAYER_CAMERA.SET_MODE"`
 
 
 </td><td>
@@ -144,12 +144,12 @@ SET\_HIDDEN\_MODEL\_NODES
 </td></tr>
 <tr><td>
 
-SET\_MODE
+SET\_MODEL\_HIDDEN\_NODES
 
 
 </td><td>
 
-`"PLAYER_CAMERA.SET_MODE"`
+`"PLAYER_CAMERA.SET_MODEL_HIDDEN_NODES"`
 
 
 </td><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({
@@ -66,7 +69,7 @@ startServer(world => {
     rigidBodyOptions: {
       type: RigidBodyType.KINEMATIC_VELOCITY,
       angularVelocity: { x: 1, y: 1, z: 1 },
-    }
+    },
   });
 
   spinningBlock.spawn(world, { x: 0, y: 10, z: -6 });
@@ -88,7 +91,7 @@ startServer(world => {
     if (started) {
       world.chatManager.sendBroadcastMessage('The sand block was pushed!');
     }
-  }
+  };
 
   movableBlock.spawn(world, { x: -4, y: 10, z: -6 });
 
@@ -103,7 +106,7 @@ startServer(world => {
       type: RigidBodyType.DYNAMIC,
       additionalMass: 10,
       enabledRotations: { x: false, y: false, z: false },
-    }
+    },
   });
 
   heavyBlock.spawn(world, { x: -4, y: 10, z: -1 });
@@ -122,10 +125,10 @@ startServer(world => {
         {
           shape: ColliderShape.BLOCK,
           halfExtents: { x: 0.5, y: 0.5, z: 0.5 },
-          bounciness: 2
-        }
-      ]
-    }
+          bounciness: 2,
+        },
+      ],
+    },
   });
 
   bouncingBlock.spawn(world, { x: 0, y: 10, z: -3 });

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

@@ -34,8 +34,8 @@ import {
 import type {
   PlayerInputState,
   PlayerOrientationState,
-  Rotation,
-  Vector3,
+  QuaternionLike,
+  Vector3Like,
 } from 'hytopia';
 
 import map from './assets/map.json';
@@ -78,7 +78,7 @@ const PAYLOAD_WAYPOINT_ENEMY_SPAWNS = [
 // Simple game state tracking via globals.
 const enemyHealth: Record<number, number> = {}; // Entity id -> health
 const enemyPathfindAccumulators: Record<number, number> = {}; // Entity id -> accumulator, so we don't pathfind each tick
-const enemyPathfindingTargets: Record<number, Vector3> = {}; // Entity id -> target coordinate
+const enemyPathfindingTargets: Record<number, Vector3Like> = {}; // Entity id -> target coordinate
 const playerEntityHealth: Record<number, number> = {}; // Player entity id -> health
 let started = false; // Game started flag
 let payloadEntity: Entity | null = null; // Payload entity
@@ -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);
@@ -109,7 +109,7 @@ startServer(world => { // Perform our game setup logic in the startServer init c
     // Setup a first person camera for the player
     player.camera.setMode(PlayerCameraMode.FIRST_PERSON); // set first person mode
     player.camera.setOffset({ x: 0, y: 0.4, z: 0 }); // shift camrea up on Y axis so we see from "head" perspective.
-    player.camera.setHiddenModelNodes([ 'head', 'neck' ]); // hide the head node from the model so we don't see it in the camera, this is just hidden for the controlling player.
+    player.camera.setModelHiddenNodes([ 'head', 'neck' ]); // hide the head node from the model so we don't see it in the camera, this is just hidden for the controlling player.
     player.camera.setForwardOffset(0.3); // Shift the camera forward so we are looking slightly in front of where the player is looking.
 
     // Spawn the player entity at a random coordinate
@@ -207,7 +207,7 @@ function startEnemySpawnLoop(world: World) {
   spawn();
 }
 
-function spawnBullet(world: World, coordinate: Vector3, direction: Vector3) {
+function spawnBullet(world: World, coordinate: Vector3Like, direction: Vector3Like) {
   // Spawn a bullet when the player shoots.
   const bullet = new Entity({
     name: 'Bullet',
@@ -340,7 +340,7 @@ function spawnPayloadEntity(world: World) {
   })).play(world);
 } 
 
-function spawnSpider(world: World, coordinate: Vector3) {
+function spawnSpider(world: World, coordinate: Vector3Like) {
   const baseScale = 0.5;
   const baseSpeed = 3;
   const randomScaleMultiplier = Math.random() * 2 + 1; // Random value between 1 and 3 // Random scale multiplier to make each spider a different size
@@ -529,7 +529,7 @@ function damagePlayer(playerEntity: PlayerEntity) {
   }
 }
 
-function getDirectionFromOrientation(orientationState: PlayerOrientationState): Vector3 {
+function getDirectionFromOrientation(orientationState: PlayerOrientationState): Vector3Like {
   const { yaw, pitch } = orientationState;
   const cosPitch = Math.cos(pitch);
   
@@ -540,7 +540,7 @@ function getDirectionFromOrientation(orientationState: PlayerOrientationState):
   };
 }
 
-function getRotationFromDirection(direction: Vector3): Rotation {
+function getRotationFromDirection(direction: Vector3Like): QuaternionLike {
   // Calculate yaw (rotation around Y-axis)
   const yaw = Math.atan2(-direction.x, -direction.z);
   

package/package.json

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