hytopia 0.1.51 → 0.1.53

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.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

@@ -955,6 +955,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 +1087,26 @@ 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>
+
+
+</td></tr>
+<tr><td>
+
+[RaycastOptions](./server.raycastoptions.md)
+
+
+</td><td>
+
+Options for raycasting.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.raycasthit.md

@@ -0,0 +1,17 @@
+<!-- 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
+
+**Signature:**
+
+```typescript
+export type RaycastHit = {
+    hitObject: Block | 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.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](./server.raycastoptions.md)
 
 
 </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](./server.raycasthit.md) \| 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/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.51",
+  "version": "0.1.53",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "main": "server.js",
   "bin": {