Class ItemStack

amount

keepOnDeath

lockMode

OptionalnameTag

clearDynamicProperties

• clearDynamicProperties(): void

  Returns void

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

clone

• clone(): ItemStack

  Returns ItemStack

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

getCanDestroy

• getCanDestroy(): string[]

  Returns string[]

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

getCanPlaceOn

• getCanPlaceOn(): string[]

  Returns string[]

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

getComponent

• getComponent<T extends string>(componentId: T): ItemComponentReturnType<T>

  Type Parameters

  • T extends string

  Parameters

  • componentId: T

  Returns ItemComponentReturnType<T>

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

  Example: getItemDurability.js

  import { world } from "@minecraft/server";
  
  const player = world.getPlayers()[0];
  const inventory = player.getComponent("inventory");
  const slot = inventory.container.getSlot(player.selectedSlotIndex);
  let durabilityComp = slot.getItem().getComponent("durability");
  player.sendMessage(
  "Item Durability: " + (durabilityComp.maxDurability - durabilityComp.damage) + "/" + durabilityComp.maxDurability
  );
  Copy

getComponents

• getComponents(): ItemComponent[]

  Returns ItemComponent[]

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

getDynamicProperty

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

  Parameters

  • identifier: string

  Returns string | number | boolean | Vector3

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

getDynamicPropertyIds

• getDynamicPropertyIds(): string[]

  Returns string[]

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

getDynamicPropertyTotalByteCount

• getDynamicPropertyTotalByteCount(): number

  Returns number

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

getLore

• getLore(): string[]

  Returns string[]

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

getRawLore

• getRawLore(): RawMessage[]

  Returns RawMessage[]

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

getTags

• getTags(): string[]

  Returns string[]

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

hasComponent

• hasComponent(componentId: string): boolean

  Parameters

  • componentId: string

  Returns boolean

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

hasTag

• hasTag(tag: string): boolean

  Parameters

  • tag: string

  Returns boolean

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

isStackableWith

• isStackableWith(itemStack: ItemStack): boolean

  Parameters

  • itemStack: ItemStack

  Returns boolean

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

matches

• matches(
      itemName: string,
      states?: Record<string, string | number | boolean>,
  ): boolean

  Parameters

  • itemName: string
  • Optionalstates: Record<string, string | number | boolean>

  Returns boolean

  Remarks

  Write Privilege

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

  World Ready

  This function can't be called in early-execution mode.

  Example: sameIronSword.js

  import { ItemStack, world } from "@minecraft/server";
  
  const item1 = new ItemStack("minecraft:iron_sword", 1);
  item1.matches("minecraft:iron_sword");
  Copy

  Example: sameTrapdoor.js

  import { ItemStack, world } from "@minecraft/server";
  
  const item1 = new ItemStack("minecraft:acacia_trapdoor", 1);
  item1.matches("minecraft:acacia_trapdoor", {
  direction: 0,
  open_bit: true,
  upside_down_bit: false,
  });
  Copy

setCanDestroy

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

  Parameters

  • OptionalblockIdentifiers: string[]

  Returns void

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

setCanPlaceOn

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

  Parameters

  • OptionalblockIdentifiers: string[]

  Returns void

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

setDynamicProperties

• setDynamicProperties(
      values: Record<string, string | number | boolean | Vector3>,
  ): void

  Parameters

  • values: Record<string, string | number | boolean | Vector3>

  Returns void

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  minecraftcommon.ArgumentOutOfBoundsError

  minecraftcommon.UnsupportedFunctionalityError

  World Ready

  This function can't be called in early-execution mode.

setDynamicProperty

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

  Parameters

  • identifier: string
  • Optionalvalue: string | number | boolean | Vector3

  Returns void

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  minecraftcommon.ArgumentOutOfBoundsError

  minecraftcommon.UnsupportedFunctionalityError

  World Ready

  This function can't be called in early-execution mode.

setLore

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

  Parameters

  • OptionalloreList: (string | RawMessage)[]

  Returns void

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  minecraftcommon.ArgumentOutOfBoundsError

  Error

  World Ready

  This function can't be called in early-execution mode.