hytopia 0.5.20 → 0.5.22-dev1

package/package.json

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

package/server.api.json

@@ -39440,7 +39440,7 @@
         {
           "kind": "Function",
           "canonicalReference": "server!startServer:function(1)",
-          "docComment": "/**\n * The entry point for running game setup and starting the game server.\n *\n * @remarks\n *\n * This function should always be called first when initializing your game. It will internally handle initialization of the physics engine and other systems required systems. All of your game setup logic should be executed in the init function.\n *\n * @param init - A function that initializes the world.\n *\n * @public\n */\n",
+          "docComment": "/**\n * The entry point for running game setup and starting the game server.\n *\n * @remarks\n *\n * This function should always be called first when initializing your game. It will internally handle initialization of the physics engine and other systems required systems. All of your game setup logic should be executed in the init function.\n *\n * @param init - A function that initializes the game. The function can take no parameters to just initialize game logic, or it can accept a world parameter. If it accepts a world parameter, a default world will be automatically created and passed to the function.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -39448,7 +39448,7 @@
             },
             {
               "kind": "Content",
-              "text": "(world: "
+              "text": "((() => void) | ((world: "
             },
             {
               "kind": "Reference",
@@ -39457,7 +39457,7 @@
             },
             {
               "kind": "Content",
-              "text": ") => void"
+              "text": ") => void))"
             },
             {
               "kind": "Content",
@@ -44447,6 +44447,54 @@
               "isAbstract": false,
               "name": "setDirectionalLightPosition"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!World#setSkyboxIntensity:member(1)",
+              "docComment": "/**\n * Sets the intensity of the world's skybox brightness.\n *\n * @param intensity - The intensity.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setSkyboxIntensity(intensity: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "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": "intensity",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setSkyboxIntensity"
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!World#simulation:member",
@@ -44478,6 +44526,36 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!World#skyboxIntensity:member",
+              "docComment": "/**\n * The intensity of the world's skybox brightness.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get skyboxIntensity(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "skyboxIntensity",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!World#skyboxUri:member",
@@ -44732,6 +44810,27 @@
               "releaseTag": "Public",
               "name": "SET_DIRECTIONAL_LIGHT_POSITION"
             },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "server!WorldEvent.SET_SKYBOX_INTENSITY:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "SET_SKYBOX_INTENSITY = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"WORLD.SET_SKYBOX_INTENSITY\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "SET_SKYBOX_INTENSITY"
+            },
             {
               "kind": "EnumMember",
               "canonicalReference": "server!WorldEvent.START:member",
@@ -45043,6 +45142,51 @@
                 "endIndex": 8
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!WorldEventPayloads#\"WORLD.SET_SKYBOX_INTENSITY\":member",
+              "docComment": "/**\n * Emitted when the intensity of the world's skybox brightness is set.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "["
+                },
+                {
+                  "kind": "Reference",
+                  "text": "WorldEvent.SET_SKYBOX_INTENSITY",
+                  "canonicalReference": "server!WorldEvent.SET_SKYBOX_INTENSITY:member"
+                },
+                {
+                  "kind": "Content",
+                  "text": "]: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        world: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "World",
+                  "canonicalReference": "server!World:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n        intensity: number;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "\"WORLD.SET_SKYBOX_INTENSITY\"",
+              "propertyTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 6
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!WorldEventPayloads#\"WORLD.START\":member",
@@ -45946,6 +46090,55 @@
               "isStatic": true,
               "isProtected": false,
               "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!WorldManager#setDefaultWorld:member(1)",
+              "docComment": "/**\n * Sets the default world. This is the world players automatically join when they connect to the game.\n *\n * @param world - The world to set as the default.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setDefaultWorld(world: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "World",
+                  "canonicalReference": "server!World:class"
+                },
+                {
+                  "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": "world",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setDefaultWorld"
             }
           ],
           "implementsTokenRanges": []
@@ -46408,6 +46601,34 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!WorldOptions#map:member",
+              "docComment": "/**\n * The map of the world.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "map?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "WorldMap",
+                  "canonicalReference": "server!WorldMap:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "map",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!WorldOptions#name:member",
@@ -46435,6 +46656,33 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!WorldOptions#skyboxIntensity:member",
+              "docComment": "/**\n * The intensity of the skybox brightness for the world. 0 is black, 1 is full brightness, 1+ is brighter.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "skyboxIntensity?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "skyboxIntensity",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!WorldOptions#skyboxUri:member",

