Class Container

ReadonlyemptySlotsCount

Readonlysize

addItem

• addItem(itemStack: ItemStack): ItemStack

• Parameters

  • itemStack: ItemStack

    The stack of items to add.

  Returns ItemStack

  Remarks

  Adds an item to the container. The item is placed in the first available slot(s) and can be stacked with existing items of the same type. Note, use Container.setItem if you wish to set the item in a particular slot.

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

  Throws

  This function can throw errors.

  Example: addDiamondSword.ts

  import { EntityInventoryComponent, ItemStack, world } from "@minecraft/server";
  for (const player of world.getAllPlayers()) {
      const inventory = player.getComponent(
          "inventory"
      ) as EntityInventoryComponent;
      const item = new ItemStack("minecraft:diamond_sword", 10);
      inventory.container.addItem(item);
  }
  Copy

clearAll

• clearAll(): void

• Returns void

  Remarks

  Clears all inventory items in the container.

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

  Throws

  Throws if the container is invalid.

getItem

• getItem(slot: number): ItemStack

• 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;
    }
  }
  Copy

getSlot

• getSlot(slot: number): ContainerSlot

• Parameters

  • slot: number

    The index of the slot to return. This index must be within the bounds of the container.

  Returns ContainerSlot

  Remarks

  Returns a container slot. This acts as a reference to a slot at the given index for this container.

  Throws

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

isValid

• isValid(): boolean

• Returns 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.

moveItem

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

• 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);
      }
    }
  }
  Copy

setItem

• setItem(slot: number, itemStack?: ItemStack): void

• Parameters

  • slot: number

    Zero-based index of the slot to set an item at.
  • OptionalitemStack: ItemStack

    Stack of items to place within the specified slot. Setting itemStack to undefined will clear the slot.

  Returns void

  Remarks

  Sets an item stack within a particular slot.

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

  Throws

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

  Example: setMainhand.ts

  import { EntityInventoryComponent, ItemStack, world } from "@minecraft/server";
  for (const player of world.getAllPlayers()) {
      const inventory = player.getComponent(
          "inventory"
      ) as EntityInventoryComponent;
      const item = new ItemStack("minecraft:diamond_sword", 10);
      inventory.container.setItem(0, item);
  }
  Copy

swapItems

• swapItems(slot: number, otherSlot: number, otherContainer: Container): void

• Parameters

  • slot: number

    Zero-based index of the slot to swap from this container.
  • otherSlot: number

    Zero-based index of the slot to swap with.
  • otherContainer: Container

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

  Returns void

  Remarks

  Swaps items between two different slots within containers.

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

  Throws

  Throws if either this container or otherContainer are invalid or if the slot or otherSlot are out of bounds.

transferItem

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

• 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);
      }
    }
  }
  Copy