Class ItemStackSignTrait

Readonlyidentifier

Static Readonlycomponent

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: ItemStackTrait): boolean

  Compares another item trait to this one.

  Parameters

  • other: ItemStackTrait

    The other item trait to compare.

  Returns boolean

  Whether the item traits are equal.

OptionalonAdd

• onAdd(): void

  Called when the trait is added to an object.

  Returns void

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

OptionalonDropped

• onDropped(options: ItemStackDroppedOptions): void

  Called when the item is dropped by a player or entity.

  Parameters

  • options: ItemStackDroppedOptions

    The options for the item stack that was dropped.

  Returns void

OptionalonRandomTick

• onRandomTick(): void

  Called when the trait is random ticked by the dimension.

  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

OptionalonRemove

• onRemove(): void

  Called when the trait is removed from an object.

  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

OptionalonTick

• onTick(details: TraitOnTickDetails): void

  Called when the trait is ticked by the dimension.

  Parameters

  • details: TraitOnTickDetails

    The details about the tick event.

  Returns 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

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

setRandomTickProbability

• setRandomTickProbability(numerator: number, denominator: number): void

  Sets the probability of this trait being randomly ticked each tick.

  Parameters

  • numerator: number

    The numerator of the probability fraction.
  • denominator: number

    The denominator of the probability fraction.

  Returns void

shouldRandomTick

• shouldRandomTick(factor?: number): boolean

  Wether this trait should be randomly ticked this tick.

  Parameters

  • factor: number = 1

    A factor to multiply the chance by. Default is 1.

  Returns boolean

  True if the trait should be randomly ticked, false otherwise.