@minecraft/server 2.8.0-beta.1.26.20-preview.23 → 2.8.0-beta.1.26.20-preview.26

package/index.d.ts

@@ -8956,26 +8956,67 @@ export class Dimension {
 }
 
 /**
- * Represents a type of dimension.
+ * @beta
+ * Provides the functionality for registering custom
+ * dimensions. Custom dimensions can only be registered during
+ * the system startup event.
+ */
+export class DimensionRegistry {
+    private constructor();
+    /**
+     * @remarks
+     * Registers a new custom dimension type. Must be called during
+     * the system startup event. The dimension will be created
+     * using the void generator.
+     *
+     * This function can be called in early-execution mode.
+     *
+     * @param typeId
+     * The namespaced identifier for the custom dimension (e.g.,
+     * 'mypack:my_dimension'). Must include a namespace and use
+     * only valid identifier characters.
+     * @throws This function can throw errors.
+     *
+     * {@link CustomDimensionAlreadyRegisteredError}
+     *
+     * {@link CustomDimensionInvalidRegistryError}
+     *
+     * {@link CustomDimensionNameError}
+     *
+     * {@link CustomDimensionReloadNewDimensionError}
+     *
+     * {@link minecraftcommon.EngineError}
+     *
+     * {@link NamespaceNameError}
+     */
+    registerCustomDimension(typeId: string): void;
+}
+
+/**
+ * Represents a type of dimension. Currently only works with
+ * Vanilla dimensions.
  */
 export class DimensionType {
     private constructor();
     /**
      * @remarks
-     * Identifier of the dimension type.
+     * Identifier of the dimension type. Currently only works with
+     * Vanilla dimensions.
      *
      */
     readonly typeId: string;
 }
 
 /**
- * Used for accessing all available dimension types.
+ * Used for accessing all available dimension types. Currently
+ * only works with Vanilla dimensions.
  */
 export class DimensionTypes {
     private constructor();
     /**
      * @remarks
      * Retrieves a dimension type using a string-based identifier.
+     * Currently only works with Vanilla dimensions.
      *
      * This function can be called in early-execution mode.
      *
@@ -8983,7 +9024,8 @@ export class DimensionTypes {
     static get(dimensionTypeId: string): DimensionType | undefined;
     /**
      * @remarks
-     * Retrieves an array of all dimension types.
+     * Retrieves an array of all dimension types. Currently only
+     * works with Vanilla dimensions.
      *
      * This function can be called in early-execution mode.
      *
@@ -21289,6 +21331,13 @@ export class StartupEvent {
      *
      */
     readonly customCommandRegistry: CustomCommandRegistry;
+    /**
+     * @beta
+     * @remarks
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly dimensionRegistry: DimensionRegistry;
     /**
      * @remarks
      * This property can be read in early-execution mode.
@@ -22097,6 +22146,8 @@ export class TextPrimitive extends PrimitiveShape {
      *
      * @throws This function can throw errors.
      *
+     * {@link minecraftcommon.ArgumentOutOfBoundsError}
+     *
      * {@link RawMessageError}
      */
     setText(text: RawMessage | string): void;
@@ -26909,6 +26960,48 @@ export class CustomComponentNameError extends Error {
     readonly reason: CustomComponentNameErrorReason;
 }
 
+/**
+ * @beta
+ * Thrown when trying to register a custom dimension with a
+ * name that has already been registered.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class CustomDimensionAlreadyRegisteredError extends Error {
+    private constructor();
+}
+
+/**
+ * @beta
+ * Thrown when trying to register a custom dimension outside of
+ * the system startup event.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class CustomDimensionInvalidRegistryError extends Error {
+    private constructor();
+}
+
+/**
+ * @beta
+ * Thrown when trying to register a custom dimension with a
+ * name that contains invalid characters.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class CustomDimensionNameError extends Error {
+    private constructor();
+}
+
+/**
+ * @beta
+ * Thrown after using the /reload command when trying to
+ * register a custom dimension that was not previously
+ * registered. New custom dimensions cannot be added during a
+ * reload.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class CustomDimensionReloadNewDimensionError extends Error {
+    private constructor();
+}
+
 // @ts-ignore Class inheritance allowed for native defined classes
 export class EnchantmentLevelOutOfBoundsError extends Error {
     private constructor();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "2.8.0-beta.1.26.20-preview.23",
+  "version": "2.8.0-beta.1.26.20-preview.26",
   "description": "",
   "contributors": [
     {
@@ -14,7 +14,7 @@
   ],
   "peerDependencies": {
     "@minecraft/common": "^1.2.0",
-    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.20-preview.23"
+    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.20-preview.26"
   },
   "license": "MIT"
 }