hytopia 0.10.14 → 0.10.16

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. If it returns an empty object {<!-- -->}<!-- -->, the player data loaded successfully but no prior data has been set.
 

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.14",
+  "version": "0.10.16",
   "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

@@ -35243,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",
@@ -35253,6 +35253,14 @@
                   "kind": "Content",
                   "text": "string"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", maxRetries?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -35273,7 +35281,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<string, unknown> | void>"
+                  "text": "<string, unknown> | undefined>"
                 },
                 {
                   "kind": "Content",
@@ -35282,8 +35290,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 7
+                "startIndex": 5,
+                "endIndex": 9
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -35296,6 +35304,14 @@
                     "endIndex": 2
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "maxRetries",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
                 }
               ],
               "isOptional": false,
@@ -35379,7 +35395,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<string, unknown> | void>"
+                  "text": "<string, unknown> | undefined>"
                 },
                 {
                   "kind": "Content",
@@ -35562,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. If it returns an empty object {}, the player data loaded successfully but no prior data has been set.\n *\n * @returns The persisted data for the player.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -35769,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

@@ -4340,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
@@ -4350,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>;
 
 
 }
@@ -4403,7 +4404,11 @@ 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. If it returns
+     * an empty object {}, the player data loaded successfully but
+     * no prior data has been set.
      *
      * @returns The persisted data for the player.
      */
@@ -4433,7 +4438,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.