Class ItemDurabilityComponentBeta

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

Constructors

constructor

Properties

damage maxDurability typeId componentId

Methods

getDamageChance getDamageRange isValid

Constructors

Private constructor

Properties

damage

damage: number

Remarks

Returns the current damage level of this particular item.

This property can't be edited in read-only mode.

Readonly maxDurability

maxDurability: number

Remarks

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

Throws

This property can throw when used.

Readonly typeId

typeId: string

Remarks

Identifier of the component.

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.

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

getDamageRange

  • Returns NumberRange

    Remarks

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

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

isValid

  • Beta

    Returns boolean

    Whether the component is valid.

    Remarks

    Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.

Settings

Member Visibility

Theme

On This Page