hytopia 0.1.67 → 0.1.68

package/docs/server.sceneui.md

@@ -217,6 +217,25 @@ string
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[viewDistance](./server.sceneui.viewdistance.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number \| undefined
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 
@@ -326,6 +345,20 @@ Sets the position of the SceneUI. Will detach from entity if attached.
 Sets the state of the SceneUI by performing a shallow merge with existing state.
 
 
+</td></tr>
+<tr><td>
+
+[setViewDistance(viewDistance)](./server.sceneui.setviewdistance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the view distance of the SceneUI.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.sceneui.setviewdistance.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUI](./server.sceneui.md) &gt; [setViewDistance](./server.sceneui.setviewdistance.md)
+
+## SceneUI.setViewDistance() method
+
+Sets the view distance of the SceneUI.
+
+**Signature:**
+
+```typescript
+setViewDistance(viewDistance: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+viewDistance
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The view distance in the world.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.sceneui.viewdistance.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUI](./server.sceneui.md) &gt; [viewDistance](./server.sceneui.viewdistance.md)
+
+## SceneUI.viewDistance property
+
+**Signature:**
+
+```typescript
+get viewDistance(): number | undefined;
+```

package/docs/server.sceneuioptions.md

@@ -129,5 +129,24 @@ string
 The template ID to use for this SceneUI
 
 
+</td></tr>
+<tr><td>
+
+[viewDistance?](./server.sceneuioptions.viewdistance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The maximum view distance the SceneUI will be visible to the player
+
+
 </td></tr>
 </tbody></table>

package/docs/server.sceneuioptions.viewdistance.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUIOptions](./server.sceneuioptions.md) &gt; [viewDistance](./server.sceneuioptions.viewdistance.md)
+
+## SceneUIOptions.viewDistance property
+
+The maximum view distance the SceneUI will be visible to the player
+
+**Signature:**
+
+```typescript
+viewDistance?: number;
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.1.67",
+  "version": "0.1.68",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "main": "server.js",
   "bin": {

package/server.api.json

@@ -24754,6 +24754,54 @@
               "isAbstract": false,
               "name": "setState"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!SceneUI#setViewDistance:member(1)",
+              "docComment": "/**\n * Sets the view distance of the SceneUI.\n *\n * @param viewDistance - The view distance in the world.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setViewDistance(viewDistance: "
+                },
+                {
+                  "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": "viewDistance",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setViewDistance"
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!SceneUI#state:member",
@@ -24850,6 +24898,36 @@
               "isAbstract": false,
               "name": "unload"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!SceneUI#viewDistance:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get viewDistance(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "viewDistance",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!SceneUI#world:member",
@@ -25234,6 +25312,33 @@
                 "startIndex": 1,
                 "endIndex": 2
               }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!SceneUIOptions#viewDistance:member",
+              "docComment": "/**\n * The maximum view distance the SceneUI will be visible to the player\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "viewDistance?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "viewDistance",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
             }
           ],
           "extendsTokenRanges": []

package/server.d.ts

@@ -3034,6 +3034,7 @@ export declare class SceneUI implements protocol.Serializable {
 
 
 
+
     /**
      * @param options - The options for the SceneUI instance.
      */
@@ -3045,6 +3046,7 @@ export declare class SceneUI implements protocol.Serializable {
     get position(): Vector3Like | undefined;
     get state(): Readonly<object>;
     get templateId(): string;
+    get viewDistance(): number | undefined;
     get world(): World | undefined;
     /**
      * Loads the SceneUI into the world.
@@ -3076,6 +3078,12 @@ export declare class SceneUI implements protocol.Serializable {
      * @param state - The state to set.
      */
     setState(state: object): void;
+    /**
+     * Sets the view distance of the SceneUI.
+     *
+     * @param viewDistance - The view distance in the world.
+     */
+    setViewDistance(viewDistance: number): void;
     /**
      * Unloads the SceneUI from the world.
      */
@@ -3137,6 +3145,8 @@ export declare interface SceneUIOptions {
     state?: object;
     /** The template ID to use for this SceneUI */
     templateId: string;
+    /** The maximum view distance the SceneUI will be visible to the player */
+    viewDistance?: number;
 }
 
 /**