@minecraft/server 2.3.0-beta.1.21.110-preview.20 → 2.3.0-beta.1.21.110-preview.23

package/README.md

@@ -1,9 +1,9 @@
-# `@minecraft/server`
-
-Contains many types related to manipulating a Minecraft world, including entities, blocks, dimensions, and more.
-
-## **NOTE: This version of this module is still in pre-release.  It may change or it may be removed in future releases.**
-
-See full documentation for this module here:
-
+# `@minecraft/server`
+
+Contains many types related to manipulating a Minecraft world, including entities, blocks, dimensions, and more.
+
+## **NOTE: This version of this module is still in pre-release.  It may change or it may be removed in future releases.**
+
+See full documentation for this module here:
+
 https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/minecraft-server

package/index.d.ts

@@ -171,7 +171,6 @@ export enum ButtonState {
 }
 
 /**
- * @rc
  * The required permission level to execute the custom command.
  */
 export enum CommandPermissionLevel {
@@ -302,7 +301,6 @@ export enum ContainerRulesErrorReason {
 }
 
 /**
- * @rc
  * Reason why custom command registration failed.
  */
 export enum CustomCommandErrorReason {
@@ -346,10 +344,16 @@ export enum CustomCommandErrorReason {
      *
      */
     RegistryReadOnly = 'RegistryReadOnly',
+    /**
+     * @beta
+     * @remarks
+     * Non enum type command parameters cannot use enumName.
+     *
+     */
+    UnexpectedEnumName = 'UnexpectedEnumName',
 }
 
 /**
- * @rc
  * The types of paramaters accepted by a custom command.
  */
 export enum CustomCommandParamType {
@@ -423,7 +427,6 @@ export enum CustomCommandParamType {
 }
 
 /**
- * @rc
  * Who executed the command.
  */
 export enum CustomCommandSource {
@@ -448,9 +451,6 @@ export enum CustomCommandSource {
     Server = 'Server',
 }
 
-/**
- * @rc
- */
 export enum CustomCommandStatus {
     Success = 0,
     Failure = 1,
@@ -1079,7 +1079,6 @@ export enum EntityComponentTypes {
      */
     OnFire = 'minecraft:onfire',
     /**
-     * @rc
      * @remarks
      * Use this component to read the exhaustion of a player. This
      * is only available on players.
@@ -1087,7 +1086,6 @@ export enum EntityComponentTypes {
      */
     Exhaustion = 'minecraft:player.exhaustion',
     /**
-     * @rc
      * @remarks
      * Use this component to read the hunger of a player. This is
      * only available on players.
@@ -1095,7 +1093,6 @@ export enum EntityComponentTypes {
      */
     Hunger = 'minecraft:player.hunger',
     /**
-     * @rc
      * @remarks
      * Use this component to read the saturation of a player. This
      * is only available on players.
@@ -2455,7 +2452,6 @@ export enum PlatformType {
 }
 
 /**
- * @rc
  * Specifies the player inventory type.
  */
 export enum PlayerInventoryType {
@@ -2474,7 +2470,6 @@ export enum PlayerInventoryType {
 }
 
 /**
- * @rc
  * The player permission level.
  */
 export enum PlayerPermissionLevel {
@@ -3577,7 +3572,6 @@ export class Block {
      */
     readonly isWaterlogged: boolean;
     /**
-     * @rc
      * @remarks
      * Key for the localization of this block's name used in .lang
      * files.
@@ -3814,6 +3808,23 @@ export class Block {
      * {@link LocationOutOfWorldBoundariesError}
      */
     getItemStack(amount?: number, withData?: boolean): ItemStack | undefined;
+    /**
+     * @beta
+     * @remarks
+     * Returns the total brightness level of light shining on a
+     * certain block.
+     *
+     * This function can't be called in read-only mode.
+     *
+     * @returns
+     * The brightness level on the block.
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftcommon.InvalidArgumentError}
+     *
+     * {@link LocationInUnloadedChunkError}
+     */
+    getLightLevel(): number;
     /**
      * @beta
      * @throws This function can throw errors.
@@ -3837,6 +3848,23 @@ export class Block {
      * {@link LocationOutOfWorldBoundariesError}
      */
     getRedstonePower(): number | undefined;
+    /**
+     * @beta
+     * @remarks
+     * Returns the brightness level of light shining from the sky
+     * on a certain block.
+     *
+     * This function can't be called in read-only mode.
+     *
+     * @returns
+     * The brightness level on the block.
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftcommon.InvalidArgumentError}
+     *
+     * {@link LocationInUnloadedChunkError}
+     */
+    getSkyLightLevel(): number;
     /**
      * @remarks
      * Returns a set of tags for a block.
@@ -6321,7 +6349,6 @@ export class Container {
      */
     clearAll(): void;
     /**
-     * @rc
      * @remarks
      * Attempts to find an item inside the container
      *
@@ -6333,7 +6360,6 @@ export class Container {
      */
     contains(itemStack: ItemStack): boolean;
     /**
-     * @rc
      * @remarks
      * Find the index of the first instance of an item inside the
      * container
@@ -6346,7 +6372,6 @@ export class Container {
      */
     find(itemStack: ItemStack): number | undefined;
     /**
-     * @rc
      * @remarks
      * Find the index of the last instance of an item inside the
      * container
@@ -6359,7 +6384,6 @@ export class Container {
      */
     findLast(itemStack: ItemStack): number | undefined;
     /**
-     * @rc
      * @remarks
      * Finds the index of the first empty slot inside the container
      *
@@ -6369,7 +6393,6 @@ export class Container {
      */
     firstEmptySlot(): number | undefined;
     /**
-     * @rc
      * @remarks
      * Finds the index of the first item inside the container
      *
@@ -6972,7 +6995,6 @@ export class ContainerSlot {
 }
 
 /**
- * @rc
  * Details about the origins of the command.
  */
 export class CustomCommandOrigin {
@@ -7007,7 +7029,6 @@ export class CustomCommandOrigin {
 }
 
 /**
- * @rc
  * Provides the functionality for registering custom commands.
  */
 export class CustomCommandRegistry {
@@ -7150,7 +7171,6 @@ export class Dimension {
      */
     readonly id: string;
     /**
-     * @rc
      * @remarks
      * Key for the localization of a dimension's name used by
      * language files.
@@ -8352,7 +8372,6 @@ export class Entity {
      */
     readonly isValid: boolean;
     /**
-     * @rc
      * @remarks
      * Key for the localization of this entity's name used in .lang
      * files.
@@ -9869,7 +9888,6 @@ export class EntityDieAfterEventSignal {
 export class EntityEquippableComponent extends EntityComponent {
     private constructor();
     /**
-     * @rc
      * @remarks
      * Returns the total Armor level of the owner.
      *
@@ -9879,7 +9897,6 @@ export class EntityEquippableComponent extends EntityComponent {
      */
     readonly totalArmor: number;
     /**
-     * @rc
      * @remarks
      * Returns the total Toughness level of the owner.
      *
@@ -9930,7 +9947,6 @@ export class EntityEquippableComponent extends EntityComponent {
 }
 
 /**
- * @rc
  * Defines the interactions with this entity for Exhaustion.
  * Wraps the `minecraft.player.exhaustion` attribute.
  */
@@ -10228,7 +10244,6 @@ export class EntityHitEntityAfterEventSignal {
 }
 
 /**
- * @rc
  * Defines the interactions with this entity for hunger. Wraps
  * the `minecraft.player.hunger` attribute.
  */
@@ -11596,7 +11611,6 @@ export class EntityRidingComponent extends EntityComponent {
 }
 
 /**
- * @rc
  * Defines the interactions with this entity for Saturation.
  * Wraps the `minecraft.player.saturation` attribute.
  */
@@ -13441,25 +13455,26 @@ export class ItemPotionComponent extends ItemComponent {
     private constructor();
     /**
      * @remarks
-     * The PotionEffectType associated with the potion item.
+     * The PotionDeliveryType associated with the potion item.
      *
      * @throws This property can throw when used.
-     */
-    readonly potionEffectType: PotionEffectType;
-    /**
-     * @remarks
-     * The PotionLiquidType associated with the potion item.
      *
-     * @throws This property can throw when used.
+     * {@link minecraftcommon.EngineError}
+     *
+     * {@link Error}
      */
-    readonly potionLiquidType: PotionLiquidType;
+    readonly potionDeliveryType: PotionDeliveryType;
     /**
      * @remarks
-     * The PotionModifierType associated with the potion item.
+     * The PotionEffectType associated with the potion item.
      *
      * @throws This property can throw when used.
+     *
+     * {@link minecraftcommon.EngineError}
+     *
+     * {@link Error}
      */
-    readonly potionModifierType: PotionModifierType;
+    readonly potionEffectType: PotionEffectType;
     static readonly componentId = 'minecraft:potion';
 }
 
@@ -13624,7 +13639,6 @@ export class ItemStack {
      */
     keepOnDeath: boolean;
     /**
-     * @rc
      * @remarks
      * Key for the localization of this items's name used in .lang
      * files.
@@ -14043,16 +14057,6 @@ export class ItemStack {
      * ```
      */
     setLore(loreList?: (RawMessage | string)[]): void;
-    /**
-     * @beta
-     * @remarks
-     * Helper function for creating potion items.
-     *
-     * This function can't be called in read-only mode.
-     *
-     * @throws This function can throw errors.
-     */
-    static createPotion(options: PotionOptions): ItemStack;
 }
 
 /**
@@ -14979,7 +14983,6 @@ export class Player extends Entity {
      */
     readonly clientSystemInfo: ClientSystemInfo;
     /**
-     * @rc
      * @remarks
      * This property can't be edited in read-only mode.
      *
@@ -15062,7 +15065,6 @@ export class Player extends Entity {
      */
     readonly onScreenDisplay: ScreenDisplay;
     /**
-     * @rc
      * @throws This property can throw when used.
      *
      * {@link InvalidEntityError}
@@ -16009,7 +16011,6 @@ export class PlayerGameModeChangeBeforeEventSignal {
 }
 
 /**
- * @rc
  * Contains information regarding an event after changing the
  * selected hotbar slot for a player.
  */
@@ -16042,7 +16043,6 @@ export class PlayerHotbarSelectedSlotChangeAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected after a player selected
  * hotbar slot is changed.
  */
@@ -16524,7 +16524,6 @@ export class PlayerInteractWithEntityBeforeEventSignal {
 }
 
 /**
- * @rc
  * Contains information regarding an event after a player's
  * inventory item changes.
  */
@@ -16563,7 +16562,6 @@ export class PlayerInventoryItemChangeAfterEvent {
 }
 
 /**
- * @rc
  * Manages callbacks that are connected after a player's
  * inventory item is changed.
  */
@@ -16927,41 +16925,65 @@ export class PlayerSpawnAfterEventSignal {
 
 /**
  * @beta
- * Represents a type of potion effect - like healing or leaping
- * - that can be used with PotionOptions.
- */
-export class PotionEffectType {
-    private constructor();
-    readonly id: string;
-}
-
-/**
- * @beta
- * Represents a type of potion liquid - like splash, or
- * lingering - that can be used with PotionOptions.
+ * Represents how the potion effect is delivered.
  */
-export class PotionLiquidType {
+export class PotionDeliveryType {
     private constructor();
     readonly id: string;
 }
 
 /**
  * @beta
- * Represents a type of potion modifier - like strong, or long
- * - that can be used with PotionOptions.
+ * Represents a type of potion effect - like healing or
+ * leaping.
  */
-export class PotionModifierType {
+export class PotionEffectType {
     private constructor();
+    /**
+     * @remarks
+     * Duration of the effect when applied to an entity in ticks.
+     * Undefined means the effect does not expire.
+     *
+     * @throws This property can throw when used.
+     *
+     * {@link minecraftcommon.EngineError}
+     */
+    readonly durationTicks?: number;
     readonly id: string;
 }
 
 /**
  * @beta
- * Used for accessing all potion effects, liquids, and
- * modifiers currently available for use within the world.
+ * Used for accessing all potion effect types, delivery types,
+ * and creating potions.
  */
 export class Potions {
     private constructor();
+    /**
+     * @remarks
+     * Retrieves handles for all registered potion delivery types.
+     *
+     * @returns
+     * Array of all registered delivery type handles.
+     */
+    static getAllDeliveryTypes(): PotionDeliveryType[];
+    /**
+     * @remarks
+     * Retrieves all type handle for all registered potion effects.
+     *
+     * @returns
+     * Array of all registered effect type handles.
+     */
+    static getAllEffectTypes(): PotionEffectType[];
+    /**
+     * @remarks
+     * Retrieves a type handle for a specified potion delivery id.
+     *
+     * @returns
+     * A type handle wrapping the valid delivery id, or undefined
+     * for an invalid delivery id.
+     */
+    static getDeliveryType(potionDeliveryId: string): PotionDeliveryType | undefined;
     /**
      * @remarks
      * Retrieves a type handle for a specified potion effect id.
@@ -16973,25 +16995,23 @@ export class Potions {
      * A type handle wrapping the valid effect id, or undefined for
      * an invalid effect id.
      */
-    static getPotionEffectType(potionEffectId: string): PotionEffectType | undefined;
+    static getEffectType(potionEffectId: string): PotionEffectType | undefined;
     /**
      * @remarks
-     * Retrieves a type handle for a specified potion liquid id.
+     * Creates a potion given an effect and delivery type.
      *
-     * @returns
-     * A type handle wrapping the valid liquid id, or undefined for
-     * an invalid liquid id.
-     */
-    static getPotionLiquidType(potionLiquidId: string): PotionLiquidType | undefined;
-    /**
-     * @remarks
-     * Retrieves a type handle for a specified potion modifier id.
+     * @throws This function can throw errors.
      *
-     * @returns
-     * A type handle wrapping the valid modifier id, or undefined
-     * for an invalid modifier id.
+     * {@link minecraftcommon.EngineError}
+     *
+     * {@link InvalidPotionDeliveryTypeError}
+     *
+     * {@link InvalidPotionEffectTypeError}
      */
-    static getPotionModifierType(potionModifierId: string): PotionModifierType | undefined;
+    static resolve<
+        T extends string = minecraftvanilladata.MinecraftPotionEffectTypes,
+        U extends string = minecraftvanilladata.MinecraftPotionDeliveryTypes,
+    >(potionEffectType: PotionEffectType | T, potionDeliveryType: PotionDeliveryType | U): ItemStack;
 }
 
 /**
@@ -18049,7 +18069,6 @@ export class StartupEvent {
      */
     readonly blockComponentRegistry: BlockComponentRegistry;
     /**
-     * @rc
      * @remarks
      * This property can be read in early-execution mode.
      *
@@ -19905,7 +19924,6 @@ export class WorldAfterEvents {
      */
     readonly playerGameModeChange: PlayerGameModeChangeAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when a player's selected slot changes.
      *
@@ -19946,7 +19964,6 @@ export class WorldAfterEvents {
      */
     readonly playerInteractWithEntity: PlayerInteractWithEntityAfterEventSignal;
     /**
-     * @rc
      * @remarks
      * This event fires when an item gets added or removed to the
      * player's inventory.
@@ -20692,7 +20709,6 @@ export interface ContainerRules {
 }
 
 /**
- * @rc
  * Define the custom command, including name, permissions, and
  * parameters.
  */
@@ -20737,11 +20753,19 @@ export interface CustomCommand {
 }
 
 /**
- * @rc
  * Definition for each parameter expected by the custom
  * command.
  */
 export interface CustomCommandParameter {
+    /**
+     * @beta
+     * @remarks
+     * Can be used to reference the enum name when {@link
+     * CustomCommandParamType} is 'Enum'. Allows the parameter name
+     * to be different from the enum name.
+     *
+     */
+    enumName?: string;
     /**
      * @remarks
      * The name of parameter as it appears on the command line.
@@ -20757,7 +20781,6 @@ export interface CustomCommandParameter {
 }
 
 /**
- * @rc
  * Interface returned from custom command callback function.
  */
 export interface CustomCommandResult {
@@ -21567,7 +21590,6 @@ export interface GreaterThanOrEqualsComparison {
 }
 
 /**
- * @rc
  * Contains additional filtering options for hotbar events.
  */
 export interface HotbarEventOptions {
@@ -21604,7 +21626,6 @@ export interface InputEventOptions {
 }
 
 /**
- * @rc
  * Contains additional filtering options for inventory item
  * events.
  */
@@ -21938,35 +21959,6 @@ export interface PlayerSoundOptions {
     volume?: number;
 }
 
-/**
- * @beta
- * Options for use in creating potions. See
- * ItemStack.createPotion.
- */
-export interface PotionOptions {
-    /**
-     * @remarks
-     * The type of potion effect to create. See
-     * @minecraft/vanilla-data.MinecraftPotionEffectTypes.
-     *
-     */
-    effect: PotionEffectType | string;
-    /**
-     * @remarks
-     * Optional potion liquid, defaults to 'Regular'. See
-     * @minecraft/vanilla-data.MinecraftPotionLiquidTypes.
-     *
-     */
-    liquid?: PotionLiquidType | string;
-    /**
-     * @remarks
-     * Optional potion modifier, defaults to 'Normal'. See
-     * @minecraft/vanilla-data.MinecraftPotionModifierTypes.
-     *
-     */
-    modifier?: PotionModifierType | string;
-}
-
 /**
  * Optional arguments for
  * @minecraft/server.EntityProjectileComponent.shoot.
@@ -22642,7 +22634,6 @@ export class ContainerRulesError extends Error {
 }
 
 /**
- * @rc
  * Error object thrown when CustomCommandRegistry errors occur.
  */
 // @ts-ignore Class inheritance allowed for native defined classes
@@ -22695,7 +22686,6 @@ export class EntitySpawnError extends Error {
 }
 
 /**
- * @rc
  * The container is invalid. This can occur if the container is
  * missing or deleted.
  */
@@ -22761,6 +22751,22 @@ export class InvalidIteratorError extends Error {
     private constructor();
 }
 
+/**
+ * @beta
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class InvalidPotionDeliveryTypeError extends Error {
+    private constructor();
+}
+
+/**
+ * @beta
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class InvalidPotionEffectTypeError extends Error {
+    private constructor();
+}
+
 /**
  * Thrown when a Structure is invalid. A structure becomes
  * invalid when it is deleted.

package/package.json

@@ -1,20 +1,20 @@
-{
-  "name": "@minecraft/server",
-  "version": "2.3.0-beta.1.21.110-preview.20",
-  "description": "",
-  "contributors": [
-    {
-      "name": "Jake Shirley",
-      "email": "jake@xbox.com"
-    },
-    {
-      "name": "Mike Ammerlaan",
-      "email": "mikeam@microsoft.com"
-    }
-  ],
-  "peerDependencies": {
-    "@minecraft/common": "^1.2.0",
-    "@minecraft/vanilla-data": ">=1.20.70 || 1.21.110-preview.20"
-  },
-  "license": "MIT"
+{
+  "name": "@minecraft/server",
+  "version": "2.3.0-beta.1.21.110-preview.23",
+  "description": "",
+  "contributors": [
+    {
+      "name": "Jake Shirley",
+      "email": "jake@xbox.com"
+    },
+    {
+      "name": "Mike Ammerlaan",
+      "email": "mikeam@microsoft.com"
+    }
+  ],
+  "peerDependencies": {
+    "@minecraft/common": "^1.2.0",
+    "@minecraft/vanilla-data": ">=1.20.70 || 1.21.110-preview.23"
+  },
+  "license": "MIT"
 }