hytopia 0.6.27 → 0.6.28

package/package.json

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

@@ -47243,6 +47243,101 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!World#fogColor:member",
+              "docComment": "/**\n * The color of the fog, if not explicitly set, defaults to ambient light color.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get fogColor(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RgbColor",
+                  "canonicalReference": "server!RgbColor:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "fogColor",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!World#fogFar:member",
+              "docComment": "/**\n * The maximum distance from the camera at which fog stops being applied.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get fogFar(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "fogFar",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!World#fogNear:member",
+              "docComment": "/**\n * The minimum distance from the camera to start applying fog.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get fogNear(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "fogNear",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!World#id:member",
@@ -47688,6 +47783,155 @@
               "isAbstract": false,
               "name": "setDirectionalLightPosition"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!World#setFogColor:member(1)",
+              "docComment": "/**\n * Sets the color of the world's fog.\n *\n * @param color - The color of the fog, or undefined to reset to ambient light color.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setFogColor(color: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RgbColor",
+                  "canonicalReference": "server!RgbColor:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 4,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "color",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 3
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setFogColor"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!World#setFogFar:member(1)",
+              "docComment": "/**\n * Sets the maximum distance from the camera at which fog stops being applied.\n *\n * @param far - The far distance.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setFogFar(far: "
+                },
+                {
+                  "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": "far",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setFogFar"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!World#setFogNear:member(1)",
+              "docComment": "/**\n * Sets the minimum distance from the camera to start applying fog.\n *\n * @param near - The near distance.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setFogNear(near: "
+                },
+                {
+                  "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": "near",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setFogNear"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!World#setSkyboxIntensity:member(1)",
@@ -48051,6 +48295,69 @@
               "releaseTag": "Public",
               "name": "SET_DIRECTIONAL_LIGHT_POSITION"
             },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "server!WorldEvent.SET_FOG_COLOR:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "SET_FOG_COLOR = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"WORLD.SET_FOG_COLOR\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "SET_FOG_COLOR"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "server!WorldEvent.SET_FOG_FAR:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "SET_FOG_FAR = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"WORLD.SET_FOG_FAR\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "SET_FOG_FAR"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "server!WorldEvent.SET_FOG_NEAR:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "SET_FOG_NEAR = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"WORLD.SET_FOG_NEAR\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "SET_FOG_NEAR"
