Class ContainerBeta

Represents a container that can hold sets of items. Used with entities such as Players, Chest Minecarts, Llamas, and more.

Example: containers.ts

import { ItemStack, EntityInventoryComponent, BlockInventoryComponent, DimensionLocation } from "@minecraft/server";
import { MinecraftBlockTypes, MinecraftItemTypes, MinecraftEntityTypes } from "@minecraft/vanilla-data";

function containers(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  const xLocation = targetLocation; // left chest location
  const xPlusTwoLocation = { x: targetLocation.x + 2, y: targetLocation.y, z: targetLocation.z }; // right chest

  const chestCart = targetLocation.dimension.spawnEntity(MinecraftEntityTypes.ChestMinecart, {
    x: targetLocation.x + 4,
    y: targetLocation.y,
    z: targetLocation.z,
  });

  const xChestBlock = targetLocation.dimension.getBlock(xLocation);
  const xPlusTwoChestBlock = targetLocation.dimension.getBlock(xPlusTwoLocation);

  if (!xChestBlock || !xPlusTwoChestBlock) {
    log("Could not retrieve chest blocks.");
    return;
  }

  xChestBlock.setType(MinecraftBlockTypes.Chest);
  xPlusTwoChestBlock.setType(MinecraftBlockTypes.Chest);

  const xPlusTwoChestInventoryComp = xPlusTwoChestBlock.getComponent("inventory") as BlockInventoryComponent;
  const xChestInventoryComponent = xChestBlock.getComponent("inventory") as BlockInventoryComponent;
  const chestCartInventoryComp = chestCart.getComponent("inventory") as EntityInventoryComponent;

  const xPlusTwoChestContainer = xPlusTwoChestInventoryComp.container;
  const xChestContainer = xChestInventoryComponent.container;
  const chestCartContainer = chestCartInventoryComp.container;

  if (!xPlusTwoChestContainer || !xChestContainer || !chestCartContainer) {
    log("Could not retrieve chest containers.");
    return;
  }

  xPlusTwoChestContainer.setItem(0, new ItemStack(MinecraftItemTypes.Apple, 10));
  if (xPlusTwoChestContainer.getItem(0)?.typeId !== MinecraftItemTypes.Apple) {
    log("Expected apple in x+2 container slot index 0", -1);
  }

  xPlusTwoChestContainer.setItem(1, new ItemStack(MinecraftItemTypes.Emerald, 10));
  if (xPlusTwoChestContainer.getItem(1)?.typeId !== MinecraftItemTypes.Emerald) {
    log("Expected emerald in x+2 container slot index 1", -1);
  }

  if (xPlusTwoChestContainer.size !== 27) {
    log("Unexpected size: " + xPlusTwoChestContainer.size, -1);
  }

  if (xPlusTwoChestContainer.emptySlotsCount !== 25) {
    log("Unexpected emptySlotsCount: " + xPlusTwoChestContainer.emptySlotsCount, -1);
  }

  xChestContainer.setItem(0, new ItemStack(MinecraftItemTypes.Cake, 10));

  xPlusTwoChestContainer.transferItem(0, chestCartContainer); // transfer the apple from the xPlusTwo chest to a chest cart
  xPlusTwoChestContainer.swapItems(1, 0, xChestContainer); // swap the cake from x and the emerald from xPlusTwo

  if (chestCartContainer.getItem(0)?.typeId !== MinecraftItemTypes.Apple) {
    log("Expected apple in minecraft chest container slot index 0", -1);
  }

  if (xChestContainer.getItem(0)?.typeId === MinecraftItemTypes.Emerald) {
    log("Expected emerald in x container slot index 0", -1);
  }

  if (xPlusTwoChestContainer.getItem(1)?.typeId === MinecraftItemTypes.Cake) {
    log("Expected cake in x+2 container slot index 1", -1);
  }
}

Constructors

constructor

Properties

emptySlotsCount isValid size

Methods

addItem clearAll getItem getSlot moveItem setItem swapItems transferItem

Constructors

Privateconstructor

Properties

Readonly BetaemptySlotsCount

emptySlotsCount: number

Remarks

Count of the slots in the container that are empty.

Throws

Throws if the container is invalid.

Readonly BetaisValid

isValid: boolean

Remarks

Returns whether a container object (or the entity or block that this container is associated with) is still available for use in this context.

Readonly Betasize

size: number

Remarks

The number of slots in this container. For example, a standard single-block chest has a size of 27. Note, a player's inventory container contains a total of 36 slots, 9 hotbar slots plus 27 inventory slots.

