hytopia 0.1.49 → 0.1.51

package/docs/server.basecharactercontroller.md

@@ -115,7 +115,7 @@ _(Optional)_ A callback function for when the controller ticks.
 </td></tr>
 <tr><td>
 
-[onTickPlayerMovement?](./server.basecharactercontroller.ontickplayermovement.md)
+[onTickWithPlayerInput?](./server.basecharactercontroller.ontickwithplayerinput.md)
 
 
 </td><td>
@@ -123,12 +123,12 @@ _(Optional)_ A callback function for when the controller ticks.
 
 </td><td>
 
-(inputState: [PlayerInputState](./server.playerinputstate.md)<!-- -->, orientationState: [PlayerOrientationState](./server.playerorientationstate.md)<!-- -->, deltaTimeMs: number) =&gt; void
+(input: [PlayerInput](./server.playerinput.md)<!-- -->, cameraOrientation: [PlayerCameraOrientation](./server.playercameraorientation.md)<!-- -->, deltaTimeMs: number) =&gt; void
 
 
 </td><td>
 
-_(Optional)_ A callback function for when the controller ticks player movement.
+_(Optional)_ A callback function for when the controller ticks player movement. This is called every tick by a PlayerEntity with a character controller.
 
 
 </td></tr>
@@ -182,7 +182,7 @@ Override this method to handle entity movements based on your character controll
 </td></tr>
 <tr><td>
 
-[tickPlayerMovement(inputState, orientationState, deltaTimeMs)](./server.basecharactercontroller.tickplayermovement.md)
+[tickWithPlayerInput(input, cameraOrientation, deltaTimeMs)](./server.basecharactercontroller.tickwithplayerinput.md)
 
 
 </td><td>

package/docs/server.basecharactercontroller.ontickwithplayerinput.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; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [onTickWithPlayerInput](./server.basecharactercontroller.ontickwithplayerinput.md)
+
+## 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.
+
+**Signature:**
+
+```typescript
+onTickWithPlayerInput?: (input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number) => void;
+```

