hytopia 0.11.6 → 0.11.8

package/docs/server.assetslibrary.assetslibrarypath.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; [AssetsLibrary](./server.assetslibrary.md) &gt; [assetsLibraryPath](./server.assetslibrary.assetslibrarypath.md)
+
+## AssetsLibrary.assetsLibraryPath property
+
+The path to the assets library package. Null if assets library is not available.
+
+**Signature:**
+
+```typescript
+readonly assetsLibraryPath: string | null;
+```

package/docs/server.assetslibrary.instance.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; [AssetsLibrary](./server.assetslibrary.md) &gt; [instance](./server.assetslibrary.instance.md)
+
+## AssetsLibrary.instance property
+
+The global AssetsLibrary instance as a singleton.
+
+**Signature:**
+
+```typescript
+static readonly instance: AssetsLibrary;
+```

package/docs/server.assetslibrary.md

@@ -0,0 +1,133 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [AssetsLibrary](./server.assetslibrary.md)
+
+## AssetsLibrary class
+
+Manages the assets library and synchronization of assets to the local assets directory in development.
+
+**Signature:**
+
+```typescript
+export default class AssetsLibrary 
+```
+
+## 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');
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[assetsLibraryPath](./server.assetslibrary.assetslibrarypath.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string \| null
+
+
+</td><td>
+
+The path to the assets library package. Null if assets library is not available.
+
+
+</td></tr>
+<tr><td>
+
+[instance](./server.assetslibrary.instance.md)
+
+
+</td><td>
+
+`static`
+
+`readonly`
+
+
+</td><td>
+
+[AssetsLibrary](./server.assetslibrary.md)
+
+
+</td><td>
+
+The global AssetsLibrary instance as a singleton.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[syncAsset(assetPath)](./server.assetslibrary.syncasset.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Synchronizes an asset from the assets library to the local assets directory.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/server.assetslibrary.syncasset.md

@@ -0,0 +1,58 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [AssetsLibrary](./server.assetslibrary.md) &gt; [syncAsset](./server.assetslibrary.syncasset.md)
+
+## AssetsLibrary.syncAsset() method
+
+Synchronizes an asset from the assets library to the local assets directory.
+
+**Signature:**
+
+```typescript
+syncAsset(assetPath: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+assetPath
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The path of the asset to copy to local assets.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+
+## 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.
+

package/docs/server.md

@@ -19,6 +19,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[AssetsLibrary](./server.assetslibrary.md)
+
+
+</td><td>
+
+Manages the assets library and synchronization of assets to the local assets directory in development.
+
+
+</td></tr>
+<tr><td>
+
 [Audio](./server.audio.md)
 
 

package/package.json

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

@@ -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",

package/server.d.ts

@@ -12,6 +12,45 @@ import * as Sentry from '@sentry/node';
 import type { Socket } from 'net';
 import { WebSocket as WebSocket_2 } from 'ws';
 
+/**
+ * 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.
  *