hytopia 0.1.52 → 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.blocktype.md

@@ -202,7 +202,7 @@ _(Optional)_ A callback function that is invoked when an entity collides with bl
 
 </td><td>
 
-(blockType: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(blockType: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, contactForceData: [ContactForceData](./server.contactforcedata.md)<!-- -->) =&gt; void
 
 
 </td><td>

package/docs/server.contactforcedata.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ContactForceData](./server.contactforcedata.md)
+
+## ContactForceData type
+
+Data for contact forces.
+
+**Signature:**
+
+```typescript
+export type ContactForceData = {
+    totalForce: RAPIER.Vector;
+    totalForceMagnitude: number;
+    maxForceDirection: RAPIER.Vector;
+    maxForceMagnitude: number;
+};
+```

package/docs/server.contactmanifold.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ContactManifold](./server.contactmanifold.md)
+
+## ContactManifold type
+
+A contact manifold.
+
+**Signature:**
+
+```typescript
+export type ContactManifold = {
+    localNormalA: Vector3Like;
+    localNormalB: Vector3Like;
+    normal: Vector3Like;
+};
+```
+**References:** [Vector3Like](./server.vector3like.md)
+

package/docs/server.entity.md

@@ -402,7 +402,7 @@ _(Optional)_ A function that is called when the entity collides with a block.
 
 </td><td>
 
-(entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, contactForceData: [ContactForceData](./server.contactforcedata.md)<!-- -->) =&gt; void
 
 
 </td><td>
@@ -459,7 +459,7 @@ _(Optional)_ A function that is called when the entity collides with another ent
 
 </td><td>
 
-(entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, contactForceData: [ContactForceData](./server.contactforcedata.md)<!-- -->) =&gt; void
 
 
 </td><td>

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>
@@ -955,6 +957,28 @@ A set of collision groups.
 A callback function for a chat command.
 
 
+</td></tr>
+<tr><td>
+
+[ContactForceData](./server.contactforcedata.md)
+
+
+</td><td>
+
+Data for contact forces.
+
+
+</td></tr>
+<tr><td>
+
+[ContactManifold](./server.contactmanifold.md)
+
+
+</td><td>
+
+A contact manifold.
+
+
 </td></tr>
 <tr><td>
 
@@ -1065,6 +1089,28 @@ The input state of a Player; keys from SUPPORTED\_INPUT\_KEYS.
 A raw set of collision groups represented as a 32-bit number.
 
 
+</td></tr>
+<tr><td>
+
+[RaycastHit](./server.raycasthit.md)
+
+
+</td><td>
+
+A hit result from a raycast.
+
+
+</td></tr>
+<tr><td>
+
+[RaycastOptions](./server.raycastoptions.md)
+
+
+</td><td>
+
+Options for raycasting.
+
+
 </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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [RaycastHit](./server.raycasthit.md)
+
+## RaycastHit type
+
+A hit result from a raycast.
+
+**Signature:**
+
+```typescript
+export type RaycastHit = {
+    hitBlock?: Block;
+    hitEntity?: Entity;
+    hitPoint: Vector3Like;
+    hitDistance: number;
+};
+```
+**References:** [Block](./server.block.md)<!-- -->, [Entity](./server.entity.md)<!-- -->, [Vector3Like](./server.vector3like.md)
+

package/docs/server.raycastoptions.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [RaycastOptions](./server.raycastoptions.md)
+
+## RaycastOptions type
+
+Options for raycasting.
+
+**Signature:**
+
+```typescript
+export type RaycastOptions = {
+    ignoresSensors?: boolean;
+    filterFlags?: RAPIER.QueryFilterFlags;
+    filterGroups?: number;
+    filterExcludeCollider?: RAPIER.Collider;
+    filterExcludeRigidBody?: RAPIER.RigidBody;
+    filterPredicate?: (collider: RAPIER.Collider) => boolean;
+};
+```

package/docs/server.simulation.getcontactmanifolds.md

@@ -65,7 +65,7 @@ The handle of the second collider.
 </tbody></table>
 **Returns:**
 
-ContactManifold\[\]
+[ContactManifold](./server.contactmanifold.md)<!-- -->\[\]
 
 The contact manifolds, or an empty array if no contact.
 

package/docs/server.simulation.raycast.md

@@ -85,7 +85,7 @@ options
 
 </td><td>
 
-RaycastOptions
+[RaycastOptions](./server.raycastoptions.md)
 
 
 </td><td>
@@ -97,7 +97,7 @@ _(Optional)_ The options for the raycast.
 </tbody></table>
 **Returns:**
 
-RaycastHit \| null
+[RaycastHit](./server.raycasthit.md) \| null
 
 A RaycastHit object containing the first block or entity hit by the ray, or null if no hit.
 

package/examples/payload-game/assets/ui/index.html

@@ -1,4 +1,4 @@
-<html></html>
+<html>
   <body>
     <!--
       The Hytopia-ui script MUST be included, otherwise your 
@@ -39,4 +39,4 @@
     </style>
     <div class="crosshair"></div>
   </body>
-</html>
+</html>

package/package.json

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