@minecraft/server 2.1.0-beta.1.21.90-preview.21 → 2.1.0-beta.1.21.90-preview.23

package/index.d.ts

@@ -227,6 +227,51 @@ export enum CompoundBlockVolumePositionRelativity {
     Absolute = 1,
 }
 
+/**
+ * @beta
+ * Reasons that the {@link
+ * @minecraft/server.ContainerRulesError} was thrown.
+ */
+export enum ContainerRulesErrorReason {
+    /**
+     * @remarks
+     * Thrown when trying to add item that was defined in {@link
+     * ContainerRules.bannedItems}.
+     *
+     */
+    BannedItem = 'BannedItem',
+    /**
+     * @remarks
+     * Thrown when trying to add item with `Storage Item` component
+     * to container with {@link
+     * ContainerRules.allowNestedStorageItems} set to false.
+     *
+     */
+    NestedStorageItem = 'NestedStorageItem',
+    /**
+     * @remarks
+     * Thrown when trying to add item not defined in non-empty
+     * {@link ContainerRules.allowedItems}.
+     *
+     */
+    NotAllowedItem = 'NotAllowedItem',
+    /**
+     * @remarks
+     * Thrown when trying to add item that pushed the containers
+     * weight over the {@link ContainerRules.weightLimit}.
+     *
+     */
+    OverWeightLimit = 'OverWeightLimit',
+    /**
+     * @remarks
+     * Thrown when trying to add item with zero weight defined by
+     * the `Storage Weight Modifier` component to container with a
+     * defined {@link ContainerRules.weightLimit}
+     *
+     */
+    ZeroWeightItem = 'ZeroWeightItem',
+}
+
 /**
  * @beta
  * Reason why custom command registration failed.
@@ -281,64 +326,71 @@ export enum CustomCommandErrorReason {
 export enum CustomCommandParamType {
     /**
      * @remarks
-     * Command boolean parameter expecting true or false as input.
+     * Block type parameter provides a {@link BlockType}.
      *
      */
-    Boolean = 0,
+    BlockType = 'BlockType',
     /**
      * @remarks
-     * Command integer parameter.
+     * Boolean parameter.
      *
      */
-    Integer = 1,
+    Boolean = 'Boolean',
     /**
      * @remarks
-     * Command float parameter.
+     * Entity selector parameter provides an {@link Entity}.
      *
      */
-    Float = 2,
+    EntitySelector = 'EntitySelector',
     /**
      * @remarks
-     * Command string parameter.
+     * Entity type parameter provides an {@link EntityType}.
      *
      */
-    String = 3,
+    EntityType = 'EntityType',
     /**
      * @remarks
-     * Command entity selector parameter.
+     * Command enum parameter.
      *
      */
-    EntitySelector = 4,
+    Enum = 'Enum',
     /**
      * @remarks
-     * Command player selector parameter.
+     * Float parameter.
      *
      */
-    PlayerSelector = 5,
+    Float = 'Float',
     /**
      * @remarks
-     * Command location parameter.
+     * Integer parameter.
      *
      */
-    Location = 6,
+    Integer = 'Integer',
     /**
      * @remarks
-     * Command block type parameter expecting a Minecraft block.
+     * Item type parameter provides an {@link ItemType}.
      *
      */
-    BlockType = 7,
+    ItemType = 'ItemType',
     /**
      * @remarks
-     * Command item name parameter.
+     * Location parameter provides a {@link
+     * @minecraft/server.Location}.
      *
      */
-    ItemType = 8,
+    Location = 'Location',
     /**
      * @remarks
-     * Command enum parameter.
+     * Player selector parameter provides a {@link Player}.
+     *
+     */
+    PlayerSelector = 'PlayerSelector',
+    /**
+     * @remarks
+     * String parameter.
      *
      */
-    Enum = 9,
+    String = 'String',
 }
 
 /**
@@ -381,7 +433,6 @@ export enum CustomComponentNameErrorReason {
 }
 
 /**
- * @rc
  * An enumeration for the various difficulty levels of
  * Minecraft.
  */