Throws

Throws if the container is invalid.

Methods

addItem

clearAll

getItem

  • getItem(slot: number): ItemStack
    Beta

    Parameters

    • slot: number

      Zero-based index of the slot to retrieve items from.

    Returns ItemStack

    Remarks

    Gets an ItemStack of the item at the specified slot. If the slot is empty, returns undefined. This method does not change or clear the contents of the specified slot. To get a reference to a particular slot, see Container.getSlot.

    Throws

    Throws if the container is invalid or if the slot index is out of bounds.

    Example: getFirstHotbarItem.ts

    import { world, EntityInventoryComponent, DimensionLocation } from "@minecraft/server";

    function getFirstHotbarItem(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
      for (const player of world.getAllPlayers()) {
        const inventory = player.getComponent(EntityInventoryComponent.componentId) as EntityInventoryComponent;
        if (inventory && inventory.container) {
          const firstItem = inventory.container.getItem(0);

          if (firstItem) {
            log("First item in hotbar is: " + firstItem.typeId);
          }

          return inventory.container.getItem(0);
        }
        return undefined;
      }
    }

getSlot

moveItem

  • moveItem(fromSlot: number, toSlot: number, toContainer: Container): void
    Beta

    Parameters

    • fromSlot: number

      Zero-based index of the slot to transfer an item from, on this container.

    • toSlot: number

      Zero-based index of the slot to transfer an item to, on toContainer.

    • toContainer: Container

      Target container to transfer to. Note this can be the same container as the source.

    Returns void

    Remarks

    Moves an item from one slot to another, potentially across containers.

    This function can't be called in read-only mode.

    Throws

    Throws if either this container or toContainer are invalid or if the fromSlot or toSlot indices out of bounds.

    Example: moveBetweenContainers.ts

    import { world, EntityInventoryComponent, EntityComponentTypes, DimensionLocation } from "@minecraft/server";
    import { MinecraftEntityTypes } from "@minecraft/vanilla-data";

    function moveBetweenContainers(
        targetLocation: DimensionLocation
    ) {
      const players = world.getAllPlayers();

      const chestCart = targetLocation.dimension.spawnEntity(MinecraftEntityTypes.ChestMinecart, {
        x: targetLocation.x + 1,
        y: targetLocation.y,
        z: targetLocation.z,
      });

      if (players.length > 0) {
        const fromPlayer = players[0];

        const fromInventory = fromPlayer.getComponent(EntityComponentTypes.Inventory) as EntityInventoryComponent;
        const toInventory = chestCart.getComponent(EntityComponentTypes.Inventory) as EntityInventoryComponent;

        if (fromInventory && toInventory && fromInventory.container && toInventory.container) {
          fromInventory.container.moveItem(0, 0, toInventory.container);
        }
      }
    }

setItem

swapItems

transferItem

  • transferItem(fromSlot: number, toContainer: Container): ItemStack
    Beta

    Parameters

    • fromSlot: number

      Zero-based index of the slot to transfer an item from, on this container.

    • toContainer: Container

      Target container to transfer to. Note this can be the same container as the source.

    Returns ItemStack

    An itemStack with the items that couldn't be transferred. Returns undefined if all items were transferred.

    Remarks

    Moves an item from one slot to another container, or to the first available slot in the same container.

    This function can't be called in read-only mode.

    Throws

    Throws if either this container or toContainer are invalid or if the fromSlot or toSlot indices out of bounds.

    Example: transferBetweenContainers.ts

    import { world, EntityInventoryComponent, EntityComponentTypes, DimensionLocation } from "@minecraft/server";
    import { MinecraftEntityTypes } from "@minecraft/vanilla-data";

    function transferBetweenContainers(
        targetLocation: DimensionLocation
    ) {
      const players = world.getAllPlayers();

      const chestCart = targetLocation.dimension.spawnEntity(MinecraftEntityTypes.ChestMinecart, {
        x: targetLocation.x + 1,
        y: targetLocation.y,
        z: targetLocation.z,
      });

      if (players.length > 0) {
        const fromPlayer = players[0];

        const fromInventory = fromPlayer.getComponent(EntityComponentTypes.Inventory) as EntityInventoryComponent;
        const toInventory = chestCart.getComponent(EntityComponentTypes.Inventory) as EntityInventoryComponent;

        if (fromInventory && toInventory && fromInventory.container && toInventory.container) {
          fromInventory.container.transferItem(0, toInventory.container);
        }
      }
    }

Settings

Member Visibility

On This Page

Constructors
Properties
Methods