Class ItemStack

constructor

• new ItemStack(itemType: string | ItemType, amount?: number): 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.
  • Optionalamount: 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.

amount

ReadonlyisStackable

keepOnDeath

lockMode

ReadonlymaxAmount

OptionalnameTag

Readonlytype

ReadonlytypeId

clearDynamicProperties

• clearDynamicProperties(): void
  Beta

  Returns void

  Remarks

  Clears all dynamic properties that have been set on this item stack.

clone

• clone(): ItemStack

  Returns ItemStack

  Returns a copy of this item stack.

  Remarks

  Creates an exact copy of the item stack, including any custom data or properties.

getCanDestroy

• getCanDestroy(): string[]

  Returns string[]

  Remarks

  Get the list of block types this item can break in Adventure mode.

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

getCanPlaceOn

• getCanPlaceOn(): string[]

  Returns string[]

  Remarks

  Get the list of block types this item can be placed on in Adventure mode.

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

getComponent

• getComponent<T extends keyof ItemComponentTypeMap>(
      componentId: T,
  ): ItemComponentTypeMap[T]

  Type Parameters

  • T extends keyof ItemComponentTypeMap

  Parameters

  • componentId: T

    The identifier of the component (e.g., 'minecraft:food'). If no namespace prefix is specified, 'minecraft:' is assumed. Available component IDs can be found as part of the ItemComponentTypes enum.

  Returns ItemComponentTypeMap[T]

  Returns the component if it exists on the item stack, otherwise undefined.

  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(ItemComponentTypes.Durability);
  const maxDurability = durability.maxDurability;
  Copy

  Example: maxDurability.js

  let durabilityComp = item.getComponent("durability");
  durabilityComp.damage;
  durabilityComp.maxDurability;
  Copy

getComponents

• getComponents(): ItemComponent[]

  Returns ItemComponent[]

  Remarks

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

getDynamicProperty

• getDynamicProperty(identifier: string): string | number | boolean | Vector3
  Beta

  Parameters

  • identifier: string

    The property identifier.

  Returns string | number | boolean | Vector3

  Returns the value for the property, or undefined if the property has not been set.

  Remarks

  Returns a property value.

getDynamicPropertyIds

• getDynamicPropertyIds(): string[]
  Beta

  Returns string[]

  A string array of the dynamic properties set on this entity.

  Remarks

  Returns the available set of dynamic property identifiers that have been used on this entity.

getDynamicPropertyTotalByteCount

• getDynamicPropertyTotalByteCount(): number
  Beta

  Returns number

  Remarks

  Returns the total size, in bytes, of all the dynamic properties that are currently stored for this entity. This includes the size of both the key and the value. This can be useful for diagnosing performance warning signs - if, for example, an entity has many megabytes of associated dynamic properties, it may be slow to load on various devices.

getLore

• getLore(): string[]

  Returns string[]

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

  Remarks

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

getTags

• getTags(): string[]

  Returns string[]

  Remarks

  Returns a set of tags associated with this item stack.

hasComponent

• hasComponent(componentId: string): 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.

hasTag

• hasTag(tag: string): boolean

  Parameters

  • tag: string

    Tag to search for.

  Returns boolean

  True if the Item Stack has the tag associated with it, else false.

  Remarks

  Checks whether this item stack has a particular tag associated with it.

isStackableWith

• isStackableWith(itemStack: ItemStack): boolean

  Parameters

  • itemStack: ItemStack

    ItemStack to check stacking compatability with.

  Returns boolean

  True if the Item Stack is stackable with the itemStack passed in.

  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.

setCanDestroy

• setCanDestroy(blockIdentifiers?: string[]): void

  Parameters

  • OptionalblockIdentifiers: string[]

    String list of block types that the item can destroy.

  Returns void

  Remarks

  The list of block types this item can break in Adventure mode. The block names are displayed in the item's tooltip. Setting the value to undefined will clear the list.

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

  Throws

  Throws if any of the provided block identifiers are invalid.

  Example: example.ts

  // Creates a diamond pickaxe that can destroy cobblestone and obsidian
  const specialPickaxe = new ItemStack("minecraft:diamond_pickaxe");
  specialPickaxe.setCanDestroy(["minecraft:cobblestone", "minecraft:obsidian"]);
  Copy

setCanPlaceOn

• setCanPlaceOn(blockIdentifiers?: string[]): void

  Parameters

  • OptionalblockIdentifiers: string[]

    String list of block types that the item can be placed on.

  Returns void

  Remarks

  The list of block types this item can be placed on in Adventure mode. This is only applicable to block items. The block names are displayed in the item's tooltip. Setting the value to undefined will clear the list.

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

  Throws

  Throws if any of the provided block identifiers are invalid.

  Example: example.ts

  // Creates a gold block that can be placed on grass and dirt
  const specialGoldBlock = new ItemStack("minecraft:gold_block");
  specialPickaxe.setCanPlaceOn(["minecraft:grass", "minecraft:dirt"]);
  Copy

setDynamicProperty

• setDynamicProperty(
      identifier: string,
      value?: string | number | boolean | Vector3,
  ): void
  Beta

  Parameters

  • identifier: string

    The property identifier.
  • Optionalvalue: string | number | boolean | Vector3

    Data value of the property to set.

  Returns void

  Remarks

  Sets a specified property to a value. Note: This function only works with non-stackable items.

  Throws

  Throws if the item stack is stackable.

setLore

• setLore(loreList?: string[]): void

  Parameters

  • OptionalloreList: string[]

    List of lore lines. Each element in the list represents a new line. The maximum lore line count is 20. The maximum lore line length is 50 characters.

  Returns void

  Remarks

  Sets the lore value - a secondary display string - for an ItemStack. The lore list is cleared if set to an empty string or undefined.

  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

triggerEvent

• triggerEvent(eventName: string): void
  Beta

  Parameters

  • eventName: string

    Name of the item type event to trigger. If a namespace is not specified, minecraft: is assumed.

  Returns void

  Remarks

  Triggers an item type event. For custom items, a number of events are defined in an items' definition for key item behaviors.

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