hytopia 0.11.1 → 0.11.3

package/boilerplate/index.ts

@@ -130,7 +130,7 @@ startServer(world => {
    */
   
   new Audio({
-    uri: 'audio/music/hytopia-main.mp3',
+    uri: 'audio/music/hytopia-main-theme.mp3',
     loop: true,
     volume: 0.1,
   }).play(world);

package/docs/server.blocktexturemetadata.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BlockTextureMetadata](./server.blocktexturemetadata.md)
+
+## BlockTextureMetadata type
+
+Block texture metadata including UVs and rendering hints.
+
+**Signature:**
+
+```typescript
+export type BlockTextureMetadata = {
+    u0: number;
+    v0: number;
+    u1: number;
+    v1: number;
+    averageRGB: [number, number, number];
+    isTransparent: boolean;
+    needsAlphaTest: boolean;
+};
+```

package/docs/server.blocktextureregistry.generateeverystart.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; [BlockTextureRegistry](./server.blocktextureregistry.md) &gt; [generateEveryStart](./server.blocktextureregistry.generateeverystart.md)
+
+## BlockTextureRegistry.generateEveryStart property
+
+Whether to always generate the atlas on server start.
+
+**Signature:**
+
+```typescript
+generateEveryStart: boolean;
+```

package/docs/server.blocktextureregistry.getblocktexturemetadata.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BlockTextureRegistry](./server.blocktextureregistry.md) &gt; [getBlockTextureMetadata](./server.blocktextureregistry.getblocktexturemetadata.md)
+
+## BlockTextureRegistry.getBlockTextureMetadata() method
+
+Retrieves metadata for a block texture. Returns array for cubemaps (6 faces) or standard textures (1 face).
+
+**Signature:**
+
+```typescript
+getBlockTextureMetadata(textureUri: string): BlockTextureMetadata[] | undefined;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+textureUri
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The URI of the texture (e.g., 'blocks/stone.png' or 'blocks/grass').
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[BlockTextureMetadata](./server.blocktexturemetadata.md)<!-- -->\[\] \| undefined
+
+Array of texture metadata, or undefined if not found.
+

package/docs/server.blocktextureregistry.hasblocktexture.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BlockTextureRegistry](./server.blocktextureregistry.md) &gt; [hasBlockTexture](./server.blocktextureregistry.hasblocktexture.md)
+
+## BlockTextureRegistry.hasBlockTexture() method
+
+Checks if a block texture is registered in the atlas.
+
+**Signature:**
+
+```typescript
+hasBlockTexture(textureUri: string): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+textureUri
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The URI of the texture (e.g., 'blocks/stone.png' or 'blocks/grass' for cubemaps).
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+boolean
+
+Whether the texture is registered.
+

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

package/docs/server.blocktextureregistry.md

