hytopia 0.1.51 → 0.1.52

package/docs/server.basecharactercontroller.md

@@ -128,7 +128,7 @@ _(Optional)_ A callback function for when the controller ticks.
 
 </td><td>
 
-_(Optional)_ A callback function for when the controller ticks player movement. This is called every tick by a PlayerEntity with a character controller.
+_(Optional)_ A callback function for when the controller ticks player movement.
 
 
 </td></tr>
@@ -190,7 +190,7 @@ Override this method to handle entity movements based on your character controll
 
 </td><td>
 
-Override this method to handle entity movements based on player input for your character controller.
+Override this method to handle entity movements based on player input for your character controller. This is called every tick by a PlayerEntity with a character controller.
 
 
 </td></tr>

package/docs/server.basecharactercontroller.ontickwithplayerinput.md

@@ -4,7 +4,7 @@
 
 ## BaseCharacterController.onTickWithPlayerInput property
 
-A callback function for when the controller ticks player movement. This is called every tick by a PlayerEntity with a character controller.
+A callback function for when the controller ticks player movement.
 
 **Signature:**
 

package/docs/server.basecharactercontroller.tickwithplayerinput.md

@@ -4,7 +4,7 @@
 
 ## BaseCharacterController.tickWithPlayerInput() method
 
-Override this method to handle entity movements based on player input for your character controller.
+Override this method to handle entity movements based on player input for your character controller. This is called every tick by a PlayerEntity with a character controller.
 
 **Signature:**
 

package/docs/server.simulation.md

@@ -168,7 +168,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[castRay(origin, direction, length, options)](./server.simulation.castray.md)
+[enableDebugRaycasting(enabled)](./server.simulation.enabledebugraycasting.md)
 
 
 </td><td>
@@ -176,13 +176,13 @@ Description
 
 </td><td>
 
-Casts a ray through the simulation.
+Enables or disables debug raycasting for the simulation. This will render lines for the raycast that disappear after a few seconds.
 
 
 </td></tr>
 <tr><td>
 
-[enableDebugRaycasting(enabled)](./server.simulation.enabledebugraycasting.md)
+[enableDebugRendering(enabled)](./server.simulation.enabledebugrendering.md)
 
 
 </td><td>
@@ -190,13 +190,13 @@ Casts a ray through the simulation.
 
 </td><td>
 
-Enables or disables debug raycasting for the simulation. This will render lines for the raycast that disappear after a few seconds.
+Enables or disables debug rendering for the simulation. When enabled, all colliders and rigid body 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>
 
-[enableDebugRendering(enabled)](./server.simulation.enabledebugrendering.md)
+[getContactManifolds(colliderHandleA, colliderHandleB)](./server.simulation.getcontactmanifolds.md)
 
 
 </td><td>
@@ -204,13 +204,13 @@ Enables or disables debug raycasting for the simulation. This will render lines
 
 </td><td>
 
-Enables or disables debug rendering for the simulation. When enabled, all colliders and rigid body 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.
+Gets the contact manifolds for a pair of colliders.
 
 
 </td></tr>
 <tr><td>
 
-[getContactManifolds(colliderHandleA, colliderHandleB)](./server.simulation.getcontactmanifolds.md)
+[raycast(origin, direction, length, options)](./server.simulation.raycast.md)
 
 
 </td><td>
@@ -218,7 +218,7 @@ Enables or disables debug rendering for the simulation. When enabled, all collid
 
 </td><td>
 
-Gets the contact manifolds for a pair of colliders.
+Casts a ray through the simulation.
 
 
 </td></tr>

