Package io.papermc.paper.datacomponent.item.consumable

Interface ConsumeEffect.ApplyStatusEffects

All Superinterfaces:

ConsumeEffect

Enclosing interface:

ConsumeEffect

@Experimental
@NonExtendable
public static interface ConsumeEffect.ApplyStatusEffects
extends ConsumeEffect

Represents a consumable effect that applies potion effects based on a probability on consumption.

Nested Class Summary

Nested classes/interfaces inherited from interface io.papermc.paper.datacomponent.item.consumable.ConsumeEffect

ConsumeEffect.ApplyStatusEffects, ConsumeEffect.ClearAllStatusEffects, ConsumeEffect.PlaySound, ConsumeEffect.RemoveStatusEffects, ConsumeEffect.TeleportRandomly

Method Summary

Modifier and Type	Method	Description
List<PotionEffect>	effects()	Potion effect instances to grant.
float	probability()	Float between 0 and 1, chance for the effect to be applied.

Method Details

effects

List<PotionEffect> effects()

Potion effect instances to grant.

Returns:

potion effects

probability

float probability()

Float between 0 and 1, chance for the effect to be applied.

Returns:

chance