Class ItemStack

constructor

• new ItemStack(
      identifier: string | ItemType,
      options?: Partial<ItemStackOptions>,
  ): ItemStack

  Create a new item stack instance.

  Parameters

  • identifier: string | ItemType

    The identifier or item type of the item stack.
  • Optionaloptions: Partial<ItemStackOptions>

    The options for the item stack.

  Returns ItemStack

container

Readonlyidentifier

isStackable

maxStackSize

Readonlynbt

Readonlytype

world

components

• get components(): ItemTypeComponentCollection

  The components of the item stack type.

  Returns ItemTypeComponentCollection

addTrait

• addTrait<K extends typeof ItemStackTrait>(
      trait: ItemStackTrait | K,
      options?: ConstructorParameters<K>[1],
  ): InstanceType<K>

  Adds a trait to the itemstack.

  Type Parameters

  • K extends typeof ItemStackTrait

  Parameters

  • trait: ItemStackTrait | K

    The trait to add to the itemstack.
  • Optionaloptions: ConstructorParameters<K>[1]

    The additional options to pass to the trait.

  Returns InstanceType<K>

  The trait instance that was added to the itemstack.

decrementStack

• decrementStack(size?: number): void

  Decrements the size of the item stack.

  Parameters

  • Optionalsize: number

    The size to decrement.

  Returns void

equals

• equals(other: ItemStack): boolean

  Parameters

  • other: ItemStack

  Returns boolean

getAllDynamicProperties

• getAllDynamicProperties(): [string, JSONLikeValue][]

  Get all dynamic properties of the item stack.

  Returns [string, JSONLikeValue][]

  An array of all dynamic properties.

getAllTraits

• getAllTraits(): ItemStackTrait[]

  Get all traits of the itemstack.

  Returns ItemStackTrait[]

  An array of all itemstack traits.

getAuxiliaryValue

• getAuxiliaryValue(): number

  Get the auxiliary value of the item stack.

  Returns number

  The auxiliary value of the item stack.

getComponent

• getComponent<K extends typeof ItemTypeComponent>(component: K): InstanceType<K>

  Gets the specified component from the itemstack.

  Type Parameters

  • K extends typeof ItemTypeComponent

  Parameters

  • component: K

    The component to get from the itemstack.

  Returns InstanceType<K>

  The component instance.

getDisplayName

• getDisplayName(): string

  Get the display name of the item stack.

  Returns string

  the display name of the item stack.

  Note

  This method depends on the ItemStackDisplayTrait.

getDynamicProperty

• getDynamicProperty<T extends JSONLikeValue>(key: string): null | T

  Get a dynamic property from the item stack.

  Type Parameters

  • T extends JSONLikeValue

  Parameters

  • key: string

    The key of the dynamic property.

  Returns null | T

  The dynamic property value, or null if it does not exist.

getLore

• getLore(): string[]

  Get the lore of the item stack.

  Returns string[]

  The lore of the item stack.

  Note

  This method depends on the ItemStackDisplayTrait.

getSlot

• getSlot(): number

  Get the slot of the item stack in its container.

  Returns number

  The slot of the item stack, or -1 if not in a container.

getStackSize

• getStackSize(): number

  The amount of items in the item stack.

  Returns number

  The size of the item stack.

getStorage

• getStorage(): ItemStackLevelStorage

  Get the level storage of the item stack.

  Returns ItemStackLevelStorage

  The item stack level storage.

getTrait

• getTrait<K extends typeof ItemStackTrait>(trait: K): InstanceType<K>

  Gets the specified trait from the itemstack.

  Type Parameters

  • K extends typeof ItemStackTrait

  Parameters

  • trait: K

    The trait to get from the itemstack

  Returns InstanceType<K>

  The trait if it exists, otherwise null
• getTrait(trait: string): null | ItemStackTrait

  Gets the specified trait from the itemstack.

  Parameters

  • trait: string

    The trait to get from the itemstack

  Returns null | ItemStackTrait

  The trait if it exists, otherwise null

hasComponent

• hasComponent(component: string | typeof ItemTypeComponent): boolean

  Checks if the itemstack has the specified component.

  Parameters

  • component: string | typeof ItemTypeComponent

    The component to check for.

  Returns boolean

  Whether the itemstack has the component.

hasDynamicProperty

• hasDynamicProperty(key: string): boolean

  Check if the item stack has a dynamic property.

  Parameters

  • key: string

    The key of the dynamic property.

  Returns boolean

  Whether the item stack has the dynamic property.

hasTrait

• hasTrait(trait: string | typeof ItemStackTrait): boolean

  Whether the itemstack has the specified trait.

  Parameters

  • trait: string | typeof ItemStackTrait

    The trait to check for

  Returns boolean

  Whether the itemstack has the trait