package/server.d.ts

@@ -5088,11 +5088,13 @@ export declare interface SpdMatrix3 extends SdpMatrix3 {
  * and other systems required systems. All of your game setup logic
  * should be executed in the init function.
  *
- * @param init - A function that initializes the world.
+ * @param init - A function that initializes the game. The function can take no parameters
+ * to just initialize game logic, or it can accept a world parameter. If it accepts a world
+ * parameter, a default world will be automatically created and passed to the function.
  *
  * @public
  */
-export declare function startServer(init: (world: World) => void): void;
+export declare function startServer(init: ((() => void) | ((world: World) => void))): void;
 
 /** 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"];
@@ -5699,6 +5701,7 @@ export declare class World extends EventRouter implements protocol.Serializable
 
 
 
+
     /**
      * @param options - The options for the world.
      */
@@ -5717,6 +5720,8 @@ export declare class World extends EventRouter implements protocol.Serializable
     get directionalLightPosition(): Vector3Like;
     /** The name of the world. */
     get name(): string;
+    /** The intensity of the world's skybox brightness. */
+    get skyboxIntensity(): number;
     /** The URI of the skybox cubemap for the world. */
     get skyboxUri(): string;
     /** The audio manager for the world. */
@@ -5770,6 +5775,11 @@ export declare class World extends EventRouter implements protocol.Serializable
      * @param position - The position in the world.
      */
     setDirectionalLightPosition(position: Vector3Like): void;
+    /**
+     * Sets the intensity of the world's skybox brightness.
+     * @param intensity - The intensity.
+     */
+    setSkyboxIntensity(intensity: number): void;
     /**
      * Starts the world loop, which begins ticking physics, entities, etc.
      */
@@ -5788,6 +5798,7 @@ export declare enum WorldEvent {
     SET_DIRECTIONAL_LIGHT_COLOR = "WORLD.SET_DIRECTIONAL_LIGHT_COLOR",
     SET_DIRECTIONAL_LIGHT_INTENSITY = "WORLD.SET_DIRECTIONAL_LIGHT_INTENSITY",
     SET_DIRECTIONAL_LIGHT_POSITION = "WORLD.SET_DIRECTIONAL_LIGHT_POSITION",
+    SET_SKYBOX_INTENSITY = "WORLD.SET_SKYBOX_INTENSITY",
     START = "WORLD.START",
     STOP = "WORLD.STOP"
 }
@@ -5819,6 +5830,11 @@ export declare interface WorldEventPayloads {
         world: World;
         position: Vector3Like;
     };
+    /** Emitted when the intensity of the world's skybox brightness is set. */
+    [WorldEvent.SET_SKYBOX_INTENSITY]: {
+        world: World;
+        intensity: number;
+    };
     /** Emitted when the world starts. */
     [WorldEvent.START]: {
         world: World;
@@ -5943,6 +5959,7 @@ export declare class WorldManager {
     static readonly instance: WorldManager;
 
 
+
     /**
      * Creates a new world.
      * @param options - The options for the world.
@@ -5972,6 +5989,12 @@ export declare class WorldManager {
      * @returns The world with the provided id, or undefined if no world is found.
      */
     getWorld(id: number): World | undefined;
+    /**
+     * Sets the default world. This is the world players
+     * automatically join when they connect to the game.
+     * @param world - The world to set as the default.
+     */
+    setDefaultWorld(world: World): void;
 }
 
 /** Event types a WorldManager instance can emit to the global event router. See {@link WorldManagerEventPayloads} for the payloads. @public */
@@ -6021,8 +6044,12 @@ export declare interface WorldOptions {
     directionalLightIntensity?: number;
     /** The position the directional light originates from for the world. */
     directionalLightPosition?: Vector3Like;
+    /** The map of the world. */
+    map?: WorldMap;
     /** The name of the world. */
     name: string;
+    /** The intensity of the skybox brightness for the world. 0 is black, 1 is full brightness, 1+ is brighter. */
+    skyboxIntensity?: number;
     /** The URI of the skybox cubemap for the world. */
     skyboxUri: string;
     /** An arbitrary identifier tag of the world. Useful for your own logic */