@@ -0,0 +1,145 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BlockTextureRegistry](./server.blocktextureregistry.md)
+
+## BlockTextureRegistry class
+
+Manages block textures and block texture atlas generation of the game.
+
+**Signature:**
+
+```typescript
+export default class BlockTextureRegistry 
+```
+
+## Remarks
+
+The BlockTextureRegistry is created internally as a global singletone accessible with the static property `BlockTextureRegistry.instance`<!-- -->.
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BlockTextureRegistry` class.
+
+## Example
+
+
+```typescript
+import { BlockTextureRegistry } from 'hytopia';
+
+const blockTextureRegistry = BlockTextureRegistry.instance;
+const metadata = blockTextureRegistry.getBlockTextureMetadata('blocks/stone.png');
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[generateEveryStart](./server.blocktextureregistry.generateeverystart.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether to always generate the atlas on server start.
+
+
+</td></tr>
+<tr><td>
+
+[instance](./server.blocktextureregistry.instance.md)
+
+
+</td><td>
+
+`static`
+
+`readonly`
+
+
+</td><td>
+
+[BlockTextureRegistry](./server.blocktextureregistry.md)
+
+
+</td><td>
+
+The global BlockTextureRegistry 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>
+
+[getBlockTextureMetadata(textureUri)](./server.blocktextureregistry.getblocktexturemetadata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves metadata for a block texture. Returns array for cubemaps (6 faces) or standard textures (1 face).
+
+
+</td></tr>
+<tr><td>
+
+[hasBlockTexture(textureUri)](./server.blocktextureregistry.hasblocktexture.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Checks if a block texture is registered in the atlas.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/server.gameserver.blocktextureregistry.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; [GameServer](./server.gameserver.md) &gt; [blockTextureRegistry](./server.gameserver.blocktextureregistry.md)
+
+## GameServer.blockTextureRegistry property
+
+The block texture registry for the game server.
+
+**Signature:**
+
+```typescript
+get blockTextureRegistry(): BlockTextureRegistry;
+```

package/docs/server.gameserver.md

@@ -43,6 +43,27 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[blockTextureRegistry](./server.gameserver.blocktextureregistry.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[BlockTextureRegistry](./server.blocktextureregistry.md)
+
+
+</td><td>
+
+The block texture registry for the game server.
+
+
+</td></tr>
+<tr><td>
+
 [instance](./server.gameserver.instance.md)
 
 

package/docs/server.md

@@ -49,6 +49,17 @@ Manages audio instances in a world.
 Represents a block in a world.
 
 
+</td></tr>
+<tr><td>
+
+[BlockTextureRegistry](./server.blocktextureregistry.md)
+
+
+</td><td>
+
+Manages block textures and block texture atlas generation of the game.
+
+
 </td></tr>
 <tr><td>
 
@@ -1539,6 +1550,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[BlockTextureMetadata](./server.blocktexturemetadata.md)
+
+
+</td><td>
+
+Block texture metadata including UVs and rendering hints.
+
+
+</td></tr>
+<tr><td>
+
 [ColliderOptions](./server.collideroptions.md)
 
 

package/package.json

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

@@ -4869,6 +4869,213 @@
             }
           ]
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "server!BlockTextureMetadata:type",
+          "docComment": "/**\n * Block texture metadata including UVs and rendering hints.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type BlockTextureMetadata = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    u0: number;\n    v0: number;\n    u1: number;\n    v1: number;\n    averageRGB: [number, number, number];\n    isTransparent: boolean;\n    needsAlphaTest: boolean;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/textures/BlockTextureRegistry.ts",
+          "releaseTag": "Public",
+          "name": "BlockTextureMetadata",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Class",
+          "canonicalReference": "server!BlockTextureRegistry:class",
+          "docComment": "/**\n * Manages block textures and block texture atlas generation of the game.\n *\n * @remarks\n *\n * The BlockTextureRegistry is created internally as a global singletone accessible with the static property `BlockTextureRegistry.instance`.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BlockTextureRegistry` class.\n *\n * @example\n * ```typescript\n * import { BlockTextureRegistry } from 'hytopia';\n *\n * const blockTextureRegistry = BlockTextureRegistry.instance;\n * const metadata = blockTextureRegistry.getBlockTextureMetadata('blocks/stone.png');\n * ```\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export default class BlockTextureRegistry "
+            }
+          ],
+          "fileUrlPath": "src/textures/BlockTextureRegistry.ts",
+          "releaseTag": "Public",
+          "isAbstract": false,
+          "name": "BlockTextureRegistry",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Property",
+              "canonicalReference": "server!BlockTextureRegistry#generateEveryStart:member",
+              "docComment": "/**\n * Whether to always generate the atlas on server start.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "generateEveryStart: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "generateEveryStart",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!BlockTextureRegistry#getBlockTextureMetadata:member(1)",
+              "docComment": "/**\n * Retrieves metadata for a block texture. Returns array for cubemaps (6 faces) or standard textures (1 face).\n *\n * @param textureUri - The URI of the texture (e.g., 'blocks/stone.png' or 'blocks/grass').\n *\n * @returns Array of texture metadata, or undefined if not found.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getBlockTextureMetadata(textureUri: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BlockTextureMetadata",
+                  "canonicalReference": "server!BlockTextureMetadata:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[] | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "textureUri",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getBlockTextureMetadata"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!BlockTextureRegistry#hasBlockTexture:member(1)",
+              "docComment": "/**\n * Checks if a block texture is registered in the atlas.\n *\n * @param textureUri - The URI of the texture (e.g., 'blocks/stone.png' or 'blocks/grass' for cubemaps).\n *\n * @returns Whether the texture is registered.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "hasBlockTexture(textureUri: "
+                },
+                {
+                  "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": "textureUri",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "hasBlockTexture"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!BlockTextureRegistry.instance:member",
+              "docComment": "/**\n * The global BlockTextureRegistry instance as a singleton.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "static readonly instance: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BlockTextureRegistry",
+                  "canonicalReference": "server!BlockTextureRegistry:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "instance",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": true,
+              "isProtected": false,
+              "isAbstract": false
+            }
+          ],
+          "implementsTokenRanges": []
+        },
         {
           "kind": "Class",
           "canonicalReference": "server!BlockType:class",
@@ -19709,6 +19916,37 @@
           "name": "GameServer",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "Property",
+              "canonicalReference": "server!GameServer#blockTextureRegistry:member",
+              "docComment": "/**\n * The block texture registry for the game server.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get blockTextureRegistry(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BlockTextureRegistry",
+                  "canonicalReference": "server!BlockTextureRegistry:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "blockTextureRegistry",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!GameServer.instance:member",