hytopia 0.6.8 → 0.6.10

package/docs/server.intersectionresult.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; [IntersectionResult](./server.intersectionresult.md)
+
+## IntersectionResult type
+
+A intersection result.
+
+**Signature:**
+
+```typescript
+export type IntersectionResult = {
+    intersectedBlockType?: BlockType;
+    intersectedEntity?: Entity;
+};
+```
+**References:** [BlockType](./server.blocktype.md)<!-- -->, [Entity](./server.entity.md)
+

package/docs/server.md

@@ -1569,6 +1569,28 @@ A callback function called when the entity associated with the SimpleEntityContr
 Options for the [SimpleEntityController.face()](./server.simpleentitycontroller.face.md) method.
 
 
+</td></tr>
+<tr><td>
+
+[FilterOptions](./server.filteroptions.md)
+
+
+</td><td>
+
+Filter options for various operations like raycasting and intersections.
+
+
+</td></tr>
+<tr><td>
+
+[IntersectionResult](./server.intersectionresult.md)
+
+
+</td><td>
+
+A intersection result.
+
+
 </td></tr>
 <tr><td>
 
@@ -1690,6 +1712,17 @@ Options for creating a PlayerEntity instance.
 The input state of a Player; keys from SUPPORTED\_INPUT\_KEYS.
 
 
+</td></tr>
+<tr><td>
+
+[RawCollider](./server.rawcollider.md)
+
+
+</td><td>
+
+A raw collider object from the Rapier physics engine.
+
+
 </td></tr>
 <tr><td>
 
@@ -1701,6 +1734,17 @@ 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>
+
+[RawShape](./server.rawshape.md)
+
+
+</td><td>
+
+A raw shape object from the Rapier physics engine.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.modelentityoptions.md

@@ -130,6 +130,25 @@ number
 _(Optional)_ The scale of the entity's model.
 
 
+</td></tr>
+<tr><td>
+
+[modelShownNodes?](./server.modelentityoptions.modelshownnodes.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ The nodes to show on the entity's model, overriding hidden nodes.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.modelentityoptions.modelshownnodes.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; [ModelEntityOptions](./server.modelentityoptions.md) &gt; [modelShownNodes](./server.modelentityoptions.modelshownnodes.md)
+
+## ModelEntityOptions.modelShownNodes property
+
+The nodes to show on the entity's model, overriding hidden nodes.
+
+**Signature:**
+
+```typescript
+modelShownNodes?: string[];
+```

package/docs/server.moveoptions.md

@@ -19,6 +19,7 @@ export type MoveOptions = {
     };
     moveStartIdleAnimationsOnCompletion?: boolean;
     moveStoppingDistance?: number;
+    moveCompletesWhenStuck?: boolean;
 };
 ```
 **References:** [MoveCallback](./server.movecallback.md)<!-- -->, [MoveCompleteCallback](./server.movecompletecallback.md)

package/docs/server.pathfindingoptions.md

@@ -19,6 +19,7 @@ export type PathfindingOptions = {
     verticalPenalty?: number;
     waypointMoveCompleteCallback?: WaypointMoveCompleteCallback;
     waypointMoveSkippedCallback?: WaypointMoveSkippedCallback;
+    waypointStoppingDistance?: number;
     waypointTimeoutMs?: number;
 };
 ```

package/docs/server.playercamera.facingquaternion.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; [facingQuaternion](./server.playercamera.facingquaternion.md)
+
+## PlayerCamera.facingQuaternion property
+
+The quaternion representing the camera's facing direction.
+
+**Signature:**
+
+```typescript
+get facingQuaternion(): QuaternionLike;
+```

package/docs/server.playercamera.md

@@ -117,6 +117,27 @@ The position the camera is attached to.
 The facing direction vector of the camera based on its current orientation.
 
 