package/docs/{server.basecharactercontroller.tickplayermovement.md → server.basecharactercontroller.tickwithplayerinput.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; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [tickPlayerMovement](./server.basecharactercontroller.tickplayermovement.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [tickWithPlayerInput](./server.basecharactercontroller.tickwithplayerinput.md)
 
-## BaseCharacterController.tickPlayerMovement() method
+## BaseCharacterController.tickWithPlayerInput() method
 
 Override this method to handle entity movements based on player input for your character controller.
 
 **Signature:**
 
 ```typescript
-tickPlayerMovement(inputState: PlayerInputState, orientationState: PlayerOrientationState, deltaTimeMs: number): void;
+tickWithPlayerInput(input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number): void;
 ```
 
 ## Parameters
@@ -32,12 +32,12 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-inputState
+input
 
 
 </td><td>
 
-[PlayerInputState](./server.playerinputstate.md)
+[PlayerInput](./server.playerinput.md)
 
 
 </td><td>
@@ -48,17 +48,17 @@ The current input state of the player.
 </td></tr>
 <tr><td>
 
-orientationState
+cameraOrientation
 
 
 </td><td>
 
-[PlayerOrientationState](./server.playerorientationstate.md)
+[PlayerCameraOrientation](./server.playercameraorientation.md)
 
 
 </td><td>
 
-The current orientation state of the player.
+The current camera orientation state of the player.
 
 
 </td></tr>

package/docs/server.defaultcharactercontroller.md

@@ -304,7 +304,7 @@ Creates the colliders for the character controller, overriding the default imple
 </td></tr>
 <tr><td>
 
-[tickPlayerMovement(inputState, orientationState, deltaTimeMs)](./server.defaultcharactercontroller.tickplayermovement.md)
+[tickWithPlayerInput(input, cameraOrientation, deltaTimeMs)](./server.defaultcharactercontroller.tickwithplayerinput.md)
 
 
 </td><td>

package/docs/{server.defaultcharactercontroller.tickplayermovement.md → server.defaultcharactercontroller.tickwithplayerinput.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; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [tickPlayerMovement](./server.defaultcharactercontroller.tickplayermovement.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [tickWithPlayerInput](./server.defaultcharactercontroller.tickwithplayerinput.md)
 
-## DefaultCharacterController.tickPlayerMovement() method
+## DefaultCharacterController.tickWithPlayerInput() method
 
 Ticks the player movement for the character controller, overriding the default implementation.
 
 **Signature:**
 
 ```typescript
-tickPlayerMovement(inputState: PlayerInputState, orientationState: PlayerOrientationState, deltaTimeMs: number): void;
+tickWithPlayerInput(input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number): void;
 ```
 
 ## Parameters
@@ -32,12 +32,12 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-inputState
+input
 
 
 </td><td>
 
-[PlayerInputState](./server.playerinputstate.md)
+[PlayerInput](./server.playerinput.md)
 
 
 </td><td>
@@ -48,17 +48,17 @@ The current input state of the player.
 </td></tr>
 <tr><td>
 
-orientationState
+cameraOrientation
 
 
 </td><td>
 
-[PlayerOrientationState](./server.playerorientationstate.md)
+[PlayerCameraOrientation](./server.playercameraorientation.md)
 
 
 </td><td>
 
-The current orientation state of the player.
+The current camera orientation state of the player.
 
 
 </td></tr>

package/docs/server.md

@@ -904,7 +904,7 @@ The port the server will run on. You can override this in your .env by setting P
 
 </td><td>
 
-The input keys that can be included in the PlayerInputState.
+The input keys that are included in the PlayerInput.
 
 
 </td></tr>
@@ -1035,23 +1035,23 @@ Options for the [SimpleCharacterController.move()](./server.simplecharactercontr
 </td></tr>
 <tr><td>
 
-[PlayerInputState](./server.playerinputstate.md)
+[PlayerCameraOrientation](./server.playercameraorientation.md)
 
 
 </td><td>
 
-The input state of a Player; keys from SUPPORTED\_INPUT\_KEYS.
+The camera orientation state of a Player.
 
 
 </td></tr>
 <tr><td>
 
-[PlayerOrientationState](./server.playerorientationstate.md)
+[PlayerInput](./server.playerinput.md)
 
 
 </td><td>
 
-The camera orientation state of a Player.
+The input state of a Player; keys from SUPPORTED\_INPUT\_KEYS.
 
 
 </td></tr>

package/docs/server.player.cameraorientation.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; [Player](./server.player.md) &gt; [cameraOrientation](./server.player.cameraorientation.md)
+
+## Player.cameraOrientation property
+
+The current [PlayerCameraOrientation](./server.playercameraorientation.md) of the player.
+
+**Signature:**
+
+```typescript
+get cameraOrientation(): Readonly<PlayerCameraOrientation>;
+```

package/docs/server.player.input.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; [Player](./server.player.md) &gt; [input](./server.player.input.md)
+
+## Player.input property
+
+The current [PlayerInput](./server.playerinput.md) of the player.
+
+**Signature:**
+
+```typescript
+get input(): Readonly<PlayerInput>;
+```

package/docs/server.player.md

@@ -64,7 +64,7 @@ The camera for the player.
 </td></tr>
 <tr><td>
 
-[id](./server.player.id.md)
+[cameraOrientation](./server.player.cameraorientation.md)
 
 
 </td><td>
@@ -74,18 +74,18 @@ The camera for the player.
 
 </td><td>
 
-number
+Readonly&lt;[PlayerCameraOrientation](./server.playercameraorientation.md)<!-- -->&gt;
 
 
 </td><td>
 
-The unique identifier for the player.
+The current [PlayerCameraOrientation](./server.playercameraorientation.md) of the player.
 
 
 </td></tr>
 <tr><td>
 
-[inputState](./server.player.inputstate.md)
+[id](./server.player.id.md)
 
 
 </td><td>
@@ -95,18 +95,18 @@ The unique identifier for the player.
 
 </td><td>
 
-Readonly&lt;[PlayerInputState](./server.playerinputstate.md)<!-- -->&gt;
+number
 
 
 </td><td>
 
-The current [PlayerInputState](./server.playerinputstate.md) of the player.
+The unique identifier for the player.
 
 
 </td></tr>
 <tr><td>
 
-[orientationState](./server.player.orientationstate.md)
+[input](./server.player.input.md)
 
 
 </td><td>
@@ -116,12 +116,12 @@ The current [PlayerInputState](./server.playerinputstate.md) of the player.
 
 </td><td>
 
-Readonly&lt;[PlayerOrientationState](./server.playerorientationstate.md)<!-- -->&gt;
+Readonly&lt;[PlayerInput](./server.playerinput.md)<!-- -->&gt;
 
 
 </td><td>
 
-The current [PlayerOrientationState](./server.playerorientationstate.md) of the player.
+The current [PlayerInput](./server.playerinput.md) of the player.
 
 
 </td></tr>

package/docs/server.playercameraorientation.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; [PlayerCameraOrientation](./server.playercameraorientation.md)
+
+## PlayerCameraOrientation type
+
+The camera orientation state of a Player.
+
+**Signature:**
+
+```typescript
+export type PlayerCameraOrientation = {
+    pitch: number;
+    yaw: number;
+};
+```

package/docs/server.playerinput.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; [PlayerInput](./server.playerinput.md)
+
+## PlayerInput type
+
+The input state of a Player; keys from SUPPORTED\_INPUT\_KEYS.
+
+**Signature:**
+
+```typescript
+export type PlayerInput = Partial<Record<keyof InputSchema, boolean>>;
+```

package/docs/server.simulation.enabledebugraycasting.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; [Simulation](./server.simulation.md) &gt; [enableDebugRaycasting](./server.simulation.enabledebugraycasting.md)
+
+## Simulation.enableDebugRaycasting() method
+
+Enables or disables debug raycasting for the simulation. This will render lines for the raycast that disappear after a few seconds.
+
+**Signature:**
+
+```typescript
+enableDebugRaycasting(enabled: boolean): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+enabled
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether to enable debug raycasting.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.simulation.enabledebugrendering.md

@@ -4,7 +4,7 @@
 
 ## Simulation.enableDebugRendering() method
 
-Enables or disables debug rendering for the simulation. When enabled, all colliders, rigid body and raycast 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.
+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.
 
 **Signature:**
 

package/docs/server.simulation.isdebugraycastingenabled.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; [Simulation](./server.simulation.md) &gt; [isDebugRaycastingEnabled](./server.simulation.isdebugraycastingenabled.md)
+
+## Simulation.isDebugRaycastingEnabled property
+
+Whether the simulation has debug raycasting enabled
+
+**Signature:**
+
+```typescript
+get isDebugRaycastingEnabled(): boolean;
+```

package/docs/server.simulation.md

@@ -61,6 +61,27 @@ RAPIER.Vector3
 The gravity vector for the simulation.
 
 
+</td></tr>
+<tr><td>
+
+[isDebugRaycastingEnabled](./server.simulation.isdebugraycastingenabled.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the simulation has debug raycasting enabled
+
+
 </td></tr>
 <tr><td>
 
@@ -158,6 +179,20 @@ Description
 Casts a ray through the simulation.
 
 
+</td></tr>
+<tr><td>
+
+[enableDebugRaycasting(enabled)](./server.simulation.enabledebugraycasting.md)
+
+
+</td><td>
+
+
+</td><td>
+
+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>
 
@@ -169,7 +204,7 @@ Casts a ray through the simulation.
 
 </td><td>
 
-Enables or disables debug rendering for the simulation. When enabled, all colliders, rigid body and raycast 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.
+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>

package/docs/server.supported_input_keys.md

@@ -4,7 +4,7 @@
 
 ## SUPPORTED\_INPUT\_KEYS variable
 
-The input keys that can be included in the PlayerInputState.
+The input keys that are included in the PlayerInput.
 
 **Signature:**
 

package/examples/big-world/README.md

@@ -0,0 +1,4 @@
+# big-world
+
+A simple demonstration of loading a fairly large world into the game without any queuing or other
+possible optimizations. This world is 750x750 in size and over 2,000,000+ blocks.

package/examples/big-world/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "big-world",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@hytopia.com/assets": "^0.1.6"
+  }
+}

package/examples/block-entity/README.md

@@ -0,0 +1,3 @@
+# block-entity
+
+A quick demonstration of different usages of block entities. You can [learn more about block entities here](https://dev.hytopia.com/sdk-guides/entities/block-entities).