hytopia 0.10.15 → 0.10.17

package/docs/server.player.getpersisteddata.md

@@ -19,5 +19,5 @@ The persisted data for the player.
 
 ## Remarks
 
-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.
+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.world.md

@@ -733,6 +733,20 @@ Sets the minimum distance from the camera to start applying fog.
 Sets the intensity of the world's skybox brightness.
 
 
+</td></tr>
+<tr><td>
+
+[setSkyboxUri(skyboxUri)](./server.world.setskyboxuri.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the cubemap URI of the world's skybox.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.world.setskyboxuri.md

@@ -0,0 +1,54 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [World](./server.world.md) &gt; [setSkyboxUri](./server.world.setskyboxuri.md)
+
+## World.setSkyboxUri() method
+
+Sets the cubemap URI of the world's skybox.
+
+**Signature:**
+
+```typescript
+setSkyboxUri(skyboxUri: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+skyboxUri
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The cubemap URI of the skybox.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/server.worldevent.md

@@ -155,6 +155,20 @@ SET\_SKYBOX\_INTENSITY
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+SET\_SKYBOX\_URI
+
+
+</td><td>
+
+`"WORLD.SET_SKYBOX_URI"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.worldeventpayloads._world.set_skybox_uri_.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; [WorldEventPayloads](./server.worldeventpayloads.md) &gt; ["WORLD.SET\_SKYBOX\_URI"](./server.worldeventpayloads._world.set_skybox_uri_.md)
+
+## WorldEventPayloads."WORLD.SET\_SKYBOX\_URI" property
+
+Emitted when the URI of the world's skybox is set.
+
+**Signature:**
+
+```typescript
+[WorldEvent.SET_SKYBOX_URI]: {
+        world: World;
+        uri: string;
+    };
+```

package/docs/server.worldeventpayloads.md

@@ -205,6 +205,25 @@ Emitted when the density of the world's fog is set.
 Emitted when the intensity of the world's skybox brightness is set.
 
 
+</td></tr>
+<tr><td>
+
+["WORLD.SET\_SKYBOX\_URI"](./server.worldeventpayloads._world.set_skybox_uri_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ world: [World](./server.world.md)<!-- -->; uri: string; }
+
+
+</td><td>
+
+Emitted when the URI of the world's skybox is set.
+
+
 </td></tr>
 <tr><td>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.10.15",
+  "version": "0.10.17",
   "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

@@ -35578,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. 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",
+              "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",
@@ -55091,6 +55091,54 @@
               "isAbstract": false,
               "name": "setSkyboxIntensity"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!World#setSkyboxUri:member(1)",
+              "docComment": "/**\n * Sets the cubemap URI of the world's skybox.\n *\n * @param skyboxUri - The cubemap URI of the skybox.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setSkyboxUri(skyboxUri: "
+                },
+                {
+                  "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": "skyboxUri",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setSkyboxUri"
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!World#simulation:member",
@@ -55490,6 +55538,27 @@
               "releaseTag": "Public",
               "name": "SET_SKYBOX_INTENSITY"
             },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "server!WorldEvent.SET_SKYBOX_URI:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "SET_SKYBOX_URI = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"WORLD.SET_SKYBOX_URI\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "SET_SKYBOX_URI"
+            },
             {
               "kind": "EnumMember",
               "canonicalReference": "server!WorldEvent.START:member",
@@ -55990,6 +56059,51 @@
                 "endIndex": 6
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!WorldEventPayloads#\"WORLD.SET_SKYBOX_URI\":member",
+              "docComment": "/**\n * Emitted when the URI of the world's skybox is set.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "["
+                },
+                {
+                  "kind": "Reference",
+                  "text": "WorldEvent.SET_SKYBOX_URI",
+                  "canonicalReference": "server!WorldEvent.SET_SKYBOX_URI:member"
+                },
+                {
+                  "kind": "Content",
+                  "text": "]: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        world: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "World",
+                  "canonicalReference": "server!World:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n        uri: string;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "\"WORLD.SET_SKYBOX_URI\"",
+              "propertyTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 6
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!WorldEventPayloads#\"WORLD.START\":member",

package/server.d.ts

@@ -4406,7 +4406,9 @@ export declare class Player extends EventRouter implements protocol.Serializable
      * @remarks
      * 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.
+     * 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.
      */
@@ -6980,6 +6982,11 @@ export declare class World extends EventRouter implements protocol.Serializable
      * @param intensity - The intensity.
      */
     setSkyboxIntensity(intensity: number): void;
+    /**
+     * Sets the cubemap URI of the world's skybox.
+     * @param skyboxUri - The cubemap URI of the skybox.
+     */
+    setSkyboxUri(skyboxUri: string): void;
     /**
      * Starts the world loop, which begins ticking physics, entities, etc.
      */
@@ -7002,6 +7009,7 @@ export declare enum WorldEvent {
     SET_FOG_FAR = "WORLD.SET_FOG_FAR",
     SET_FOG_NEAR = "WORLD.SET_FOG_NEAR",
     SET_SKYBOX_INTENSITY = "WORLD.SET_SKYBOX_INTENSITY",
+    SET_SKYBOX_URI = "WORLD.SET_SKYBOX_URI",
     START = "WORLD.START",
     STOP = "WORLD.STOP"
 }
@@ -7053,6 +7061,11 @@ export declare interface WorldEventPayloads {
         world: World;
         intensity: number;
     };
+    /** Emitted when the URI of the world's skybox is set. */
+    [WorldEvent.SET_SKYBOX_URI]: {
+        world: World;
+        uri: string;
+    };
     /** Emitted when the world starts. */
     [WorldEvent.START]: {
         world: World;