+</td></tr>
+<tr><td>
+
+[facingQuaternion](./server.playercamera.facingquaternion.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[QuaternionLike](./server.quaternionlike.md)
+
+
+</td><td>
+
+The quaternion representing the camera's facing direction.
+
+
 </td></tr>
 <tr><td>
 
@@ -222,6 +243,27 @@ Set&lt;string&gt;
 The nodes of the model the camera is attached to that will not be rendered for the player. Uses case insensitive substring matching.
 
 
+</td></tr>
+<tr><td>
+
+[modelShownNodes](./server.playercamera.modelshownnodes.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+Set&lt;string&gt;
+
+
+</td><td>
+
+The nodes of the model the camera is attached to that will be rendered for the player, overriding hidden nodes. Uses case insensitive substring matching.
+
+
 </td></tr>
 <tr><td>
 
@@ -529,6 +571,20 @@ Sets the mode of the camera.
 Sets the nodes of the model the camera is attached to that will not be rendered for the player. Uses case insensitive substring matching.
 
 
+</td></tr>
+<tr><td>
+
+[setModelShownNodes(modelShownNodes)](./server.playercamera.setmodelshownnodes.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the nodes of the model the camera is attached to that will be rendered for the player, overriding hidden nodes. Uses case insensitive substring matching.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playercamera.modelshownnodes.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; [modelShownNodes](./server.playercamera.modelshownnodes.md)
+
+## PlayerCamera.modelShownNodes property
+
+The nodes of the model the camera is attached to that will be rendered for the player, overriding hidden nodes. Uses case insensitive substring matching.
+
+**Signature:**
+
+```typescript
+get modelShownNodes(): Set<string>;
+```

package/docs/server.playercamera.setmodelshownnodes.md

@@ -0,0 +1,53 @@
+<!-- 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; [setModelShownNodes](./server.playercamera.setmodelshownnodes.md)
+
+## PlayerCamera.setModelShownNodes() method
+
+Sets the nodes of the model the camera is attached to that will be rendered for the player, overriding hidden nodes. Uses case insensitive substring matching.
+
+**Signature:**
+
+```typescript
+setModelShownNodes(modelShownNodes: string[]): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+modelShownNodes
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+Determines nodes to show that match these case insensitive substrings.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.playercameraevent.md

@@ -155,6 +155,20 @@ SET\_MODEL\_HIDDEN\_NODES
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+SET\_MODEL\_SHOWN\_NODES
+
+
+</td><td>
+
+`"PLAYER_CAMERA.SET_MODEL_SHOWN_NODES"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playercameraeventpayloads._player_camera.set_model_shown_nodes_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCameraEventPayloads](./server.playercameraeventpayloads.md) &gt; ["PLAYER\_CAMERA.SET\_MODEL\_SHOWN\_NODES"](./server.playercameraeventpayloads._player_camera.set_model_shown_nodes_.md)
+
+## PlayerCameraEventPayloads."PLAYER\_CAMERA.SET\_MODEL\_SHOWN\_NODES" property
+
+Emitted when the nodes of the model the camera is attached to are set to be shown.
+
+**Signature:**
+
+```typescript
+[PlayerCameraEvent.SET_MODEL_SHOWN_NODES]: {
+        playerCamera: PlayerCamera;
+        modelShownNodes: Set<string>;
+    };
+```

package/docs/server.playercameraeventpayloads.md

@@ -205,6 +205,25 @@ Emitted when the mode of the camera is set.
 Emitted when the nodes of the model the camera is attached to are set to be hidden.
 
 
+</td></tr>
+<tr><td>
+
+["PLAYER\_CAMERA.SET\_MODEL\_SHOWN\_NODES"](./server.playercameraeventpayloads._player_camera.set_model_shown_nodes_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ playerCamera: [PlayerCamera](./server.playercamera.md)<!-- -->; modelShownNodes: Set&lt;string&gt;; }
+
+
+</td><td>
+
+Emitted when the nodes of the model the camera is attached to are set to be shown.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playermanager.md

@@ -98,6 +98,25 @@ number
 The number of players currently connected to the server.
 
 
+</td></tr>
+<tr><td>
+
+[worldSelectionHandler?](./server.playermanager.worldselectionhandler.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(player: [Player](./server.player.md)<!-- -->) =&gt; Promise&lt;[World](./server.world.md) \| undefined&gt;
+
+
+</td><td>
+
+_(Optional)_ Optional handler for selecting the world a newly connected player joins. Returning no world results in the player joining the default WorldManager world.
+
+
 </td></tr>
 </tbody></table>
 

package/docs/server.playermanager.worldselectionhandler.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; [PlayerManager](./server.playermanager.md) &gt; [worldSelectionHandler](./server.playermanager.worldselectionhandler.md)
+
+## PlayerManager.worldSelectionHandler property
+
+Optional handler for selecting the world a newly connected player joins. Returning no world results in the player joining the default WorldManager world.
+
+**Signature:**
+
+```typescript
+worldSelectionHandler?: (player: Player) => Promise<World | undefined>;
+```

package/docs/server.rawcollider.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; [RawCollider](./server.rawcollider.md)
+
+## RawCollider type
+
+A raw collider object from the Rapier physics engine.
+
+**Signature:**
+
+```typescript
+export type RawCollider = RAPIER.Collider;
+```

package/docs/server.rawshape.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; [RawShape](./server.rawshape.md)
+
+## RawShape type
+
+A raw shape object from the Rapier physics engine.
+
+**Signature:**
+
+```typescript
+export type RawShape = RAPIER.Shape;
+```

package/docs/server.raycastoptions.md

@@ -10,11 +10,8 @@ Options for raycasting.
 
 ```typescript
 export type RaycastOptions = {
-    ignoresSensors?: boolean;
-    filterFlags?: RAPIER.QueryFilterFlags;
-    filterGroups?: number;
-    filterExcludeCollider?: RAPIER.Collider;
-    filterExcludeRigidBody?: RAPIER.RigidBody;
-    filterPredicate?: (collider: RAPIER.Collider) => boolean;
-};
+    solidMode?: boolean;
+} & FilterOptions;
 ```
+**References:** [FilterOptions](./server.filteroptions.md)
+

package/docs/server.simulation.intersectionswithrawshape.md

@@ -0,0 +1,107 @@
+<!-- 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; [intersectionsWithRawShape](./server.simulation.intersectionswithrawshape.md)
+
+## Simulation.intersectionsWithRawShape() method
+
+Gets the intersections with a raw shape.
+
+**Signature:**
+
+```typescript
+intersectionsWithRawShape(rawShape: RawShape, position: Vector3Like, rotation: QuaternionLike, options?: FilterOptions): IntersectionResult[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+rawShape
+
+
+</td><td>
+
+[RawShape](./server.rawshape.md)
+
+
+</td><td>
+
+The raw shape to get intersections with.
+
+
+</td></tr>
+<tr><td>
+
+position
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The position of the shape.
+
+
+</td></tr>
+<tr><td>
+
+rotation
+
+
+</td><td>
+
+[QuaternionLike](./server.quaternionlike.md)
+
+
+</td><td>
+
+The rotation of the shape.
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[FilterOptions](./server.filteroptions.md)
+
+
+</td><td>
+
+_(Optional)_ The options for the intersections.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[IntersectionResult](./server.intersectionresult.md)<!-- -->\[\]
+
+The intersections.
+
+## Remarks
+
+rawShape can be retrieved from a simulated or unsimulated collider using [Collider.rawShape](./server.collider.rawshape.md)<!-- -->.
+

package/docs/server.simulation.md

@@ -212,6 +212,20 @@ Enables or disables debug rendering for the simulation. When enabled, all collid
 Gets the contact manifolds for a pair of colliders.
 
 
+</td></tr>
+<tr><td>
+
+[intersectionsWithRawShape(rawShape, position, rotation, options)](./server.simulation.intersectionswithrawshape.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the intersections with a raw shape.
+
+
 </td></tr>
 <tr><td>