incrementStack

• incrementStack(size?: number): void

  Increments the size of the item stack.

  Parameters

  • Optionalsize: number

    The size to increment.

  Returns void

removeDynamicProperty

• removeDynamicProperty(key: string): void

  Remove a dynamic property from the item stack.

  Parameters

  • key: string

    The key of the dynamic property.

  Returns void

removeTrait

• removeTrait(trait: string | typeof ItemStackTrait): void

  Removes the specified trait from the itemstack.

  Parameters

  • trait: string | typeof ItemStackTrait

    The trait to remove

  Returns void

setAuxiliaryValue

• setAuxiliaryValue(value: number): void

  Set the auxiliary value of the item stack.

  Parameters

  • value: number

    The auxiliary value to set.

  Returns void

setDisplayName

• setDisplayName(name: null | string): void

  Set the display name of the item stack.

  Parameters

  • name: null | string

    The display name to set for the item stack.

  Returns void

  Note

  This method depends on the ItemStackDisplayTrait, or adds it if it does not exist.

setDynamicProperty

• setDynamicProperty<T extends JSONLikeValue>(key: string, value: T): void

  Set a dynamic property on the item stack.

  Type Parameters

  • T extends JSONLikeValue

  Parameters

  • key: string

    The key of the dynamic property.
  • value: T

    The value of the dynamic property.

  Returns void

setLore

• setLore(lore: string[]): void

  Set the lore of the item stack.

  Parameters

  • lore: string[]

    The lore to set for the item stack.

  Returns void

  Note

  This method depends on the ItemStackDisplayTrait, or adds it if it does not exist.

setSlot

• setSlot(value: number): void

  Set the slot of the item stack in its container.

  Parameters

  • value: number

    The slot to set the item stack to.

  Returns void

  The slot of the item stack, or -1 if not in a container.

setStackSize

• setStackSize(size: number): void

  Set the size of the item stack.

  Parameters

  • size: number

    The size to set.

  Returns void

startCooldown

• startCooldown(duration: number): void

  Start a cooldown for the item stack.

  Parameters

  • duration: number

    The duration of the cooldown in ticks.

  Returns void

use

• use(player: Player, options: ItemStackUseOptions): boolean | ItemUseMethod

  Causes a player to use the item stack.

  Parameters

  • player: Player

    The player using the item.
  • options: ItemStackUseOptions

    The options for the item use.

  Returns boolean | ItemUseMethod

  Whether the item use was successful; default is true.

useOnBlock

• useOnBlock(
      player: Player,
      options: ItemStackUseOnBlockOptions,
  ): boolean | ItemUseMethod

  Parameters

  • player: Player
  • options: ItemStackUseOnBlockOptions

  Returns boolean | ItemUseMethod

useOnEntity

• useOnEntity(
      player: Player,
      options: ItemStackUseOnEntityOptions,
  ): boolean | ItemUseMethod

  Parameters

  • player: Player
  • options: ItemStackUseOnEntityOptions

  Returns boolean | ItemUseMethod

Staticempty

• empty(): ItemStack

  Creates an empty item stack.

  Returns ItemStack

  The empty item stack.

Staticfrom

• from(other: ItemStack): ItemStack

  Creates a new item stack from another item stack.

  Parameters

  • other: ItemStack

    The other item stack to copy from.

  Returns ItemStack

  A new item stack instance with the same properties as the other item stack.

StaticfromLevelStorage

• fromLevelStorage(world: World, storage: CompoundTag): ItemStack

  Parameters

  • world: World
  • storage: CompoundTag

  Returns ItemStack

StaticfromNetworkInstance

• fromNetworkInstance(
      descriptor: NetworkItemInstanceDescriptor,
      options?: Partial<ItemStackOptions>,
  ): null | ItemStack

  Converts a network item instance descriptor to an item stack.

  Parameters

  • descriptor: NetworkItemInstanceDescriptor

    The network item instance descriptor.
  • Optionaloptions: Partial<ItemStackOptions>

  Returns null | ItemStack

  The item stack.

StatictoNetworkInstance

• toNetworkInstance(item: ItemStack): NetworkItemInstanceDescriptor

  Converts the item stack to a network item instance descriptor. Which is used on the protocol level.

  Parameters

  • item: ItemStack

    The item stack to convert.

  Returns NetworkItemInstanceDescriptor

  The network item instance descriptor.

StatictoNetworkStack

• toNetworkStack(item: ItemStack): NetworkItemStackDescriptor

  Converts the item stack to a network item stack descriptor. Which is used on the protocol level.

  Parameters

  • item: ItemStack

    The item stack to convert.

  Returns NetworkItemStackDescriptor

  The network item stack descriptor.