hytopia 0.1.53 → 0.1.54

package/docs/server.block.getneighborglobalcoordinatefromhitpoint.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Block](./server.block.md) &gt; [getNeighborGlobalCoordinateFromHitPoint](./server.block.getneighborglobalcoordinatefromhitpoint.md)
+
+## Block.getNeighborGlobalCoordinateFromHitPoint() method
+
+Gets the most adjacent neighbor global coordinate of this block based on a relative hit point, typically from a raycast.
+
+**Signature:**
+
+```typescript
+getNeighborGlobalCoordinateFromHitPoint(hitPoint: Vector3Like): Vector3Like;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+hitPoint
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The hit point on this block to get the neighbor coordinate from.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector3Like](./server.vector3like.md)
+
+A neighbor global coordinate of this block based on the hit point.
+

package/docs/server.block.md

@@ -82,5 +82,39 @@ The block type of the block.
 The global coordinate of the block.
 
 
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getNeighborGlobalCoordinateFromHitPoint(hitPoint)](./server.block.getneighborglobalcoordinatefromhitpoint.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the most adjacent neighbor global coordinate of this block based on a relative hit point, typically from a raycast.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.md

@@ -472,6 +472,8 @@ Event types a PlayerCamera can emit.
 
 </td><td>
 
+The mode of the camera.
+
 
 </td></tr>
 <tr><td>
@@ -492,7 +494,7 @@ Event types a Player can emit.
 
 </td><td>
 
-Event types a
+Event types a PlayerUI can emit.
 
 
 </td></tr>
@@ -1095,6 +1097,8 @@ A raw set of collision groups represented as a 32-bit number.
 
 </td><td>
 
+A hit result from a raycast.
+
 
 </td></tr>
 <tr><td>

package/docs/server.player.md

@@ -61,27 +61,6 @@ Description
 The camera for the player.
 
 
-</td></tr>
-<tr><td>
-
-[cameraOrientation](./server.player.cameraorientation.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-Readonly&lt;[PlayerCameraOrientation](./server.playercameraorientation.md)<!-- -->&gt;
-
-
-</td><td>
-
-The current [PlayerCameraOrientation](./server.playercameraorientation.md) of the player.
-
-
 </td></tr>
 <tr><td>
 

package/docs/server.playercamera.facingdirection.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; [PlayerCamera](./server.playercamera.md) &gt; [facingDirection](./server.playercamera.facingdirection.md)
+
+## PlayerCamera.facingDirection property
+
+The facing direction vector of the camera based on its current orientation.
+
+**Signature:**
+
+```typescript
+get facingDirection(): Vector3Like;
+```

package/docs/server.playercamera.md

@@ -90,6 +90,27 @@ The entity the camera is attached to.
 The position the camera is attached to.
 
 
+</td></tr>
+<tr><td>
+
+[facingDirection](./server.playercamera.facingdirection.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The facing direction vector of the camera based on its current orientation.
+
+
 </td></tr>
 <tr><td>
 
@@ -216,6 +237,27 @@ The nodes of the model the camera is attached to that will not be rendered for t
 The relative offset of the camera from the entity or position it is attached to.
 
 
+</td></tr>
+<tr><td>
+
+[orientation](./server.playercamera.orientation.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[PlayerCameraOrientation](./server.playercameraorientation.md)
+
+
+</td><td>
+
+The current orientation of the camera.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playercamera.orientation.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; [PlayerCamera](./server.playercamera.md) &gt; [orientation](./server.playercamera.orientation.md)
+
+## PlayerCamera.orientation property
+
+The current orientation of the camera.
+
+**Signature:**
+
+```typescript
+get orientation(): PlayerCameraOrientation;
+```

package/docs/server.playercameramode.md

@@ -4,6 +4,8 @@
 
 ## PlayerCameraMode enum
 
+The mode of the camera.
+
 **Signature:**
 
 ```typescript

package/docs/server.playeruieventtype.md

@@ -4,7 +4,7 @@
 
 ## PlayerUIEventType enum
 
-Event types a
+Event types a PlayerUI can emit.
 
 **Signature:**
 

package/docs/server.raycasthit.md

@@ -4,11 +4,14 @@
 
 ## RaycastHit type
 
+A hit result from a raycast.
+
 **Signature:**
 
 ```typescript
 export type RaycastHit = {
-    hitObject: Block | Entity;
+    hitBlock?: Block;
+    hitEntity?: Entity;
     hitPoint: Vector3Like;
     hitDistance: number;
 };

package/package.json

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

@@ -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",
@@ -13329,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)",
@@ -13752,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",
@@ -14037,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",
@@ -15985,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",
@@ -16059,7 +16127,7 @@
               "text": ";"
             }
           ],
-          "fileUrlPath": "src/networking/players/Player.ts",
+          "fileUrlPath": "src/networking/players/PlayerCamera.ts",
           "releaseTag": "Public",
           "name": "PlayerCameraOrientation",
           "typeTokenRange": {
@@ -17196,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",
@@ -18683,7 +18751,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "server!RaycastHit:type",
-          "docComment": "",
+          "docComment": "/**\n * A hit result from a raycast.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -18691,7 +18759,7 @@
             },
             {
               "kind": "Content",
-              "text": "{\n    hitObject: "
+              "text": "{\n    hitBlock?: "
             },
             {
               "kind": "Reference",
@@ -18700,7 +18768,7 @@
             },
             {
               "kind": "Content",
-              "text": " | "
+              "text": ";\n    hitEntity?: "
             },
             {
               "kind": "Reference",

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;
 }
 
 /**
@@ -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;
 
+/** A hit result from a raycast. @public */
 export declare type RaycastHit = {
-    /** The block or entity the raycast hit. */
-    hitObject: Block | Entity;
+    /** 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. */