hytopia 0.1.48 → 0.1.49

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.1.48",
+  "version": "0.1.49",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "main": "server.js",
   "bin": {

package/server.api.json

@@ -13473,7 +13473,7 @@
                 {
                   "kind": "Reference",
                   "text": "PlayerUI",
-                  "canonicalReference": "server!~PlayerUI:class"
+                  "canonicalReference": "server!PlayerUI:class"
                 },
                 {
                   "kind": "Content",
@@ -16750,6 +16750,411 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Class",
+          "canonicalReference": "server!PlayerUI:class",
+          "docComment": "/**\n * The UI for a player.\n *\n * @remarks\n *\n * UI allows control of all in-game overlays a player sees. UI is controlled by HTML, CSS and JavaScript files you provide in your `assets` folder.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlayerUI` class.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export default class PlayerUI "
+            }
+          ],
+          "fileUrlPath": "src/networking/players/PlayerUI.ts",
+          "releaseTag": "Public",
+          "isAbstract": false,
+          "name": "PlayerUI",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Method",
+              "canonicalReference": "server!PlayerUI#load:member(1)",
+              "docComment": "/**\n * Loads client UI for the player.\n *\n * @param htmlUri - The ui html uri to load.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "load(htmlUri: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "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": "htmlUri",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "load"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PlayerUI#onData:member",
+              "docComment": "/**\n * A function that is called when the player's client UI sends data to the server.\n *\n * @remarks\n *\n * Data sent is an object of any shape defined by you and controlled with invocations of `hytopia.ui.sendData()` from your loaded client UI files.\n *\n * @param playerUI - The PlayerUI instance that the data is from.\n *\n * @param data - The data sent from the client UI.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onData?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(playerUI: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PlayerUI",
+                  "canonicalReference": "server!PlayerUI:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", data: object) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "onData",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PlayerUI#player:member",
+              "docComment": "/**\n * The player that the UI belongs to.\n *\n * @readonly\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly player: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Player",
+                  "canonicalReference": "server!Player:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "player",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!PlayerUI#sendData:member(1)",
+              "docComment": "/**\n * Sends data to the player's client UI.\n *\n * @param data - The data to send to the client UI.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "sendData(data: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "object"
+                },
+                {
+                  "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": "data",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "sendData"
+            }
+          ],
+          "implementsTokenRanges": []
+        },
+        {
+          "kind": "Namespace",
+          "canonicalReference": "server!PlayerUIEventPayload:namespace",
+          "docComment": "/**\n * Payloads for events a PlayerUI instance can emit.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare namespace PlayerUIEventPayload "
+            }
+          ],
+          "fileUrlPath": "src/networking/players/PlayerUI.ts",
+          "releaseTag": "Public",
+          "name": "PlayerUIEventPayload",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Interface",
+              "canonicalReference": "server!PlayerUIEventPayload.Load:interface",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "interface Load "
+                }
+              ],
+              "releaseTag": "Public",
+              "name": "Load",
+              "preserveMemberOrder": false,
+              "members": [
+                {
+                  "kind": "PropertySignature",
+                  "canonicalReference": "server!PlayerUIEventPayload.Load#htmlUri:member",
+                  "docComment": "",
+                  "excerptTokens": [
+                    {
+                      "kind": "Content",
+                      "text": "htmlUri: "
+                    },
+                    {
+                      "kind": "Content",
+                      "text": "string"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ";"
+                    }
+                  ],
+                  "isReadonly": false,
+                  "isOptional": false,
+                  "releaseTag": "Public",
+                  "name": "htmlUri",
+                  "propertyTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                },
+                {
+                  "kind": "PropertySignature",
+                  "canonicalReference": "server!PlayerUIEventPayload.Load#playerUI:member",
+                  "docComment": "",
+                  "excerptTokens": [
+                    {
+                      "kind": "Content",
+                      "text": "playerUI: "
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "PlayerUI",
+                      "canonicalReference": "server!PlayerUI:class"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ";"
+                    }
+                  ],
+                  "isReadonly": false,
+                  "isOptional": false,
+                  "releaseTag": "Public",
+                  "name": "playerUI",
+                  "propertyTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                }
+              ],
+              "extendsTokenRanges": []
+            },
+            {
+              "kind": "Interface",
+              "canonicalReference": "server!PlayerUIEventPayload.SendData:interface",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "interface SendData "
+                }
+              ],
+              "releaseTag": "Public",
+              "name": "SendData",
+              "preserveMemberOrder": false,
+              "members": [
+                {
+                  "kind": "PropertySignature",
+                  "canonicalReference": "server!PlayerUIEventPayload.SendData#data:member",
+                  "docComment": "",
+                  "excerptTokens": [
+                    {
+                      "kind": "Content",
+                      "text": "data: "
+                    },
+                    {
+                      "kind": "Content",
+                      "text": "object"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ";"
+                    }
+                  ],
+                  "isReadonly": false,
+                  "isOptional": false,
+                  "releaseTag": "Public",
+                  "name": "data",
+                  "propertyTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                },
+                {
+                  "kind": "PropertySignature",
+                  "canonicalReference": "server!PlayerUIEventPayload.SendData#playerUI:member",
+                  "docComment": "",
+                  "excerptTokens": [
+                    {
+                      "kind": "Content",
+                      "text": "playerUI: "
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "PlayerUI",
+                      "canonicalReference": "server!PlayerUI:class"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ";"
+                    }
+                  ],
+                  "isReadonly": false,
+                  "isOptional": false,
+                  "releaseTag": "Public",
+                  "name": "playerUI",
+                  "propertyTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                }
+              ],
+              "extendsTokenRanges": []
+            }
+          ]
+        },
+        {
+          "kind": "Enum",
+          "canonicalReference": "server!PlayerUIEventType:enum",
+          "docComment": "/**\n * Event types a\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare enum PlayerUIEventType "
+            }
+          ],
+          "fileUrlPath": "src/networking/players/PlayerUI.ts",
+          "releaseTag": "Public",
+          "name": "PlayerUIEventType",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "server!PlayerUIEventType.LOAD:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "LOAD = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"PLAYER_UI.LOAD\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "LOAD"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "server!PlayerUIEventType.SEND_DATA:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "SEND_DATA = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"PLAYER_UI.SEND_DATA\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "SEND_DATA"
+            }
+          ]
+        },
         {
           "kind": "Variable",
           "canonicalReference": "server!PORT:var",
@@ -22393,58 +22798,10 @@
               "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 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",
+              "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",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -22591,36 +22948,6 @@
               "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",

package/server.d.ts

@@ -2196,7 +2196,7 @@ export declare type PlayerOrientationState = {
  *
  * @public
  */
-declare class PlayerUI {
+export declare class PlayerUI {
     /** The player that the UI belongs to. @readonly */
     readonly player: Player;
     /**
@@ -2225,6 +2225,24 @@ declare class PlayerUI {
     sendData(data: object): void;
 }
 
+/** Payloads for events a PlayerUI instance can emit. @public */
+export declare namespace PlayerUIEventPayload {
+    export interface Load {
+        playerUI: PlayerUI;
+        htmlUri: string;
+    }
+    export interface SendData {
+        playerUI: PlayerUI;
+        data: object;
+    }
+}
+
+/** Event types a  */
+export declare enum PlayerUIEventType {
+    LOAD = "PLAYER_UI.LOAD",
+    SEND_DATA = "PLAYER_UI.SEND_DATA"
+}
+
 /**
  * The port the server will run on. You can override
  * this in your .env by setting PORT. When deployed in
@@ -2971,9 +2989,6 @@ 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. */
@@ -2993,16 +3008,9 @@ 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 and rigid body outlines
+     * 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.
      * @param enabled - Whether to enable debug rendering.