org.spongepowered.api.data.manipulator.immutable.item

Interface ImmutableDurabilityData

All Superinterfaces:

DataSerializable, ImmutableDataManipulator<ImmutableDurabilityData,DurabilityData>, ValueContainer<ImmutableDurabilityData>

public interface ImmutableDurabilityData
extends ImmutableDataManipulator<ImmutableDurabilityData,DurabilityData>

An ImmutableDataManipulator handling the "durability" of an ItemStack that will "break" after a certain amount of "uses".

Usually, items with durability will break and disappear when their durability reaches the maximum. Examples of this include pickaxes, axes, swords, and shovels. It is recommended to retrieve the maximum durability limit from the UseLimitProperty.

Method Summary

Modifier and Type	Method and Description
ImmutableBoundedValue<Integer>	durability() Gets the ImmutableBoundedValue for the "durability" remaining.
ImmutableValue<Boolean>	unbreakable() Gets the ImmutableValue for the "unbreakable" state of the ItemStack.

Methods inherited from interface org.spongepowered.api.data.manipulator.ImmutableDataManipulator

asMutable, copy, with, with

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Method Detail

durability

ImmutableBoundedValue<Integer> durability()

Gets the ImmutableBoundedValue for the "durability" remaining. The durability is a number signifying how many "uses' remain on the item. When the durability reaches 0, usually, the item breaks.

Returns:

The immutable bounded value of durability remaining

unbreakable

ImmutableValue<Boolean> unbreakable()

Gets the ImmutableValue for the "unbreakable" state of the ItemStack. While the ItemStack is "unbreakable", the durability can not change.

Returns:

The immutable value for the "unbreakable" state