hytopia 0.10.13 → 0.10.15

package/docs/server.chatmanager.handlecommand.md

@@ -0,0 +1,72 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ChatManager](./server.chatmanager.md) &gt; [handleCommand](./server.chatmanager.handlecommand.md)
+
+## ChatManager.handleCommand() method
+
+Handle a command if it exists.
+
+**Signature:**
+
+```typescript
+handleCommand(player: Player, message: string): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+player
+
+
+</td><td>
+
+[Player](./server.player.md)
+
+
+</td><td>
+
+The player that sent the command.
+
+
+</td></tr>
+<tr><td>
+
+message
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The full message.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+boolean
+
+True if a command was handled, false otherwise.
+

package/docs/server.chatmanager.md

@@ -60,6 +60,20 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[handleCommand(player, message)](./server.chatmanager.handlecommand.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Handle a command if it exists.
+
+
+</td></tr>
+<tr><td>
+
 [registerCommand(command, callback)](./server.chatmanager.registercommand.md)
 
 

package/docs/server.persistencemanager.getglobaldata.md

@@ -9,7 +9,7 @@ Get global data from the data persistence service.
 **Signature:**
 
 ```typescript
-getGlobalData(key: string): Promise<Record<string, unknown> | void>;
+getGlobalData(key: string, maxRetries?: number): Promise<Record<string, unknown> | undefined>;
 ```
 
 ## Parameters
@@ -45,12 +45,28 @@ string
 The key to get the data from.
 
 
+</td></tr>
+<tr><td>
+
+maxRetries
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The maximum number of retries to attempt in the event of failure.
+
+
 </td></tr>
 </tbody></table>
 
 **Returns:**
 
-Promise&lt;Record&lt;string, unknown&gt; \| void&gt;
+Promise&lt;Record&lt;string, unknown&gt; \| undefined&gt;
 
 The data from the persistence layer.
 

package/docs/server.persistencemanager.md

@@ -84,7 +84,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[getGlobalData(key)](./server.persistencemanager.getglobaldata.md)
+[getGlobalData(key, maxRetries)](./server.persistencemanager.getglobaldata.md)
 
 
 </td><td>

package/docs/server.persistencemanager.setglobaldata.md

@@ -9,7 +9,7 @@ Set global data in the data persistence service. This data is available and shar
 **Signature:**
 
 ```typescript
