Package io.papermc.paper.datacomponent.item

Interface Consumable

All Superinterfaces:

BuildableDataComponent<Consumable,Consumable.Builder>

@NullMarked
@Experimental
@NonExtendable
public interface Consumable
extends BuildableDataComponent<Consumable,Consumable.Builder>

Holds the properties for this item for when it is consumed.

See Also:

• DataComponentTypes.CONSUMABLE

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Consumable.Builder	Builder for Consumable.

Method Summary

Modifier and Type	Method	Description
ItemUseAnimation	animation()
static Consumable.Builder	consumable()
@Unmodifiable List<ConsumeEffect>	consumeEffects()
@org.checkerframework.checker.index.qual.NonNegative float	consumeSeconds()
boolean	hasConsumeParticles()
net.kyori.adventure.key.Key	sound()

Methods inherited from interface io.papermc.paper.datacomponent.BuildableDataComponent

toBuilder

Method Details

consumable

@Contract(value="-> new",
          pure=true)
static Consumable.Builder consumable()

consumeSeconds

@Contract(pure=true)
@org.checkerframework.checker.index.qual.NonNegative float consumeSeconds()

animation

@Contract(pure=true)
ItemUseAnimation animation()

sound

@Contract(pure=true)
net.kyori.adventure.key.Key sound()

hasConsumeParticles

@Contract(pure=true)
boolean hasConsumeParticles()

consumeEffects

@Contract(pure=true)
@Unmodifiable List<ConsumeEffect> consumeEffects()