Class ItemStackBeta

constructor

• new ItemStack(itemType, amount?): ItemStack

• Parameters

  • itemType: string | ItemType

    Type of item to create. See the @minecraft/vanilla-data.MinecraftItemTypes enumeration for a list of standard item types in Minecraft experiences.

  • Optional amount: number

    Number of items to place in the stack, between 1-255. The provided value will be clamped to the item's maximum stack size. Note that certain items can only have one item in the stack.

  Returns ItemStack

  Remarks

  Creates a new instance of a stack of items for use in the world.

  Throws

  Throws if itemType is invalid, or if amount is outside the range of 1-255.

Readonly isStackable

Readonly maxAmount

Readonly type

Readonly typeId

getComponent

• getComponent(componentId): undefined | ItemComponent

• Parameters

  • componentId: string

    The identifier of the component (e.g., 'minecraft:food') to retrieve. If no namespace prefix is specified, 'minecraft:' is assumed. If the component is not present on the item stack, undefined is returned.

  Returns undefined | ItemComponent

  Remarks

  Gets a component (that represents additional capabilities) for an item stack.

  Example

  durability.ts

  // Get the maximum durability of a custom sword item
  const itemStack = new ItemStack("custom:sword");
  const durability = itemStack.getComponent("minecraft:durability") as ItemDurabilityComponent;
  const maxDurability = durability.maxDurability;
  Copy

getComponents

• getComponents(): ItemComponent[]

• Returns ItemComponent[]

  Remarks

  Returns all components that are both present on this item stack and supported by the API.

getLore

• getLore(): string[]
• Beta

  Returns string[]

  An array of lore strings. If the item does not have lore, returns an empty array.

  Remarks

  Returns the lore value - a secondary display string - for an ItemStack.

hasComponent

• hasComponent(componentId): boolean

• Parameters

  • componentId: string

    The identifier of the component (e.g., 'minecraft:food') to retrieve. If no namespace prefix is specified, 'minecraft:' is assumed.

  Returns boolean

  Remarks

  Returns true if the specified component is present on this item stack.

isStackableWith

• isStackableWith(itemStack): boolean

• Parameters

  • itemStack: ItemStack

  Returns boolean

  Remarks

  Returns whether this item stack can be stacked with the given itemStack. This is determined by comparing the item type and any custom data and properties associated with the item stacks. The amount of each item stack is not taken into consideration.

setLore

• setLore(loreList?): void
• Beta

  Parameters

  • Optional loreList: string[]

  Returns void

  Remarks

  Sets the lore value - a secondary display string - for an ItemStack.

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

  Throws

  This function can throw errors.

  Example

  diamondAwesomeSword.ts

    const diamondAwesomeSword = new mc.ItemStack(mc.MinecraftItemTypes.diamondSword, 1);
    let players = mc.world.getAllPlayers();
  
    diamondAwesomeSword.setLore(["§c§lDiamond Sword of Awesome§r", "+10 coolness", "§p+4 shiny§r"]);
  
    // hover over/select the item in your inventory to see the lore.
    const inventory = players[0].getComponent("inventory") as mc.EntityInventoryComponent;
    inventory.container.setItem(0, diamondAwesomeSword);
  
    let item = inventory.container.getItem(0);
  
    if (item) {
      let enchants = item.getComponent("minecraft:enchantments") as mc.ItemEnchantsComponent;
      let knockbackEnchant = new mc.Enchantment("knockback", 3);
      enchants.enchantments.addEnchantment(knockbackEnchant);
    }
  Copy

  Example

  multilineLore.ts

  // Set the lore of an item to multiple lines of text
  const itemStack = new ItemStack("minecraft:diamond_sword");
  itemStack.setLore(["Line 1", "Line 2", "Line 3"]);
  Copy