+            },
             {
               "kind": "EnumMember",
               "canonicalReference": "server!WorldEvent.SET_SKYBOX_INTENSITY:member",
@@ -48383,6 +48690,150 @@
                 "endIndex": 8
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!WorldEventPayloads#\"WORLD.SET_FOG_COLOR\":member",
+              "docComment": "/**\n * Emitted when the color of the world's fog is set.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "["
+                },
+                {
+                  "kind": "Reference",
+                  "text": "WorldEvent.SET_FOG_COLOR",
+                  "canonicalReference": "server!WorldEvent.SET_FOG_COLOR:member"
+                },
+                {
+                  "kind": "Content",
+                  "text": "]: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        world: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "World",
+                  "canonicalReference": "server!World:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n        color: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RgbColor",
+                  "canonicalReference": "server!RgbColor:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "\"WORLD.SET_FOG_COLOR\"",
+              "propertyTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 8
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!WorldEventPayloads#\"WORLD.SET_FOG_FAR\":member",
+              "docComment": "/**\n * Emitted when the density of the world's fog is set.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "["
+                },
+                {
+                  "kind": "Reference",
+                  "text": "WorldEvent.SET_FOG_FAR",
+                  "canonicalReference": "server!WorldEvent.SET_FOG_FAR:member"
+                },
+                {
+                  "kind": "Content",
+                  "text": "]: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        world: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "World",
+                  "canonicalReference": "server!World:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n        far: number;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "\"WORLD.SET_FOG_FAR\"",
+              "propertyTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 6
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!WorldEventPayloads#\"WORLD.SET_FOG_NEAR\":member",
+              "docComment": "/**\n * Emitted when the density of the world's fog is set.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "["
+                },
+                {
+                  "kind": "Reference",
+                  "text": "WorldEvent.SET_FOG_NEAR",
+                  "canonicalReference": "server!WorldEvent.SET_FOG_NEAR:member"
+                },
+                {
+                  "kind": "Content",
+                  "text": "]: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        world: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "World",
+                  "canonicalReference": "server!World:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n        near: number;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "\"WORLD.SET_FOG_NEAR\"",
+              "propertyTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 6
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!WorldEventPayloads#\"WORLD.SET_SKYBOX_INTENSITY\":member",
@@ -49817,6 +50268,88 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!WorldOptions#fogColor:member",
+              "docComment": "/**\n * The color of the fog for the world. Defaults to ambient light color.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "fogColor?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RgbColor",
+                  "canonicalReference": "server!RgbColor:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "fogColor",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!WorldOptions#fogFar:member",
+              "docComment": "/**\n * The maximum distance from the camera at which fog stops being applied.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "fogFar?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "fogFar",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!WorldOptions#fogNear:member",
+              "docComment": "/**\n * The minimum distance from the camera to start applying fog.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "fogNear?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "fogNear",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!WorldOptions#gravity:member",

package/server.d.ts

@@ -6078,6 +6078,9 @@ export declare class World extends EventRouter implements protocol.Serializable
 
 
 
+
+
+
 
 
 
@@ -6097,6 +6100,12 @@ export declare class World extends EventRouter implements protocol.Serializable
     get directionalLightIntensity(): number;
     /** The position the directional light originates from. */
     get directionalLightPosition(): Vector3Like;
+    /** The color of the fog, if not explicitly set, defaults to ambient light color. */
+    get fogColor(): RgbColor | undefined;
+    /** The maximum distance from the camera at which fog stops being applied. */
+    get fogFar(): number;
+    /** The minimum distance from the camera to start applying fog. */
+    get fogNear(): number;
     /** The name of the world. */
     get name(): string;
     /** The intensity of the world's skybox brightness. */
@@ -6154,6 +6163,21 @@ export declare class World extends EventRouter implements protocol.Serializable
      * @param position - The position in the world.
      */
     setDirectionalLightPosition(position: Vector3Like): void;
+    /**
+     * Sets the color of the world's fog.
+     * @param color - The color of the fog, or undefined to reset to ambient light color.
+     */
+    setFogColor(color: RgbColor | undefined): void;
+    /**
+     * Sets the maximum distance from the camera at which fog stops being applied.
+     * @param far - The far distance.
+     */
+    setFogFar(far: number): void;
+    /**
+     * Sets the minimum distance from the camera to start applying fog.
+     * @param near - The near distance.
+     */
+    setFogNear(near: number): void;
     /**
      * Sets the intensity of the world's skybox brightness.
      * @param intensity - The intensity.
@@ -6177,6 +6201,9 @@ 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_FOG_COLOR = "WORLD.SET_FOG_COLOR",
+    SET_FOG_FAR = "WORLD.SET_FOG_FAR",
+    SET_FOG_NEAR = "WORLD.SET_FOG_NEAR",
     SET_SKYBOX_INTENSITY = "WORLD.SET_SKYBOX_INTENSITY",
     START = "WORLD.START",
     STOP = "WORLD.STOP"
@@ -6209,6 +6236,21 @@ export declare interface WorldEventPayloads {
         world: World;
         position: Vector3Like;
     };
+    /** Emitted when the color of the world's fog is set. */
+    [WorldEvent.SET_FOG_COLOR]: {
+        world: World;
+        color: RgbColor;
+    };
+    /** Emitted when the density of the world's fog is set. */
+    [WorldEvent.SET_FOG_FAR]: {
+        world: World;
+        far: number;
+    };
+    /** Emitted when the density of the world's fog is set. */
+    [WorldEvent.SET_FOG_NEAR]: {
+        world: World;
+        near: number;
+    };
     /** Emitted when the intensity of the world's skybox brightness is set. */
     [WorldEvent.SET_SKYBOX_INTENSITY]: {
         world: World;
@@ -6425,6 +6467,12 @@ export declare interface WorldOptions {
     directionalLightIntensity?: number;
     /** The position the directional light originates from for the world. */
     directionalLightPosition?: Vector3Like;
+    /** The color of the fog for the world. Defaults to ambient light color. */
+    fogColor?: RgbColor;
+    /** The maximum distance from the camera at which fog stops being applied.  */
+    fogFar?: number;
+    /** The minimum distance from the camera to start applying fog. */
+    fogNear?: number;
     /** The map of the world. */
     map?: WorldMap;
     /** The name of the world. */