hytopia 0.1.52 → 0.1.54

package/server.api.json

@@ -3011,6 +3011,56 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!Block#getNeighborGlobalCoordinateFromHitPoint:member(1)",
+              "docComment": "/**\n * Gets the most adjacent neighbor global coordinate of this block based on a relative hit point, typically from a raycast.\n *\n * @param hitPoint - The hit point on this block to get the neighbor coordinate from.\n *\n * @returns A neighbor global coordinate of this block based on the hit point.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getNeighborGlobalCoordinateFromHitPoint(hitPoint: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Vector3Like",
+                  "canonicalReference": "server!Vector3Like:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Vector3Like",
+                  "canonicalReference": "server!Vector3Like:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "hitPoint",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getNeighborGlobalCoordinateFromHitPoint"
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!Block#globalCoordinate:member",
@@ -3324,7 +3374,7 @@
                 {
                   "kind": "Reference",
                   "text": "ContactForceData",
-                  "canonicalReference": "server!~ContactForceData:type"
+                  "canonicalReference": "server!ContactForceData:type"
                 },
                 {
                   "kind": "Content",
@@ -8434,6 +8484,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 +9959,7 @@
                 {
                   "kind": "Reference",
                   "text": "ContactForceData",
-                  "canonicalReference": "server!~ContactForceData:type"
+                  "canonicalReference": "server!ContactForceData:type"
                 },
                 {
                   "kind": "Content",
@@ -9974,7 +10121,7 @@
                 {
                   "kind": "Reference",
                   "text": "ContactForceData",
-                  "canonicalReference": "server!~ContactForceData:type"
+                  "canonicalReference": "server!ContactForceData:type"
                 },
                 {
                   "kind": "Content",
@@ -13232,50 +13379,6 @@
               "isProtected": false,
               "isAbstract": false
             },
-            {
-              "kind": "Property",
-              "canonicalReference": "server!Player#cameraOrientation:member",
-              "docComment": "/**\n * The current {@link PlayerCameraOrientation} of the player.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "get cameraOrientation(): "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Readonly",
-                  "canonicalReference": "!Readonly:type"
-                },
-                {
-                  "kind": "Content",
-                  "text": "<"
-                },
-                {
-                  "kind": "Reference",
-                  "text": "PlayerCameraOrientation",
-                  "canonicalReference": "server!PlayerCameraOrientation:type"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": true,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "cameraOrientation",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 5
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
-            },
             {
               "kind": "Method",
               "canonicalReference": "server!Player#disconnect:member(1)",
@@ -13655,6 +13758,37 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PlayerCamera#facingDirection:member",
+              "docComment": "/**\n * The facing direction vector of the camera based on its current orientation.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get facingDirection(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Vector3Like",
+                  "canonicalReference": "server!Vector3Like:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "facingDirection",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!PlayerCamera#filmOffset:member",
@@ -13940,6 +14074,37 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PlayerCamera#orientation:member",
+              "docComment": "/**\n * The current orientation of the camera.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get orientation(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PlayerCameraOrientation",
+                  "canonicalReference": "server!PlayerCameraOrientation:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "orientation",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!PlayerCamera#player:member",
@@ -15888,7 +16053,7 @@
         {
           "kind": "Enum",
           "canonicalReference": "server!PlayerCameraMode:enum",
-          "docComment": "",
+          "docComment": "/**\n * The mode of the camera.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -15962,7 +16127,7 @@
               "text": ";"
             }
           ],
-          "fileUrlPath": "src/networking/players/Player.ts",
+          "fileUrlPath": "src/networking/players/PlayerCamera.ts",
           "releaseTag": "Public",
           "name": "PlayerCameraOrientation",
           "typeTokenRange": {
@@ -17099,7 +17264,7 @@
         {
           "kind": "Enum",
           "canonicalReference": "server!PlayerUIEventType:enum",
-          "docComment": "/**\n * Event types a\n */\n",
+          "docComment": "/**\n * Event types a PlayerUI can emit.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -18583,6 +18748,121 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "server!RaycastHit:type",
+          "docComment": "/**\n * A hit result from a raycast.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type RaycastHit = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    hitBlock?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Block",
+              "canonicalReference": "server!Block:class"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    hitEntity?: "
+            },
+            {
+              "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",
@@ -22811,7 +23091,7 @@
                 {
                   "kind": "Reference",
                   "text": "ContactManifold",
-                  "canonicalReference": "server!~ContactManifold:type"
+                  "canonicalReference": "server!ContactManifold:type"
                 },
                 {
                   "kind": "Content",
@@ -22981,7 +23261,7 @@
                 {
                   "kind": "Reference",
                   "text": "RaycastOptions",
-                  "canonicalReference": "server!~RaycastOptions:type"
+                  "canonicalReference": "server!RaycastOptions:type"
                 },
                 {
                   "kind": "Content",
@@ -22990,7 +23270,7 @@
                 {
                   "kind": "Reference",
                   "text": "RaycastHit",
-                  "canonicalReference": "server!~RaycastHit:type"
+                  "canonicalReference": "server!RaycastHit:type"
                 },
                 {
                   "kind": "Content",

package/server.d.ts

@@ -348,6 +348,14 @@ export declare class Block {
     readonly blockType: BlockType;
 
 
+    /**
+     * Gets the most adjacent neighbor global coordinate of this block
+     * based on a relative hit point, typically from a raycast.
+     *
+     * @param hitPoint - The hit point on this block to get the neighbor coordinate from.
+     * @returns A neighbor global coordinate of this block based on the hit point.
+     */
+    getNeighborGlobalCoordinateFromHitPoint(hitPoint: Vector3Like): Vector3Like;
 }
 
 /**
@@ -1121,7 +1129,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. */
@@ -1133,7 +1141,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. */
@@ -1820,11 +1828,8 @@ export declare class Player {
 
 
 
-
     /** The current {@link PlayerInput} of the player. */
     get input(): Readonly<PlayerInput>;
-    /** The current {@link PlayerCameraOrientation} of the player. */
-    get cameraOrientation(): Readonly<PlayerCameraOrientation>;
     /** The current {@link World} the player is in. */
     get world(): World | undefined;
     /**
@@ -1884,10 +1889,13 @@ export declare class PlayerCamera implements protocol.Serializable {
 
 
 
+
     /** The entity the camera is attached to. */
     get attachedToEntity(): Entity | undefined;
     /** The position the camera is attached to. */
     get attachedToPosition(): Vector3Like | undefined;
+    /** The facing direction vector of the camera based on its current orientation. */
+    get facingDirection(): Vector3Like;
     /** The film offset of the camera. A positive value shifts the camera right, a negative value shifts it left. */
     get filmOffset(): number;
     /** Only used in first-person mode. The forward offset of the camera. A positive number shifts the camera forward, a negative number shifts it backward. */
@@ -1900,6 +1908,8 @@ export declare class PlayerCamera implements protocol.Serializable {
     get mode(): PlayerCameraMode;
     /** The relative offset of the camera from the entity or position it is attached to. */
     get offset(): Vector3Like;
+    /** The current orientation of the camera. */
+    get orientation(): PlayerCameraOrientation;
     /** The entity the camera will constantly look at, even if the camera attached or tracked entity moves. */
     get trackedEntity(): Entity | undefined;
     /** The position the camera will constantly look at, even if the camera attached entity moves. */
@@ -1966,6 +1976,8 @@ export declare class PlayerCamera implements protocol.Serializable {
      * @param offset - The offset to set.
      */
     setOffset(offset: Vector3Like): void;
+
+
     /**
      * Sets the entity the camera will constantly look at,
      * even if the camera attached or tracked entity moves.
@@ -2060,6 +2072,7 @@ export declare enum PlayerCameraEventType {
     SET_ZOOM = "PLAYER_CAMERA.SET_ZOOM"
 }
 
+/** The mode of the camera. @public */
 export declare enum PlayerCameraMode {
     FIRST_PERSON = 0,
     THIRD_PERSON = 1
@@ -2239,7 +2252,7 @@ export declare namespace PlayerUIEventPayload {
     }
 }
 
-/** Event types a  */
+/** Event types a PlayerUI can emit. @public */
 export declare enum PlayerUIEventType {
     LOAD = "PLAYER_UI.LOAD",
     SEND_DATA = "PLAYER_UI.SEND_DATA"
@@ -2433,9 +2446,12 @@ 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;
+/** A hit result from a raycast. @public */
+export declare type RaycastHit = {
+    /** The block the raycast hit. */
+    hitBlock?: Block;
+    /** The entity the raycast hit */
+    hitEntity?: Entity;
     /** The point in global coordinate space the raycast hit the object. */
     hitPoint: Vector3Like;
     /** The distance from origin where the raycast hit. */
@@ -2443,7 +2459,7 @@ declare type RaycastHit = {
 };
 
 /** Options for raycasting. @public */
-declare type RaycastOptions = {
+export declare type RaycastOptions = {
     /** Whether to ignore sensor colliders. */
     ignoresSensors?: boolean;
     /** The query filter flags. */