-setGlobalData(key: string, data: Record<string, unknown>): Promise<Record<string, unknown> | void>;
+setGlobalData(key: string, data: Record<string, unknown>): Promise<Record<string, unknown> | undefined>;
 ```
 
 ## Parameters
@@ -66,5 +66,5 @@ The data to set.
 
 **Returns:**
 
-Promise&lt;Record&lt;string, unknown&gt; \| void&gt;
+Promise&lt;Record&lt;string, unknown&gt; \| undefined&gt;
 

package/docs/server.player.getpersisteddata.md

@@ -19,5 +19,5 @@ The persisted data for the player.
 
 ## Remarks
 
-This method returns the player persisted data.
+This method returns the player persisted data. If it returns undefined, the player data failed to load and your game logic should handle this case appropriately.
 

package/docs/server.player.setpersisteddata.md

@@ -56,5 +56,5 @@ The persisted data for the player.
 
 ## Remarks
 
-This method is asynchronous and returns a promise that resolves to the player data.
+This method is asynchronous and returns a promise that resolves to the player data. Data is set using shallow merge of the existing data. It is recommended that you provide a changed data object for your saved data structure rather than the entire data object to avoid edge cases with data persistence or overwrites.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.10.13",
+  "version": "0.10.15",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "type": "module",
   "main": "./server.mjs",

package/server.api.json

@@ -6301,6 +6301,71 @@
           "name": "ChatManager",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "Method",
+              "canonicalReference": "server!ChatManager#handleCommand:member(1)",
+              "docComment": "/**\n * Handle a command if it exists.\n *\n * @param player - The player that sent the command.\n *\n * @param message - The full message.\n *\n * @returns True if a command was handled, false otherwise.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "handleCommand(player: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Player",
+                  "canonicalReference": "server!Player:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", message: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "player",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "message",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "handleCommand"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!ChatManager#registerCommand:member(1)",
@@ -35178,7 +35243,7 @@
             {
               "kind": "Method",
               "canonicalReference": "server!PersistenceManager#getGlobalData:member(1)",
-              "docComment": "/**\n * Get global data from the data persistence service.\n *\n * @param key - The key to get the data from.\n *\n * @returns The data from the persistence layer.\n */\n",
+              "docComment": "/**\n * Get global data from the data persistence service.\n *\n * @param key - The key to get the data from.\n *\n * @param maxRetries - The maximum number of retries to attempt in the event of failure.\n *\n * @returns The data from the persistence layer.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -35188,6 +35253,14 @@
                   "kind": "Content",
                   "text": "string"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", maxRetries?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -35208,7 +35281,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<string, unknown> | void>"
+                  "text": "<string, unknown> | undefined>"
                 },
                 {
                   "kind": "Content",
@@ -35217,8 +35290,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 7
+                "startIndex": 5,
+                "endIndex": 9
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -35231,6 +35304,14 @@
                     "endIndex": 2
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "maxRetries",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
                 }
               ],
               "isOptional": false,
@@ -35314,7 +35395,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<string, unknown> | void>"
+                  "text": "<string, unknown> | undefined>"
                 },
                 {
                   "kind": "Content",
@@ -35497,7 +35578,7 @@
             {
               "kind": "Method",
               "canonicalReference": "server!Player#getPersistedData:member(1)",
-              "docComment": "/**\n * Get the persisted data for the player.\n *\n * @remarks\n *\n * This method returns the player persisted data.\n *\n * @returns The persisted data for the player.\n */\n",
+              "docComment": "/**\n * Get the persisted data for the player.\n *\n * @remarks\n *\n * This method returns the player persisted data. If it returns undefined, the player data failed to load and your game logic should handle this case appropriately.\n *\n * @returns The persisted data for the player.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -35704,7 +35785,7 @@
             {
               "kind": "Method",
               "canonicalReference": "server!Player#setPersistedData:member(1)",
-              "docComment": "/**\n * Set the persisted data for the player. This data can later be retrieved using {@link Player.getPersistedData}, even if a player disconnects and rejoin a game in the future, or joins a different HYTOPIA managed lobby of your game.\n *\n * @remarks\n *\n * This method is asynchronous and returns a promise that resolves to the player data.\n *\n * @param data - The data to set.\n *\n * @returns The persisted data for the player.\n */\n",
+              "docComment": "/**\n * Set the persisted data for the player. This data can later be retrieved using {@link Player.getPersistedData}, even if a player disconnects and rejoin a game in the future, or joins a different HYTOPIA managed lobby of your game.\n *\n * @remarks\n *\n * This method is asynchronous and returns a promise that resolves to the player data. Data is set using shallow merge of the existing data. It is recommended that you provide a changed data object for your saved data structure rather than the entire data object to avoid edge cases with data persistence or overwrites.\n *\n * @param data - The data to set.\n *\n * @returns The persisted data for the player.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",

package/server.d.ts

@@ -836,6 +836,13 @@ export declare class ChatManager extends EventRouter {
      * ```
      */
     sendBroadcastMessage(message: string, color?: string): void;
+    /**
+     * Handle a command if it exists.
+     * @param player - The player that sent the command.
+     * @param message - The full message.
+     * @returns True if a command was handled, false otherwise.
+     */
+    handleCommand(player: Player, message: string): boolean;
     /**
      * Send a system message to a specific player, only visible to them.
      * @param player - The player to send the message to.
@@ -4333,9 +4340,10 @@ export declare class PersistenceManager {
     /**
      * Get global data from the data persistence service.
      * @param key - The key to get the data from.
+     * @param maxRetries - The maximum number of retries to attempt in the event of failure.
      * @returns The data from the persistence layer.
      */
-    getGlobalData(key: string): Promise<Record<string, unknown> | void>;
+    getGlobalData(key: string, maxRetries?: number): Promise<Record<string, unknown> | undefined>;
 
     /**
      * Set global data in the data persistence service. This
@@ -4343,7 +4351,7 @@ export declare class PersistenceManager {
      * @param key - The key to set the data to.
      * @param data - The data to set.
      */
-    setGlobalData(key: string, data: Record<string, unknown>): Promise<Record<string, unknown> | void>;
+    setGlobalData(key: string, data: Record<string, unknown>): Promise<Record<string, unknown> | undefined>;
 
 
 }
@@ -4396,7 +4404,9 @@ export declare class Player extends EventRouter implements protocol.Serializable
      * Get the persisted data for the player.
      *
      * @remarks
-     * This method returns the player persisted data.
+     * This method returns the player persisted data. If it returns
+     * undefined, the player data failed to load and your game
+     * logic should handle this case appropriately.
      *
      * @returns The persisted data for the player.
      */
@@ -4426,7 +4436,11 @@ export declare class Player extends EventRouter implements protocol.Serializable
      *
      * @remarks
      * This method is asynchronous and returns a promise that
-     * resolves to the player data.
+     * resolves to the player data. Data is set using shallow
+     * merge of the existing data. It is recommended that you
+     * provide a changed data object for your saved data structure
+     * rather than the entire data object to avoid edge cases with
+     * data persistence or overwrites.
      *
      * @param data - The data to set.
      * @returns The persisted data for the player.