hytopia 0.11.1 → 0.12.0-prerelease-1

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",
@@ -17685,15 +17892,6 @@
               "kind": "Content",
               "text": ", "
             },
-            {
-              "kind": "Reference",
-              "text": "SocketEventPayloads",
-              "canonicalReference": "server!~SocketEventPayloads:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ", "
-            },
             {
               "kind": "Reference",
               "text": "LightEventPayloads",
@@ -17829,10 +18027,6 @@
             {
               "startIndex": 41,
               "endIndex": 42
-            },
-            {
-              "startIndex": 43,
-              "endIndex": 44
             }
           ]
         },
@@ -19709,6 +19903,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",
@@ -40443,29 +40668,6 @@
           ],
           "extendsTokenRanges": []
         },
-        {
-          "kind": "Variable",
-          "canonicalReference": "server!PORT:var",
-          "docComment": "/**\n * The port the server will run on. You can override this in your .env by setting PORT. When deployed in production to HYTOPIA servers, any .env value will be ignored and 8080 will be used.\n *\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "PORT: "
-            },
-            {
-              "kind": "Content",
-              "text": "string | 8080"
-            }
-          ],
-          "fileUrlPath": "src/networking/WebServer.ts",
-          "isReadonly": true,
-          "releaseTag": "Public",
-          "name": "PORT",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          }
-        },
         {
           "kind": "Class",
           "canonicalReference": "server!Quaternion:class",

package/server.d.ts

@@ -2,7 +2,6 @@ import type { AnyPacket } from '@hytopia.com/server-protocol';
 import type { ErrorEvent as ErrorEvent_2 } from 'ws';
 import EventEmitter from 'eventemitter3';
 import http from 'http';
-import type { IncomingMessage } from 'http';
 import type { InputSchema } from '@hytopia.com/server-protocol';
 import type { LobbyMembershipDto } from '@hytopia.com/creative-lib/dist/impl/getSession';
 import protocol from '@hytopia.com/server-protocol';
@@ -11,6 +10,7 @@ import { SdpMatrix3 } from '@dimforge/rapier3d-simd-compat';
 import * as Sentry from '@sentry/node';
 import type { Socket } from 'net';
 import { WebSocket as WebSocket_2 } from 'ws';
+import type { WebTransportSessionImpl } from '@fails-components/webtransport/dist/lib/types';
 
 /**
  * Represents a audio playback in a world.
@@ -563,6 +563,66 @@ export declare interface BlockEntityOptions extends BaseEntityOptions {
     blockHalfExtents?: Vector3Like;
     /** The texture uri of a entity if the entity is a block entity, if set rigidBodyOptions collider shape [0] must be a block */
     blockTextureUri?: string;
+}
+
+/** Block texture metadata including UVs and rendering hints. @public */
+export declare type BlockTextureMetadata = {
+    u0: number;
+    v0: number;
+    u1: number;
+    v1: number;
+    averageRGB: [number, number, number];
+    isTransparent: boolean;
+    needsAlphaTest: boolean;
+};
+
+/**
+ * Manages block textures and block texture atlas generation of the game.
+ *
+ * @remarks
+ * The BlockTextureRegistry is created internally as a global
+ * singletone accessible with the static property
+ * `BlockTextureRegistry.instance`.
+ *
+ * @example
+ * ```typescript
+ * import { BlockTextureRegistry } from 'hytopia';
+ *
+ * const blockTextureRegistry = BlockTextureRegistry.instance;
+ * const metadata = blockTextureRegistry.getBlockTextureMetadata('blocks/stone.png');
+ * ```
+ *
+ * @public
+ */
+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;
+
+
+    /**
+     * Checks if a block texture is registered in the atlas.
+     *
+     * @param textureUri - The URI of the texture (e.g., 'blocks/stone.png' or 'blocks/grass' for cubemaps).
+     * @returns Whether the texture is registered.
+     */
+    hasBlockTexture(textureUri: string): boolean;
+    /**
+     * Retrieves metadata for a block texture. Returns array for cubemaps (6 faces) or standard textures (1 face).
+     *
+     * @param textureUri - The URI of the texture (e.g., 'blocks/stone.png' or 'blocks/grass').
+     * @returns Array of texture metadata, or undefined if not found.
+     */
+    getBlockTextureMetadata(textureUri: string): BlockTextureMetadata[] | undefined;
+
+
+
+
+
+
+
+
 }
 
 /**
@@ -2221,7 +2281,7 @@ export declare class ErrorHandler {
  *
  * @public
  */
-export declare interface EventPayloads extends AudioEventPayloads, BaseEntityControllerEventPayloads, BlockTypeEventPayloads, BlockTypeRegistryEventPayloads, ChatEventPayloads, ChunkLatticeEventPayloads, ConnectionEventPayloads, EntityEventPayloads, GameServerEventPayloads, ParticleEmitterEventPayloads, PlayerCameraEventPayloads, PlayerEventPayloads, PlayerManagerEventPayloads, PlayerUIEventPayloads, SceneUIEventPayloads, SimulationEventPayloads, SocketEventPayloads, LightEventPayloads, WebServerEventPayloads, WorldEventPayloads, WorldLoopEventPayloads, WorldManagerEventPayloads {
+export declare interface EventPayloads extends AudioEventPayloads, BaseEntityControllerEventPayloads, BlockTypeEventPayloads, BlockTypeRegistryEventPayloads, ChatEventPayloads, ChunkLatticeEventPayloads, ConnectionEventPayloads, EntityEventPayloads, GameServerEventPayloads, ParticleEmitterEventPayloads, PlayerCameraEventPayloads, PlayerEventPayloads, PlayerManagerEventPayloads, PlayerUIEventPayloads, SceneUIEventPayloads, SimulationEventPayloads, LightEventPayloads, WebServerEventPayloads, WorldEventPayloads, WorldLoopEventPayloads, WorldManagerEventPayloads {
 }
 
 /**
@@ -2390,8 +2450,11 @@ export declare class GameServer {
 
 
 
+
     /** The singleton instance of the game server. */
     static get instance(): GameServer;
+    /** The block texture registry for the game server. */
+    get blockTextureRegistry(): BlockTextureRegistry;
     /** The model manager for the game server. */
     get modelRegistry(): ModelRegistry;
     /** The player manager for the game server. */
@@ -5037,16 +5100,6 @@ export declare interface PlayerUIEventPayloads {
     };
 }
 
-/**
- * The port the server will run on. You can override
- * this in your .env by setting PORT. When deployed in
- * production to HYTOPIA servers, any .env value will
- * be ignored and 8080 will be used.
- *
- * @public
- */
-export declare const PORT: string | 8080;
-
 /**
  * Represents a quaternion.
  *