org.spongepowered.api.data.manipulator.mutable.item

Interface DurabilityData

All Superinterfaces:

DataManipulator<DurabilityData,ImmutableDurabilityData>, DataSerializable, ValueContainer<DurabilityData>

public interface DurabilityData
extends DataManipulator<DurabilityData,ImmutableDurabilityData>

An DataManipulator 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
MutableBoundedValue<Integer>	durability() Gets the MutableBoundedValue for the "durability" remaining.
Value<Boolean>	unbreakable() Gets the Value for the "unbreakable" state of the ItemStack.

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

asImmutable, copy, fill, fill, from, set, set, set, set, transform

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

MutableBoundedValue<Integer> durability()

Gets the MutableBoundedValue 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

See Also:

Keys.ITEM_DURABILITY

unbreakable

Value<Boolean> unbreakable()

Gets the Value 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

See Also:

Keys.UNBREAKABLE