Class ItemUtils

Index

Constructors

Methods

consumeDurability getUnbreakingChance

Constructors

constructor

new ItemUtils(): ItemUtils
Returns ItemUtils

Methods

`Static`consumeDurability

consumeDurability(player: Player, options?: ConsumeDurabilityOptions): boolean
Consumes durability from the player's selected item.
Parameters
- player: Player
  The player whose item durability will be consumed.
- Optionaloptions: ConsumeDurabilityOptions
  The options for consuming durability.
  - OptionalbreakSound?: string
    Whether to suppress playing a sound when item breaks. Defaults to "random.break". If set to an empty string, no sound will be played.
  - OptionalignoreCreative?: boolean
    Whether to ignore player's gamemode and consume durability anyways.
  - OptionalignoreEnchantments?: boolean
    Whether to ignore enchantments when consuming durability.
  - Optionalslot?: EquipmentSlot
    The slot to consume durability from. Defaults to the player's main hand.
  - Optionalvalue?: number
    The amount of durability to consume. Defaults to 1.
Returns boolean
True if the durability was consumed, false otherwise.

Remarks
Return value false does not always mean that the function failed. It can also mean that the item was not damaged due to unbreaking enchantment.
- Defined in index.d.ts:1972

`Static`getUnbreakingChance

getUnbreakingChance(unbreakingLevel: number): number
Returns the chance to consume durability from item based on the unbreaking level.
Parameters
- unbreakingLevel: number
  The unbreaking level of the item.
Returns number
The chance to consume durability from item based on the unbreaking level.
- Defined in index.d.ts:1978