hytopia 0.12.0-prerelease-1 → 0.12.0-prerelease-3

package/server.api.json

@@ -173,6 +173,134 @@
       "name": "",
       "preserveMemberOrder": false,
       "members": [
+        {
+          "kind": "Class",
+          "canonicalReference": "server!AssetsLibrary:class",
+          "docComment": "/**\n * Manages the assets library and synchronization of assets to the local assets directory in development.\n *\n * @remarks\n *\n * The AssetsLibrary is created internally as a global singletone accessible with the static property `AssetsLibrary.instance`.\n *\n * Please note: Assets will automatically sync to local assets in development mode the first time an asset in the library is requested by the client. This means you do not need to explicitly handle calling syncAsset() yourself unless you have a specific reason to.\n *\n * @example\n * ```typescript\n * import { AssetsLibrary } from 'hytopia';\n *\n * const assetsLibrary = AssetsLibrary.instance;\n * assetsLibrary.syncAsset('assets/models/player.gltf');\n * ```\n *\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export default class AssetsLibrary "
+            }
+          ],
+          "fileUrlPath": "src/assets/AssetsLibrary.ts",
+          "releaseTag": "Public",
+          "isAbstract": false,
+          "name": "AssetsLibrary",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Property",
+              "canonicalReference": "server!AssetsLibrary#assetsLibraryPath:member",
+              "docComment": "/**\n * The path to the assets library package. Null if assets library is not available.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly assetsLibraryPath: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string | null"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "assetsLibraryPath",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!AssetsLibrary.instance:member",
+              "docComment": "/**\n * The global AssetsLibrary instance as a singleton.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "static readonly instance: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AssetsLibrary",
+                  "canonicalReference": "server!AssetsLibrary:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "instance",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": true,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!AssetsLibrary#syncAsset:member(1)",
+              "docComment": "/**\n * Synchronizes an asset from the assets library to the local assets directory.\n *\n * @remarks\n *\n * Syncs an asset from the assets library to local assets in development. The assets library is unavailable in production, so assets must be local to the project.\n *\n * @param assetPath - The path of the asset to copy to local assets.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "syncAsset(assetPath: "
+                },
+                {
+                  "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": "assetPath",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "syncAsset"
+            }
+          ],
+          "implementsTokenRanges": []
+        },
         {
           "kind": "Class",
           "canonicalReference": "server!Audio:class",
@@ -4913,12 +5041,12 @@
           "members": [
             {
               "kind": "Property",
-              "canonicalReference": "server!BlockTextureRegistry#generateEveryStart:member",
-              "docComment": "/**\n * Whether to always generate the atlas on server start.\n */\n",
+              "canonicalReference": "server!BlockTextureRegistry#generate:member",
+              "docComment": "/**\n * Whether to generate the atlas if needed. Defaults to `true` in development, `false` in production.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "generateEveryStart: "
+                  "text": "generate: "
                 },
                 {
                   "kind": "Content",
@@ -4932,7 +5060,7 @@
               "isReadonly": false,
               "isOptional": false,
               "releaseTag": "Public",
-              "name": "generateEveryStart",
+              "name": "generate",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -28705,6 +28833,54 @@
               "isAbstract": false,
               "name": "getWidth"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!ModelRegistry#hasModel:member(1)",
+              "docComment": "/**\n * Checks if a model is registered in the model registry.\n *\n * @param modelUri - The URI of the model to check.\n *\n * @returns Whether the model is registered.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "hasModel(modelUri: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "modelUri",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "hasModel"
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!ModelRegistry.instance:member",
@@ -28803,7 +28979,7 @@
             {
               "kind": "Property",
               "canonicalReference": "server!ModelRegistry#optimize:member",
-              "docComment": "/**\n * Whether to use optimized models when they are loaded.\n */\n",
+              "docComment": "/**\n * Whether to generate optimized models if needed. Defaults to `true` in development, `false` in production.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -28829,36 +29005,6 @@
               "isStatic": false,
               "isProtected": false,
               "isAbstract": false
-            },
-            {
-              "kind": "Property",
-              "canonicalReference": "server!ModelRegistry#optimizeEveryStart:member",
-              "docComment": "/**\n * Whether to always run model optimization on server start.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "optimizeEveryStart: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "boolean"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "optimizeEveryStart",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
             }
           ],
           "implementsTokenRanges": []

package/server.d.ts

@@ -12,6 +12,45 @@ import type { Socket } from 'net';
 import { WebSocket as WebSocket_2 } from 'ws';
 import type { WebTransportSessionImpl } from '@fails-components/webtransport/dist/lib/types';
 
+/**
+ * Manages the assets library and synchronization of assets
+ * to the local assets directory in development.
+ *
+ * @remarks
+ * The AssetsLibrary is created internally as a global
+ * singletone accessible with the static property
+ * `AssetsLibrary.instance`.
+ *
+ * Please note: Assets will automatically sync to local assets in
+ * development mode the first time an asset in the library is requested
+ * by the client. This means you do not need to explicitly handle
+ * calling syncAsset() yourself unless you have a specific reason to.
+ *
+ * @example
+ * ```typescript
+ * import { AssetsLibrary } from 'hytopia';
+ *
+ * const assetsLibrary = AssetsLibrary.instance;
+ * assetsLibrary.syncAsset('assets/models/player.gltf');
+ * ```
+ */
+export declare class AssetsLibrary {
+    /** The global AssetsLibrary instance as a singleton. */
+    static readonly instance: AssetsLibrary;
+    /** The path to the assets library package. Null if assets library is not available. */
+    readonly assetsLibraryPath: string | null;
+    /**
+     * Synchronizes an asset from the assets library to the local assets directory.
+     *
+     * @remarks
+     * Syncs an asset from the assets library to local assets in development.
+     * The assets library is unavailable in production, so assets must be local to the project.
+     *
+     * @param assetPath - The path of the asset to copy to local assets.
+     */
+    syncAsset(assetPath: string): void;
+}
+
 /**
  * Represents a audio playback in a world.
  *
@@ -597,8 +636,8 @@ export declare type BlockTextureMetadata = {
 export declare class BlockTextureRegistry {
     /** The global BlockTextureRegistry instance as a singleton. */
     static readonly instance: BlockTextureRegistry;
-    /** Whether to always generate the atlas on server start. */
-    generateEveryStart: boolean;
+    /** Whether to generate the atlas if needed. Defaults to `true` in development, `false` in production. */
+    generate: boolean;
 
 
     /**
@@ -3532,10 +3571,8 @@ export declare interface ModelEntityOptions extends BaseEntityOptions {
 export declare class ModelRegistry {
     /** The global ModelRegistry instance as a singleton. */
     static readonly instance: ModelRegistry;
-    /** Whether to use optimized models when they are loaded. */
+    /** Whether to generate optimized models if needed. Defaults to `true` in development, `false` in production. */
     optimize: boolean;
-    /** Whether to always run model optimization on server start. */
-    optimizeEveryStart: boolean;
 
 
 
@@ -3592,6 +3629,13 @@ export declare class ModelRegistry {
      * @returns The width of the model.
      */
     getWidth(modelUri: string): number;
+    /**
+     * Checks if a model is registered in the model registry.
+     *
+     * @param modelUri - The URI of the model to check.
+     * @returns Whether the model is registered.
+     */
+    hasModel(modelUri: string): boolean;
     /**
      * Checks if a model has a node with the given name.
      *