Class ItemDurabilityComponent

When present on an item, this item can take damage in the process of being used. Note that this component only applies to data-driven items.

Hierarchy

  • ItemDurabilityComponent

Constructors

constructor

Properties

damage damageRange maxDurability componentId

Methods

getDamageChance

Constructors

Protected constructor

Properties

damage

damage: number

Returns the current damage level of this particular item.

Readonly damageRange

damageRange: NumberRange

A range of numbers that describes the chance of the item losing durability.

Throws

This property can throw when used.

Readonly maxDurability

maxDurability: number

Represents the amount of damage that this item can take before breaking.

Throws

This property can throw when used.

Static Readonly componentId

componentId: "minecraft:durability" = 'minecraft:durability'

Methods

getDamageChance

  • Parameters

    • Optional unbreaking: number

      Unbreaking factor to consider in factoring the damage chance. Incoming unbreaking parameter must be greater than 0.

    Returns number

    Remarks

    Returns the maximum chance that this item would be damaged using the damageRange property, given an unbreaking level.

    Throws

    This function can throw errors.

Settings

Member Visibility

Theme

On This Page