package/docs/{server.simulation.castray.md → server.simulation.raycast.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; [Simulation](./server.simulation.md) &gt; [castRay](./server.simulation.castray.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [Simulation](./server.simulation.md) &gt; [raycast](./server.simulation.raycast.md)
 
-## Simulation.castRay() method
+## Simulation.raycast() method
 
 Casts a ray through the simulation.
 
 **Signature:**
 
 ```typescript
-castRay(origin: RAPIER.Vector3, direction: RAPIER.Vector3, length: number, options?: RayCastOptions): Block | Entity | null;
+raycast(origin: RAPIER.Vector3, direction: RAPIER.Vector3, length: number, options?: RaycastOptions): RaycastHit | null;
 ```
 
 ## Parameters
@@ -85,7 +85,7 @@ options
 
 </td><td>
 
-RayCastOptions
+RaycastOptions
 
 
 </td><td>
@@ -97,7 +97,11 @@ _(Optional)_ The options for the raycast.
 </tbody></table>
 **Returns:**
 
-[Block](./server.block.md) \| [Entity](./server.entity.md) \| null
+RaycastHit \| null
 
-The first block or entity hit by the ray, or null if no hit.
+A RaycastHit object containing the first block or entity hit by the ray, or null if no hit.
+
+## Remarks
+
+The cast ray will stop at the the first block or entity hit within the length of the ray.
 

package/package.json

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

@@ -2786,7 +2786,7 @@
             {
               "kind": "Property",
               "canonicalReference": "server!BaseCharacterController#onTickWithPlayerInput:member",
-              "docComment": "/**\n * A callback function for when the controller ticks player movement. This is called every tick by a PlayerEntity with a character controller.\n *\n * @param input - The current input state of the player.\n *\n * @param cameraOrientation - The current camera orientation state of the player.\n *\n * @param deltaTimeMs - The delta time in milliseconds since the last tick.\n */\n",
+              "docComment": "/**\n * A callback function for when the controller ticks player movement.\n *\n * @param input - The current input state of the player.\n *\n * @param cameraOrientation - The current camera orientation state of the player.\n *\n * @param deltaTimeMs - The delta time in milliseconds since the last tick.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -2882,7 +2882,7 @@
             {
               "kind": "Method",
               "canonicalReference": "server!BaseCharacterController#tickWithPlayerInput:member(1)",
-              "docComment": "/**\n * Override this method to handle entity movements based on player input for your character controller.\n *\n * @param input - The current input state of the player.\n *\n * @param cameraOrientation - The current camera orientation state of the player.\n *\n * @param deltaTimeMs - The delta time in milliseconds since the last tick.\n */\n",
+              "docComment": "/**\n * Override this method to handle entity movements based on player input for your character controller. This is called every tick by a PlayerEntity with a character controller.\n *\n * @param input - The current input state of the player.\n *\n * @param cameraOrientation - The current camera orientation state of the player.\n *\n * @param deltaTimeMs - The delta time in milliseconds since the last tick.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -22685,119 +22685,6 @@
           "name": "Simulation",
           "preserveMemberOrder": false,
           "members": [
-            {
-              "kind": "Method",
-              "canonicalReference": "server!Simulation#castRay:member(1)",
-              "docComment": "/**\n * Casts a ray through the simulation.\n *\n * @param origin - The origin of the ray.\n *\n * @param direction - The direction of the ray.\n *\n * @param length - The length of the ray.\n *\n * @param options - The options for the raycast.\n *\n * @returns The first block or entity hit by the ray, or null if no hit.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "castRay(origin: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "RAPIER.Vector3",
-                  "canonicalReference": "@dimforge/rapier3d-compat!Vector3:class"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", direction: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "RAPIER.Vector3",
-                  "canonicalReference": "@dimforge/rapier3d-compat!Vector3:class"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", length: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "number"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", options?: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "RayCastOptions",
-                  "canonicalReference": "server!~RayCastOptions:type"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Block",
-                  "canonicalReference": "server!Block:class"
-                },
-                {
-                  "kind": "Content",
-                  "text": " | "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Entity",
-                  "canonicalReference": "server!Entity:class"
-                },
-                {
-                  "kind": "Content",
-                  "text": " | null"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 9,
-                "endIndex": 13
-              },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "origin",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "direction",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 3,
-                    "endIndex": 4
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "length",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 5,
-                    "endIndex": 6
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "options",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 7,
-                    "endIndex": 8
-                  },
-                  "isOptional": true
-                }
-              ],
-              "isOptional": false,
-              "isAbstract": false,
-              "name": "castRay"
-            },
             {
               "kind": "Method",
               "canonicalReference": "server!Simulation#enableDebugRaycasting:member(1)",
@@ -23056,6 +22943,110 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!Simulation#raycast:member(1)",
+              "docComment": "/**\n * Casts a ray through the simulation.\n *\n * @remarks\n *\n * The cast ray will stop at the the first block or entity hit within the length of the ray.\n *\n * @param origin - The origin of the ray.\n *\n * @param direction - The direction of the ray.\n *\n * @param length - The length of the ray.\n *\n * @param options - The options for the raycast.\n *\n * @returns A RaycastHit object containing the first block or entity hit by the ray, or null if no hit.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "raycast(origin: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RAPIER.Vector3",
+                  "canonicalReference": "@dimforge/rapier3d-compat!Vector3:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", direction: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RAPIER.Vector3",
+                  "canonicalReference": "@dimforge/rapier3d-compat!Vector3:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", length: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", options?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RaycastOptions",
+                  "canonicalReference": "server!~RaycastOptions:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RaycastHit",
+                  "canonicalReference": "server!~RaycastHit:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | null"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 9,
+                "endIndex": 11
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "origin",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "direction",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "length",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "options",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "raycast"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!Simulation#setGravity:member(1)",

package/server.d.ts

@@ -296,8 +296,7 @@ export declare abstract class BaseCharacterController {
     onTick?: (deltaTimeMs: number) => void;
     /**
      * A callback function for when the controller ticks
-     * player movement. This is called every tick by a
-     * PlayerEntity with a character controller.
+     * player movement.
      * @param input - The current input state of the player.
      * @param cameraOrientation - The current camera orientation state of the player.
      * @param deltaTimeMs - The delta time in milliseconds since the last tick.
@@ -317,6 +316,8 @@ export declare abstract class BaseCharacterController {
     /**
      * Override this method to handle entity movements
      * based on player input for your character controller.
+     * This is called every tick by a PlayerEntity with a
+     * character controller.
      * @param input - The current input state of the player.
      * @param cameraOrientation - The current camera orientation state of the player.
      * @param deltaTimeMs - The delta time in milliseconds since the last tick.
@@ -2432,8 +2433,17 @@ export declare interface QuaternionLike {
 /** A raw set of collision groups represented as a 32-bit number. @public */
 export declare type RawCollisionGroups = RAPIER.InteractionGroups;
 
+declare type RaycastHit = {
+    /** The block or entity the raycast hit. */
+    hitObject: Block | Entity;
+    /** The point in global coordinate space the raycast hit the object. */
+    hitPoint: Vector3Like;
+    /** The distance from origin where the raycast hit. */
+    hitDistance: number;
+};
+
 /** Options for raycasting. @public */
-declare type RayCastOptions = {
+declare type RaycastOptions = {
     /** Whether to ignore sensor colliders. */
     ignoresSensors?: boolean;
     /** The query filter flags. */
@@ -3003,13 +3013,18 @@ export declare class Simulation {
     get world(): World;
     /**
      * Casts a ray through the simulation.
+     *
+     * @remarks
+     * The cast ray will stop at the the first block or
+     * entity hit within the length of the ray.
+     *
      * @param origin - The origin of the ray.
      * @param direction - The direction of the ray.
      * @param length - The length of the ray.
      * @param options - The options for the raycast.
-     * @returns The first block or entity hit by the ray, or null if no hit.
+     * @returns A RaycastHit object containing the first block or entity hit by the ray, or null if no hit.
      */
-    castRay(origin: RAPIER.Vector3, direction: RAPIER.Vector3, length: number, options?: RayCastOptions): Block | Entity | null;
+    raycast(origin: RAPIER.Vector3, direction: RAPIER.Vector3, length: number, options?: RaycastOptions): RaycastHit | null;
 
 
     /**