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.

Example

getItemDurability.js

import { world } from "@minecraft/server";

const player = world.getPlayers()[0];
const inventory = player.getComponent("inventory");
const slot = inventory.container.getSlot(player.selectedSlotIndex);
let durabilityComp = slot.getItem().getComponent("durability");
player.sendMessage(
"Item Durability: " +
(durabilityComp.maxDurability - durabilityComp.damage) +
"/" +
durabilityComp.maxDurability
);

Hierarchy

Constructors

Properties

damage: number

Remarks

Returns the current damage level of this particular item.

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

maxDurability: number

Remarks

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

Throws

This property can throw when used.

typeId: string

Remarks

Identifier of the component.

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

Methods

  • Parameters

    • Optional unbreakingEnchantmentLevel: number

      Unbreaking factor to consider in factoring the damage chance. Incoming unbreaking parameter must be within the range [0, 3].

      Optional

    Returns number

    Remarks

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

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

    Throws

    This function can throw errors.

  • Returns NumberRange

    Remarks

    A range of numbers that is used to calculate the damage chance for an item. The damage chance will fall within this range.

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

    Throws

    This function can throw errors.

  • 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.