@@ -2008,6 +2059,10 @@ export enum ItemComponentTypes {
      *
      */
     Food = 'minecraft:food',
+    /**
+     * @beta
+     */
+    Inventory = 'minecraft:inventory',
     /**
      * @beta
      */
@@ -2899,8 +2954,8 @@ export type EntityComponentTypeMap = {
 export type EntityIdentifierType<T> = [T] extends [never]
     ? VanillaEntityIdentifier
     : T extends string
-    ? VanillaEntityIdentifier | T
-    : never;
+      ? VanillaEntityIdentifier | T
+      : never;
 
 export type ItemComponentReturnType<T extends string> = T extends keyof ItemComponentTypeMap
     ? ItemComponentTypeMap[T]
@@ -2913,12 +2968,14 @@ export type ItemComponentTypeMap = {
     dyeable: ItemDyeableComponent;
     enchantable: ItemEnchantableComponent;
     food: ItemFoodComponent;
+    inventory: ItemInventoryComponent;
     'minecraft:compostable': ItemCompostableComponent;
     'minecraft:cooldown': ItemCooldownComponent;
     'minecraft:durability': ItemDurabilityComponent;
     'minecraft:dyeable': ItemDyeableComponent;
     'minecraft:enchantable': ItemEnchantableComponent;
     'minecraft:food': ItemFoodComponent;
+    'minecraft:inventory': ItemInventoryComponent;
     'minecraft:potion': ItemPotionComponent;
     potion: ItemPotionComponent;
 };
@@ -5550,7 +5607,6 @@ export class Camera {
     setCamera(
         cameraPreset: string,
         setOptions?:
-            | CameraDefaultOptions
             | CameraFixedBoomOptions
             | CameraSetFacingOptions
             | CameraSetLocationOptions
@@ -5558,6 +5614,23 @@ export class Camera {
             | CameraSetRotOptions
             | CameraTargetOptions,
     ): void;
+    /**
+     * @rc
+     * @remarks
+     * Sets the current active camera for the specified player and
+     * resets the position and rotation to the values defined in
+     * the JSON.
+     *
+     * This function can't be called in read-only mode.
+     *
+     * @param cameraPreset
+     * Identifier of a camera preset file defined within JSON.
+     * @param easeOptions
+     * Options to ease the camera back to its original position and
+     * rotation.
+     * @throws This function can throw errors.
+     */
+    setDefaultCamera(cameraPreset: string, easeOptions?: CameraEaseOptions): void;
 }
 
 /**
@@ -6104,6 +6177,10 @@ export class CompoundBlockVolume {
  */
 export class Container {
     private constructor();
+    /**
+     * @beta
+     */
+    readonly containerRules?: ContainerRules;
     /**
      * @remarks
      * Count of the slots in the container that are empty.
@@ -6132,6 +6209,16 @@ export class Container {
      * Throws if the container is invalid.
      */
     readonly size: number;
+    /**
+     * @beta
+     * @remarks
+     * The combined weight of all items in the container.
+     *
+     * @throws This property can throw when used.
+     *
+     * {@link InvalidContainerError}
+     */
+    readonly weight: number;
     /**
      * @remarks
      * Adds an item to the container. The item is placed in the
@@ -6143,7 +6230,13 @@ export class Container {
      *
      * @param itemStack
      * The stack of items to add.
-     * @throws This function can throw errors.
+     * @throws
+     * Won't throw {@link ContainerRules} error for over weight
+     * limit but will instead add items up to the weight limit.
+     *
+     * {@link ContainerRulesError}
+     *
+     * {@link Error}
      */
     addItem(itemStack: ItemStack): ItemStack | undefined;
     /**
@@ -6281,6 +6374,10 @@ export class Container {
      * @throws
      * Throws if either this container or `toContainer` are invalid
      * or if the `fromSlot` or `toSlot` indices out of bounds.
+     *
+     * {@link ContainerRulesError}
+     *
+     * {@link Error}
      * @example moveBetweenContainers.ts
      * ```typescript
      * import { world, EntityInventoryComponent, EntityComponentTypes, DimensionLocation } from "@minecraft/server";
@@ -6325,6 +6422,10 @@ export class Container {
      * @throws
      * Throws if the container is invalid or if the `slot` index is
      * out of bounds.
+     *
+     * {@link ContainerRulesError}
+     *
+     * {@link Error}
      */
     setItem(slot: number, itemStack?: ItemStack): void;
     /**
@@ -6343,6 +6444,10 @@ export class Container {
      * @throws
      * Throws if either this container or `otherContainer` are
      * invalid or if the `slot` or `otherSlot` are out of bounds.
+     *
+     * {@link ContainerRulesError}
+     *
+     * {@link Error}
      */
     swapItems(slot: number, otherSlot: number, otherContainer: Container): void;
     /**
@@ -6364,6 +6469,12 @@ export class Container {
      * @throws
      * Throws if either this container or `toContainer` are invalid
      * or if the `fromSlot` or `toSlot` indices out of bounds.
+     * Won't throw {@link ContainerRules} error for over weight
+     * limit but will instead add items up to the weight limit.
+     *
+     * {@link ContainerRulesError}
+     *
+     * {@link Error}
      * @example transferBetweenContainers.ts
      * ```typescript
      * import { world, EntityInventoryComponent, EntityComponentTypes, DimensionLocation } from "@minecraft/server";
@@ -6744,6 +6855,8 @@ export class ContainerSlot {
      * @throws
      * Throws if the slot's container is invalid.
      *
+     * {@link ContainerRulesError}
+     *
      * {@link InvalidContainerSlotError}
      */
     setItem(itemStack?: ItemStack): void;
@@ -7113,18 +7226,34 @@ export class Dimension {
      */
     getBlock(location: Vector3): Block | undefined;
     /**
-     * @beta
+     * @rc
      * @remarks
+     * Gets the first block found above a given block location
+     * based on the given options (by default will find the first
+     * solid block above).
+     *
      * This function can't be called in read-only mode.
      *
+     * @param location
+     * Location to retrieve the block above from.
+     * @param options
+     * The options to decide if a block is a valid result.
      * @throws This function can throw errors.
      */
     getBlockAbove(location: Vector3, options?: BlockRaycastOptions): Block | undefined;
     /**
-     * @beta
+     * @rc
      * @remarks
+     * Gets the first block found below a given block location
+     * based on the given options (by default will find the first
+     * solid block below).
+     *
      * This function can't be called in read-only mode.
      *
+     * @param location
+     * Location to retrieve the block below from.
+     * @param options
+     * The options to decide if a block is a valid result.
      * @throws This function can throw errors.
      */
     getBlockBelow(location: Vector3, options?: BlockRaycastOptions): Block | undefined;
@@ -7308,7 +7437,6 @@ export class Dimension {
      */
     getWeather(): WeatherType;
     /**
-     * @rc
      * @remarks
      * Places the given feature into the dimension at the specified
      * location.
@@ -7339,7 +7467,6 @@ export class Dimension {
      */
     placeFeature(featureName: string, location: Vector3, shouldThrow?: boolean): boolean;
     /**
-     * @rc
      * @remarks
      * Places the given feature rule into the dimension at the
      * specified location.
@@ -12729,6 +12856,24 @@ export class ItemFoodComponent extends ItemComponent {
     static readonly componentId = 'minecraft:food';
 }
 
+/**
+ * @beta
+ * This component is added to items with the `Storage Item`
+ * component. Can access and modify this items inventory
+ * container.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class ItemInventoryComponent extends ItemComponent {
+    private constructor();
+    /**
+     * @throws This property can throw when used.
+     *
+     * {@link InvalidContainerError}
+     */
+    readonly container: Container;
+    static readonly componentId = 'minecraft:inventory';
+}
+
 /**
  * @beta
  * When present on an item, this item is a potion item.
@@ -12974,6 +13119,16 @@ export class ItemStack {
      *
      */
     readonly typeId: string;
+    /**
+     * @beta
+     * @remarks
+     * The total weight of all items in the stack plus the weight
+     * of all items in the items container which is defined with
+     * the `Storage Item` component. The weight per item can be
+     * modified by the `Storage Weight Modifier` component.
+     *
+     */
+    readonly weight: number;
     /**
      * @remarks
      * Creates a new instance of a stack of items for use in the
@@ -14256,7 +14411,6 @@ export class Player extends Entity {
      */
     addLevels(amount: number): number;
     /**
-     * @rc
      * @remarks
      * For this player, removes all overrides of any Entity
      * Properties on the target Entity. This change is not applied
@@ -14407,7 +14561,6 @@ export class Player extends Entity {
      */
     queueMusic(trackId: string, musicOptions?: MusicOptions): void;
     /**
-     * @rc
      * @remarks
      * For this player, removes the override on an Entity Property.
      * This change is not applied until the next tick and will not
@@ -14537,7 +14690,6 @@ export class Player extends Entity {
      */
     setGameMode(gameMode?: GameMode): void;
     /**
-     * @rc
      * @remarks
      * For this player, overrides an Entity Property on the target
      * Entity to the provided value. This property must be client
@@ -17503,7 +17655,6 @@ export class StructureManager {
         options?: StructurePlaceOptions,
     ): void;
     /**
-     * @rc
      * @remarks
      * Places a partial jigsaw structure in the world. This is
      * useful for debugging connections between jigsaw blocks.
@@ -17547,7 +17698,6 @@ export class StructureManager {
         options?: JigsawPlaceOptions,
     ): BlockBoundingBox;
     /**
-     * @rc
      * @remarks
      * Places a jigsaw structure in the world.
      *
@@ -18396,7 +18546,6 @@ export class World {
      */
     getDefaultSpawnLocation(): Vector3;
     /**
-     * @rc
      * @remarks
      * Gets the difficulty from the world.
      *
@@ -18648,7 +18797,6 @@ export class World {
      */
     setDefaultSpawnLocation(spawnLocation: Vector3): void;
     /**
-     * @rc
      * @remarks
      * Sets the worlds difficulty.
      *
@@ -19366,7 +19514,6 @@ export interface BiomeSearchOptions {
 }
 
 /**
- * @rc
  * A BlockBoundingBox is an interface to an object which
  * represents an AABB aligned rectangle.
  * The BlockBoundingBox assumes that it was created in a valid
@@ -19637,15 +19784,6 @@ export interface BlockRaycastOptions extends BlockFilter {
     maxDistance?: number;
 }
 
-export interface CameraDefaultOptions {
-    /**
-     * @remarks
-     * Sets a set of easing options for the camera.
-     *
-     */
-    easeOptions: CameraEaseOptions;
-}
-
 /**
  * Contains options associated with a camera ease operation.
  */
@@ -19801,6 +19939,42 @@ export interface CompoundBlockVolumeItem {
     volume: BlockVolume;
 }
 
+/**
+ * @beta
+ * Rules that if broken on container operations will throw an
+ * error.
+ */
+export interface ContainerRules {
+    /**
+     * @remarks
+     * Defines the items that are exclusively allowed in the
+     * container. If empty all items are allowed in the container.
+     *
+     */
+    allowedItems: string[];
+    /**
+     * @remarks
+     * Determines whether other storage items can be placed into
+     * the container.
+     *
+     */
+    allowNestedStorageItems: boolean;
+    /**
+     * @remarks
+     * Defines the items that are not allowed in the container.
+     *
+     */
+    bannedItems: string[];
+    /**
+     * @remarks
+     * Defines the maximum allowed total weight of all items in the
+     * storage item container. If undefined container has no weight
+     * limit.
+     *
+     */
+    weightLimit?: number;
+}
+
 /**
  * @beta
  * Define the custom command, including name, permissions, and
@@ -20806,7 +20980,6 @@ export interface ItemCustomComponent {
 }
 
 /**
- * @rc
  * Provides additional options for {@link
  * StructureManager.placeJigsaw}.
  */
@@ -20836,7 +21009,6 @@ export interface JigsawPlaceOptions {
 }
 
 /**
- * @rc
  * Provides additional options for {@link
  * StructureManager.placeJigsawStructure}.
  */
@@ -20962,7 +21134,7 @@ export interface PlayAnimationOptions {
      * A list of players the animation will be visible to.
      *
      */
-    players?: string[];
+    players?: Player[];
     /**
      * @remarks
      * Specifies a Molang expression for when this animation should
@@ -21670,6 +21842,24 @@ export class CommandError extends Error {
     private constructor();
 }
 
+/**
+ * Error thrown if {@link ContainerRules} are broken on
+ * container operations.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class ContainerRulesError extends Error {
+    private constructor();
+    /**
+     * @beta
+     * @remarks
+     * The specific reason the error was thrown.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    reason: ContainerRulesErrorReason;
+}
+
 /**
  * @beta
  * Error object thrown when CustomCommandRegistry errors occur.
@@ -21845,9 +22035,6 @@ export class NamespaceNameError extends Error {
     reason: NamespaceNameErrorReason;
 }
 
-/**
- * @rc
- */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class PlaceJigsawError extends Error {
     private constructor();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "2.1.0-beta.1.21.90-preview.21",
+  "version": "2.1.0-beta.1.21.90-preview.23",
   "description": "",
   "contributors": [
     {