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

ReadonlydynamicProperties

Readonlyidentifier

isStackable

maxStackSize

metadata

Readonlynbt

stackSize

Readonlytraits

Readonlytype

world

components

• get components(): ItemTypeComponentCollection

  The components of the item stack type.

  Returns ItemTypeComponentCollection

slot

• get slot(): number

  The slot of the item stack in the container.

  Returns number
• set slot(value: number): void

  The slot of the item stack in the container.

  Parameters

  • value: number

  Returns void

addDynamicProperty

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

  Adds a dynamic property to the itemstack.

  Type Parameters

  • T extends JSONLikeValue

  Parameters

  • key: string

    The key of the dynamic property.
  • value: T

    The value of the dynamic property.

  Returns void

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

getBlockData

• getBlockData(): BlockEntry

  Get the block data for the item stack.

  Returns BlockEntry

  The block data for 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.

getDataEntry

• getDataEntry(): ItemStackDataEntry

  Gets the data entry for the item stack.

  Returns ItemStackDataEntry

  The data entry for the item stack.

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

  Gets the specified dynamic property from the itemstack.

  Type Parameters

  • T extends JSONLikeValue

  Parameters

  • key: string

    The key of the dynamic property.

  Returns null | T

  The dynamic property if it exists, otherwise null

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.

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

  Checks if the itemstack has the specified dynamic property.

  Parameters

  • key: string

    The key of the dynamic property.

  Returns boolean

  Whether the itemstack 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

loadDataEntry

• loadDataEntry(
      world: World,
      entry: ItemStackDataEntry,
      overwrite?: boolean,
  ): void

  Loads the data entry for the item stack.

  Parameters

  • world: World

    The world to load the item stack in.
  • entry: ItemStackDataEntry

    The item stack entry to load.
  • overwrite: boolean = true

    Whether to overwrite the existing data.

  Returns void

removeDynamicProperty

• removeDynamicProperty(key: string): void

  Removes the specified dynamic property from the itemstack.

  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

setBlockData

• setBlockData(data: BlockEntry): void

  Set the block data for the item stack.

  Parameters

  • data: BlockEntry

    The block data 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

  Sets the specified dynamic property of the itemstack.

  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.

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

update

• update(): void

  Updates the item stack in the container.

  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.

StaticfromDataEntry

• fromDataEntry(dataEntry: ItemStackDataEntry, world?: World): ItemStack

  Creates an item stack from a data entry.

  Parameters

  • dataEntry: ItemStackDataEntry
  • Optionalworld: World

    The world to create the item stack in.

  Returns ItemStack

  The item stack.

StaticfromNetworkInstance

• fromNetworkInstance(descriptor: NetworkItemInstanceDescriptor): null | ItemStack

  Converts a network item instance descriptor to an item stack.

  Parameters

  • descriptor: NetworkItemInstanceDescriptor

    The network item instance descriptor.

  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.