hytopia 0.1.49 → 0.1.50

package/server.api.json

@@ -2785,30 +2785,30 @@
             },
             {
               "kind": "Property",
-              "canonicalReference": "server!BaseCharacterController#onTickPlayerMovement:member",
-              "docComment": "/**\n * A callback function for when the controller ticks player movement.\n *\n * @param inputState - The current input state of the player.\n *\n * @param orientationState - The current orientation state of the player.\n *\n * @param deltaTimeMs - The delta time in milliseconds since the last tick.\n */\n",
+              "canonicalReference": "server!BaseCharacterController#onTickWithPlayerInput:member",
+              "docComment": "/**\n * A callback function for when the controller ticks player movement. This is called every tick by a PlayerEntity with a character controller.\n *\n * @param input - The current input state of the player.\n *\n * @param cameraOrientation - The current camera orientation state of the player.\n *\n * @param deltaTimeMs - The delta time in milliseconds since the last tick.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "onTickPlayerMovement?: "
+                  "text": "onTickWithPlayerInput?: "
                 },
                 {
                   "kind": "Content",
-                  "text": "(inputState: "
+                  "text": "(input: "
                 },
                 {
                   "kind": "Reference",
-                  "text": "PlayerInputState",
-                  "canonicalReference": "server!PlayerInputState:type"
+                  "text": "PlayerInput",
+                  "canonicalReference": "server!PlayerInput:type"
                 },
                 {
                   "kind": "Content",
-                  "text": ", orientationState: "
+                  "text": ", cameraOrientation: "
                 },
                 {
                   "kind": "Reference",
-                  "text": "PlayerOrientationState",
-                  "canonicalReference": "server!PlayerOrientationState:type"
+                  "text": "PlayerCameraOrientation",
+                  "canonicalReference": "server!PlayerCameraOrientation:type"
                 },
                 {
                   "kind": "Content",
@@ -2822,7 +2822,7 @@
               "isReadonly": false,
               "isOptional": true,
               "releaseTag": "Public",
-              "name": "onTickPlayerMovement",
+              "name": "onTickWithPlayerInput",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 6
@@ -2881,26 +2881,26 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "server!BaseCharacterController#tickPlayerMovement:member(1)",
-              "docComment": "/**\n * Override this method to handle entity movements based on player input for your character controller.\n *\n * @param inputState - The current input state of the player.\n *\n * @param orientationState - The current orientation state of the player.\n *\n * @param deltaTimeMs - The delta time in milliseconds since the last tick.\n */\n",
+              "canonicalReference": "server!BaseCharacterController#tickWithPlayerInput:member(1)",
+              "docComment": "/**\n * Override this method to handle entity movements based on player input for your character controller.\n *\n * @param input - The current input state of the player.\n *\n * @param cameraOrientation - The current camera orientation state of the player.\n *\n * @param deltaTimeMs - The delta time in milliseconds since the last tick.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "tickPlayerMovement(inputState: "
+                  "text": "tickWithPlayerInput(input: "
                 },
                 {
                   "kind": "Reference",
-                  "text": "PlayerInputState",
-                  "canonicalReference": "server!PlayerInputState:type"
+                  "text": "PlayerInput",
+                  "canonicalReference": "server!PlayerInput:type"
                 },
                 {
                   "kind": "Content",
-                  "text": ", orientationState: "
+                  "text": ", cameraOrientation: "
                 },
                 {
                   "kind": "Reference",
-                  "text": "PlayerOrientationState",
-                  "canonicalReference": "server!PlayerOrientationState:type"
+                  "text": "PlayerCameraOrientation",
+                  "canonicalReference": "server!PlayerCameraOrientation:type"
                 },
                 {
                   "kind": "Content",
@@ -2933,7 +2933,7 @@
               "overloadIndex": 1,
               "parameters": [
                 {
-                  "parameterName": "inputState",
+                  "parameterName": "input",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
                     "endIndex": 2
@@ -2941,7 +2941,7 @@
                   "isOptional": false
                 },
                 {
-                  "parameterName": "orientationState",
+                  "parameterName": "cameraOrientation",
                   "parameterTypeTokenRange": {
                     "startIndex": 3,
                     "endIndex": 4
@@ -2959,7 +2959,7 @@
               ],
               "isOptional": false,
               "isAbstract": false,
-              "name": "tickPlayerMovement"
+              "name": "tickWithPlayerInput"
             }
           ],
           "implementsTokenRanges": []
@@ -8893,26 +8893,26 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "server!DefaultCharacterController#tickPlayerMovement:member(1)",
-              "docComment": "/**\n * Ticks the player movement for the character controller, overriding the default implementation.\n *\n * @param inputState - The current input state of the player.\n *\n * @param orientationState - The current orientation state of the player.\n *\n * @param deltaTimeMs - The delta time in milliseconds since the last tick.\n */\n",
+              "canonicalReference": "server!DefaultCharacterController#tickWithPlayerInput:member(1)",
+              "docComment": "/**\n * Ticks the player movement for the character controller, overriding the default implementation.\n *\n * @param input - The current input state of the player.\n *\n * @param cameraOrientation - The current camera orientation state of the player.\n *\n * @param deltaTimeMs - The delta time in milliseconds since the last tick.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "tickPlayerMovement(inputState: "
+                  "text": "tickWithPlayerInput(input: "
                 },
                 {
                   "kind": "Reference",
-                  "text": "PlayerInputState",
-                  "canonicalReference": "server!PlayerInputState:type"
+                  "text": "PlayerInput",
+                  "canonicalReference": "server!PlayerInput:type"
                 },
                 {
                   "kind": "Content",
-                  "text": ", orientationState: "
+                  "text": ", cameraOrientation: "
                 },
                 {
                   "kind": "Reference",
-                  "text": "PlayerOrientationState",
-                  "canonicalReference": "server!PlayerOrientationState:type"
+                  "text": "PlayerCameraOrientation",
+                  "canonicalReference": "server!PlayerCameraOrientation:type"
                 },
                 {
                   "kind": "Content",
@@ -8945,7 +8945,7 @@
               "overloadIndex": 1,
               "parameters": [
                 {
-                  "parameterName": "inputState",
+                  "parameterName": "input",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
                     "endIndex": 2
@@ -8953,7 +8953,7 @@
                   "isOptional": false
                 },
                 {
-                  "parameterName": "orientationState",
+                  "parameterName": "cameraOrientation",
                   "parameterTypeTokenRange": {
                     "startIndex": 3,
                     "endIndex": 4
@@ -8971,7 +8971,7 @@
               ],
               "isOptional": false,
               "isAbstract": false,
-              "name": "tickPlayerMovement"
+              "name": "tickWithPlayerInput"
             },
             {
               "kind": "Property",
@@ -13232,6 +13232,50 @@
               "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)",
@@ -13295,12 +13339,12 @@
             },
             {
               "kind": "Property",
-              "canonicalReference": "server!Player#inputState:member",
-              "docComment": "/**\n * The current {@link PlayerInputState} of the player.\n */\n",
+              "canonicalReference": "server!Player#input:member",
+              "docComment": "/**\n * The current {@link PlayerInput} of the player.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "get inputState(): "
+                  "text": "get input(): "
                 },
                 {
                   "kind": "Reference",
@@ -13313,8 +13357,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "PlayerInputState",
-                  "canonicalReference": "server!PlayerInputState:type"
+                  "text": "PlayerInput",
+                  "canonicalReference": "server!PlayerInput:type"
                 },
                 {
                   "kind": "Content",
@@ -13328,7 +13372,7 @@
               "isReadonly": true,
               "isOptional": false,
               "releaseTag": "Public",
-              "name": "inputState",
+              "name": "input",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 5
@@ -13417,50 +13461,6 @@
               "isAbstract": false,
               "name": "leaveWorld"
             },
-            {
-              "kind": "Property",
-              "canonicalReference": "server!Player#orientationState:member",
-              "docComment": "/**\n * The current {@link PlayerOrientationState} of the player.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "get orientationState(): "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Readonly",
-                  "canonicalReference": "!Readonly:type"
-                },
-                {
-                  "kind": "Content",
-                  "text": "<"
-                },
-                {
-                  "kind": "Reference",
-                  "text": "PlayerOrientationState",
-                  "canonicalReference": "server!PlayerOrientationState:type"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": true,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "orientationState",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 5
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
-            },
             {
               "kind": "Property",
               "canonicalReference": "server!Player#ui:member",
@@ -15944,6 +15944,32 @@
             }
           ]
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "server!PlayerCameraOrientation:type",
+          "docComment": "/**\n * The camera orientation state of a Player.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type PlayerCameraOrientation = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    pitch: number;\n    yaw: number;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/networking/players/Player.ts",
+          "releaseTag": "Public",
+          "name": "PlayerCameraOrientation",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Class",
           "canonicalReference": "server!PlayerEntity:class",
@@ -16538,12 +16564,12 @@
         },
         {
           "kind": "TypeAlias",
-          "canonicalReference": "server!PlayerInputState:type",
+          "canonicalReference": "server!PlayerInput:type",
           "docComment": "/**\n * The input state of a Player; keys from SUPPORTED_INPUT_KEYS.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export type PlayerInputState = "
+              "text": "export type PlayerInput = "
             },
             {
               "kind": "Reference",
@@ -16579,7 +16605,7 @@
           ],
           "fileUrlPath": "src/networking/players/Player.ts",
           "releaseTag": "Public",
-          "name": "PlayerInputState",
+          "name": "PlayerInput",
           "typeTokenRange": {
             "startIndex": 1,
             "endIndex": 7
@@ -16724,32 +16750,6 @@
           ],
           "implementsTokenRanges": []
         },
-        {
-          "kind": "TypeAlias",
-          "canonicalReference": "server!PlayerOrientationState:type",
-          "docComment": "/**\n * The camera orientation state of a Player.\n *\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export type PlayerOrientationState = "
-            },
-            {
-              "kind": "Content",
-              "text": "{\n    pitch: number;\n    yaw: number;\n}"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "fileUrlPath": "src/networking/players/Player.ts",
-          "releaseTag": "Public",
-          "name": "PlayerOrientationState",
-          "typeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          }
-        },
         {
           "kind": "Class",
           "canonicalReference": "server!PlayerUI:class",
@@ -22798,10 +22798,58 @@
               "isAbstract": false,
               "name": "castRay"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!Simulation#enableDebugRaycasting:member(1)",
+              "docComment": "/**\n * Enables or disables debug raycasting for the simulation. This will render lines for the raycast that disappear after a few seconds.\n *\n * @param enabled - Whether to enable debug raycasting.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "enableDebugRaycasting(enabled: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "enabled",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "enableDebugRaycasting"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!Simulation#enableDebugRendering:member(1)",
-              "docComment": "/**\n * 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.\n *\n * @param enabled - Whether to enable debug rendering.\n */\n",
+              "docComment": "/**\n * 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.\n *\n * @param enabled - Whether to enable debug rendering.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -22948,6 +22996,36 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!Simulation#isDebugRaycastingEnabled:member",
+              "docComment": "/**\n * Whether the simulation has debug raycasting enabled\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get isDebugRaycastingEnabled(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "isDebugRaycastingEnabled",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!Simulation#isDebugRenderingEnabled:member",
@@ -23179,7 +23257,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "server!SUPPORTED_INPUT_KEYS:var",
-          "docComment": "/**\n * The input keys that can be included in the PlayerInputState.\n *\n * @public\n */\n",
+          "docComment": "/**\n * The input keys that are included in the PlayerInput.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",

package/server.d.ts

@@ -296,12 +296,13 @@ export declare abstract class BaseCharacterController {
     onTick?: (deltaTimeMs: number) => void;
     /**
      * A callback function for when the controller ticks
-     * player movement.
-     * @param inputState - The current input state of the player.
-     * @param orientationState - The current orientation state of the player.
+     * player movement. This is called every tick by a
+     * PlayerEntity with a character controller.
+     * @param input - The current input state of the player.
+     * @param cameraOrientation - The current camera orientation state of the player.
      * @param deltaTimeMs - The delta time in milliseconds since the last tick.
      */
-    onTickPlayerMovement?: (inputState: PlayerInputState, orientationState: PlayerOrientationState, deltaTimeMs: number) => void;
+    onTickWithPlayerInput?: (input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number) => void;
     /**
      * @param entity - The entity the controller is for.
      * @param _options - Arbitrary options you may provide or omit for your controller implementation.
@@ -316,11 +317,11 @@ export declare abstract class BaseCharacterController {
     /**
      * Override this method to handle entity movements
      * based on player input for your character controller.
-     * @param inputState - The current input state of the player.
-     * @param orientationState - The current orientation state of the player.
+     * @param input - The current input state of the player.
+     * @param cameraOrientation - The current camera orientation state of the player.
      * @param deltaTimeMs - The delta time in milliseconds since the last tick.
      */
-    tickPlayerMovement(inputState: PlayerInputState, orientationState: PlayerOrientationState, deltaTimeMs: number): void;
+    tickWithPlayerInput(input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number): void;
     /**
      * Override this method to handle entity movements
      * based on your character controller.
@@ -1228,11 +1229,11 @@ export declare class DefaultCharacterController extends BaseCharacterController
     /**
      * Ticks the player movement for the character controller,
      * overriding the default implementation.
-     * @param inputState - The current input state of the player.
-     * @param orientationState - The current orientation state of the player.
+     * @param input - The current input state of the player.
+     * @param cameraOrientation - The current camera orientation state of the player.
      * @param deltaTimeMs - The delta time in milliseconds since the last tick.
      */
-    tickPlayerMovement(inputState: PlayerInputState, orientationState: PlayerOrientationState, deltaTimeMs: number): void;
+    tickWithPlayerInput(input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number): void;
 }
 
 /** Options for creating a DefaultCharacterController instance. @public */
@@ -1819,10 +1820,10 @@ export declare class Player {
 
 
 
-    /** The current {@link PlayerInputState} of the player. */
-    get inputState(): Readonly<PlayerInputState>;
-    /** The current {@link PlayerOrientationState} of the player. */
-    get orientationState(): Readonly<PlayerOrientationState>;
+    /** 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;
     /**
@@ -2063,6 +2064,12 @@ export declare enum PlayerCameraMode {
     THIRD_PERSON = 1
 }
 
+/** The camera orientation state of a Player. @public */
+export declare type PlayerCameraOrientation = {
+    pitch: number;
+    yaw: number;
+};
+
 /**
  * Represents an entity controlled by a player in a world.
  *
@@ -2138,7 +2145,7 @@ export declare enum PlayerEventType {
 }
 
 /** The input state of a Player; keys from SUPPORTED_INPUT_KEYS. @public */
-export declare type PlayerInputState = Partial<Record<keyof InputSchema, boolean>>;
+export declare type PlayerInput = Partial<Record<keyof InputSchema, boolean>>;
 
 /**
  * Manages all connected players in a game server.
@@ -2180,12 +2187,6 @@ export declare class PlayerManager {
 
 }
 
-/** The camera orientation state of a Player. @public */
-export declare type PlayerOrientationState = {
-    pitch: number;
-    yaw: number;
-};
-
 /**
  * The UI for a player.
  *
@@ -2989,6 +2990,9 @@ export declare class Simulation {
 
 
 
+
+    /** Whether the simulation has debug raycasting enabled */
+    get isDebugRaycastingEnabled(): boolean;
     /** Whether the simulation has debug rendering enabled. */
     get isDebugRenderingEnabled(): boolean;
     /** The gravity vector for the simulation. */
@@ -3008,9 +3012,16 @@ export declare class Simulation {
     castRay(origin: RAPIER.Vector3, direction: RAPIER.Vector3, length: number, options?: RayCastOptions): Block | Entity | null;
 
 
+    /**
+     * Enables or disables debug raycasting for the simulation.
+     * This will render lines for the raycast that disappear
+     * after a few seconds.
+     * @param enabled - Whether to enable debug raycasting.
+     */
+    enableDebugRaycasting(enabled: boolean): void;
     /**
      * Enables or disables debug rendering for the simulation.
-     * When enabled, all colliders, rigid body and raycast outlines
+     * 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.
      * @param enabled - Whether to enable debug rendering.
@@ -3060,7 +3071,7 @@ export declare interface SpdMatrix3 extends SdpMatrix3 {
  */
 export declare function startServer(init: (world: World) => void): void;
 
-/** The input keys that can be included in the PlayerInputState. @public */
+/** The input keys that are included in the PlayerInput. @public */
 export declare const SUPPORTED_INPUT_KEYS: readonly ["w", "a", "s", "d", "sp", "sh", "tb", "ml", "mr", "q", "e", "r", "f", "z", "x", "c", "v", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0"];
 
 /**