Class ItemTrait

constructor

• new ItemTrait(item: ItemStack, _options?: JSONLikeObject): ItemTrait

  Creates a new instance of the item trait.

  Parameters

  • item: ItemStack

    The item stack that this trait will be attached to.
  • Optional_options: JSONLikeObject

  Returns ItemTrait

Static Readonlycomponents

Static Readonlytag

Static Readonlytypes

clone

• clone(item: ItemStack): this

  Clones the item trait to another item stack.

  Parameters

  • item: ItemStack

    The item stack to clone the component to.

  Returns this

  A new item trait.

equals

• equals(other: ItemTrait): boolean

  Compares another item trait to this one.

  Parameters

  • other: ItemTrait

    The other item trait to compare.

  Returns boolean

  Whether the item traits are equal.

OptionalonContainerClose

• onContainerClose(player: Player): void

  Called when the container that the item is stored in is closed.

  Parameters

  • player: Player

    The player that closed the container

  Returns void

OptionalonContainerOpen

• onContainerOpen(player: Player): void

  Called when the container that the item is stored in is opened.

  Parameters

  • player: Player

    The player that opened the container.

  Returns void

OptionalonRelease

• onRelease(player: Player): void

  Called when the release action is triggered by a player.

  Parameters

  • player: Player

    The player that released the item.

  Returns void

OptionalonStartCooldown

• onStartCooldown(duration: number): void

  Called when the item has been signaled to cooldown.

  Parameters

  • duration: number

    The duration of the cooldown in ticks.

  Returns void

OptionalonStartUse

• onStartUse(player: Player, options: ItemStackUseOptions): boolean | void

  Called when the item is used by a player.

  Parameters

  • player: Player

    The player that used the item.
  • options: ItemStackUseOptions

    The additional options for the item use.

  Returns boolean | void

  Whether the item use was successful; default is true

OptionalonStopCooldown

• onStopCooldown(): void

  Called when the item cooldown has stopped.

  Returns void

OptionalonStopUse

• onStopUse(player: Player, options: ItemStackUseOptions): boolean | void

  Called when the item is stopped being used by a player.

  Parameters

  • player: Player

    The player that stopped using the item.
  • options: ItemStackUseOptions

    The additional options for the item use.

  Returns boolean | void

OptionalonUse

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

  Called when the item is used by a player.

  Parameters

  • player: Player

    The player that used the item.
  • options: ItemStackUseOptions

    The additional options for the item use.

  Returns boolean | void | ItemUseMethod

OptionalonUseOnBlock

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

  Called when the item is used on a block by a player.

  Parameters

  • player: Player

    The player that used the item.
  • options: ItemStackUseOnBlockOptions

    The additional options for the item use.

  Returns boolean | void | ItemUseMethod

OptionalonUseOnEntity

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

  Called when the item is used on an entity by a player.

  Parameters

  • player: Player

    The player that used the item.
  • options: ItemStackUseOnEntityOptions

    The additional options for the item use.

  Returns boolean | void | ItemUseMethod