Package org.spongepowered.api.data.type

Interface ItemAction

All Known Subinterfaces:

ItemAction.ApplyEffects, ItemAction.ClearEffects, ItemAction.PlaySound, ItemAction.RemoveEffects, ItemAction.TeleportRandomly

public interface ItemAction

Represents an action an ItemStack can apply to Living in different circumstances.

See Also:

• Keys.CONSUME_ACTIONS
• Keys.DEATH_PROTECTION_ACTIONS

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ItemAction.ApplyEffects	Applies PotionEffects with chance.
static interface	ItemAction.ClearEffects	Clears all PotionEffects.
static interface	ItemAction.Factory
static interface	ItemAction.PlaySound	Plays SoundType.
static interface	ItemAction.RemoveEffects	Removes PotionEffects with matching PotionEffectTypes.
static interface	ItemAction.TeleportRandomly	Teleports randomly within maximum distance.

Method Summary

Modifier and Type	Method	Description
default boolean	apply(Living entity)	Applies this effect with ItemStack.empty().
boolean	apply(Living entity, ItemStackLike stack)	Tries to apply this effect and returns whether it was successfully applied.
static ItemAction.ApplyEffects	applyEffects(double chance, Collection<PotionEffect> effects)
static ItemAction.ApplyEffects	applyEffects(double chance, PotionEffect... effects)
static ItemAction.ApplyEffects	applyEffects(Collection<PotionEffect> effects)
static ItemAction.ApplyEffects	applyEffects(PotionEffect... effects)
static ItemAction.ClearEffects	clearEffects()
static ItemAction.PlaySound	playSound(Supplier<SoundType> soundType)
static ItemAction.PlaySound	playSound(SoundType soundType)
static ItemAction.RemoveEffects	removeEffects(Collection<PotionEffectType> effectTypes)
static ItemAction.RemoveEffects	removeEffects(Supplier<PotionEffectType>... effectTypes)
static ItemAction.RemoveEffects	removeEffects(PotionEffectType... effectTypes)
static ItemAction.RemoveEffects	removeEffects(Tag<PotionEffectType> effectTypeTag)
static ItemAction.TeleportRandomly	teleportRandomly(double distance)
ItemActionType	type()	Returns the type of this effect.

Method Details

applyEffects

static ItemAction.ApplyEffects applyEffects(Collection<PotionEffect> effects)

applyEffects

static ItemAction.ApplyEffects applyEffects(PotionEffect... effects)

applyEffects

static ItemAction.ApplyEffects applyEffects(double chance,
 Collection<PotionEffect> effects)

applyEffects

static ItemAction.ApplyEffects applyEffects(double chance,
 PotionEffect... effects)

removeEffects

static ItemAction.RemoveEffects removeEffects(Collection<PotionEffectType> effectTypes)

removeEffects

static ItemAction.RemoveEffects removeEffects(PotionEffectType... effectTypes)

removeEffects

@SafeVarargs
static ItemAction.RemoveEffects removeEffects(Supplier<PotionEffectType>... effectTypes)

removeEffects

static ItemAction.RemoveEffects removeEffects(Tag<PotionEffectType> effectTypeTag)

clearEffects

static ItemAction.ClearEffects clearEffects()

playSound

static ItemAction.PlaySound playSound(SoundType soundType)

playSound

static ItemAction.PlaySound playSound(Supplier<SoundType> soundType)

teleportRandomly

static ItemAction.TeleportRandomly teleportRandomly(double distance)

type

ItemActionType type()

Returns the type of this effect.

Returns:

The type of this effect

apply

boolean apply(Living entity,
 ItemStackLike stack)

Tries to apply this effect and returns whether it was successfully applied. The definition of success is purely left up to the implementation.

Parameters:

entity - The entity to apply effect to

stack - The item to apply effect with

Returns:

true if effect was successfully applied

apply

default boolean apply(Living entity)

Applies this effect with ItemStack.empty().

Parameters:

entity - The entity to apply effect to

Returns:

true if effect was successfully applied

See Also:

• apply(Living, ItemStackLike)