hytopia 0.1.51 → 0.1.53

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",
@@ -3324,7 +3324,7 @@
                 {
                   "kind": "Reference",
                   "text": "ContactForceData",
-                  "canonicalReference": "server!~ContactForceData:type"
+                  "canonicalReference": "server!ContactForceData:type"
                 },
                 {
                   "kind": "Content",
@@ -8434,6 +8434,103 @@
             "endIndex": 4
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "server!ContactForceData:type",
+          "docComment": "/**\n * Data for contact forces.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type ContactForceData = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    totalForce: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RAPIER.Vector",
+              "canonicalReference": "@dimforge/rapier3d-compat!Vector:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    totalForceMagnitude: number;\n    maxForceDirection: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RAPIER.Vector",
+              "canonicalReference": "@dimforge/rapier3d-compat!Vector:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    maxForceMagnitude: number;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/world/physics/Simulation.ts",
+          "releaseTag": "Public",
+          "name": "ContactForceData",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "server!ContactManifold:type",
+          "docComment": "/**\n * A contact manifold.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type ContactManifold = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    localNormalA: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Vector3Like",
+              "canonicalReference": "server!Vector3Like:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    localNormalB: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Vector3Like",
+              "canonicalReference": "server!Vector3Like:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    normal: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Vector3Like",
+              "canonicalReference": "server!Vector3Like:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/world/physics/Simulation.ts",
+          "releaseTag": "Public",
+          "name": "ContactManifold",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "server!DecodedCollisionGroups:type",
@@ -9812,7 +9909,7 @@
                 {
                   "kind": "Reference",
                   "text": "ContactForceData",
-                  "canonicalReference": "server!~ContactForceData:type"
+                  "canonicalReference": "server!ContactForceData:type"
                 },
                 {
                   "kind": "Content",
@@ -9974,7 +10071,7 @@
                 {
                   "kind": "Reference",
                   "text": "ContactForceData",
-                  "canonicalReference": "server!~ContactForceData:type"
+                  "canonicalReference": "server!ContactForceData:type"
                 },
                 {
                   "kind": "Content",
@@ -18583,6 +18680,121 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "server!RaycastHit:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type RaycastHit = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    hitObject: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Block",
+              "canonicalReference": "server!Block:class"
+            },
+            {
+              "kind": "Content",
+              "text": " | "
+            },
+            {
+              "kind": "Reference",
+              "text": "Entity",
+              "canonicalReference": "server!Entity:class"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    hitPoint: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Vector3Like",
+              "canonicalReference": "server!Vector3Like:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    hitDistance: number;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/world/physics/Simulation.ts",
+          "releaseTag": "Public",
+          "name": "RaycastHit",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "server!RaycastOptions:type",
+          "docComment": "/**\n * Options for raycasting.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type RaycastOptions = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    ignoresSensors?: boolean;\n    filterFlags?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RAPIER.QueryFilterFlags",
+              "canonicalReference": "@dimforge/rapier3d-compat!QueryFilterFlags:enum"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    filterGroups?: number;\n    filterExcludeCollider?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RAPIER.Collider",
+              "canonicalReference": "@dimforge/rapier3d-compat!Collider:class"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    filterExcludeRigidBody?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RAPIER.RigidBody",
+              "canonicalReference": "@dimforge/rapier3d-compat!RigidBody:class"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    filterPredicate?: (collider: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RAPIER.Collider",
+              "canonicalReference": "@dimforge/rapier3d-compat!Collider:class"
+            },
+            {
+              "kind": "Content",
+              "text": ") => boolean;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/world/physics/Simulation.ts",
+          "releaseTag": "Public",
+          "name": "RaycastOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 10
+          }
+        },
         {
           "kind": "Interface",
           "canonicalReference": "server!RgbColor:interface",
@@ -22685,119 +22897,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)",
@@ -22924,7 +23023,7 @@
                 {
                   "kind": "Reference",
                   "text": "ContactManifold",
-                  "canonicalReference": "server!~ContactManifold:type"
+                  "canonicalReference": "server!ContactManifold:type"
                 },
                 {
                   "kind": "Content",
@@ -23056,6 +23155,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.
@@ -1120,7 +1121,7 @@ export declare class CollisionGroupsBuilder {
 export declare type CommandCallback = (player: Player, args: string[], message: string) => void;
 
 /** Data for contact forces. @public */
-declare type ContactForceData = {
+export declare type ContactForceData = {
     /** The total force vector. */
     totalForce: RAPIER.Vector;
     /** The magnitude of the total force. */
@@ -1132,7 +1133,7 @@ declare type ContactForceData = {
 };
 
 /** A contact manifold. @public */
-declare type ContactManifold = {
+export declare type ContactManifold = {
     /** The local normal vector of the first collider. */
     localNormalA: Vector3Like;
     /** The local normal vector of the second collider. */
@@ -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;
 
+export 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 = {
+export 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;
 
 
     /**