org.bukkit.potion

Interface PotionDataHolder

All Known Subinterfaces:

AreaEffectCloud, PotionMeta, TippedArrow

public interface PotionDataHolder

A mutable object that has fields for color, base potion data and custom effects, like a PotionMeta, but is not necessarily an ItemMeta.

Method Summary

Modifier and Type	Method and Description
boolean	addCustomEffect(PotionEffect effect, boolean overwrite) Adds a custom potion effect to this object.
void	clearCustomEffects0() Removes all custom potion effects.
default void	copyFrom(PotionDataHolder source) Copies potion data from another instance.
PotionData	getBasePotionData() Returns the potion data about the base potion
Color	getColor() Gets the color of this object.
List<PotionEffect>	getCustomEffects() Gets an immutable list containing all custom potion effects applied to this object.
default boolean	hasColor() Checks for existence of a potion color.
boolean	hasCustomEffect(PotionEffectType type) Checks for a specific custom potion effect type on this object.
boolean	hasCustomEffects() Checks for the presence of custom potion effects.
boolean	removeCustomEffect(PotionEffectType type) Removes a custom potion effect from this object.
void	setBasePotionData(PotionData data) Sets the underlying potion data
void	setColor(Color color) Sets the color of this object.

Method Detail

setBasePotionData

void setBasePotionData(PotionData data)

Sets the underlying potion data

Parameters:

data - PotionData to set the base potion state to

getBasePotionData

PotionData getBasePotionData()

Returns the potion data about the base potion

Returns:

a PotionData object

hasCustomEffects

boolean hasCustomEffects()

Checks for the presence of custom potion effects.

Returns:

true if custom potion effects are applied

getCustomEffects

List<PotionEffect> getCustomEffects()

Gets an immutable list containing all custom potion effects applied to this object.

Plugins should check that hasCustomEffects() returns true before calling this method.

Returns:

the immutable list of custom potion effects

addCustomEffect

boolean addCustomEffect(PotionEffect effect,
                        boolean overwrite)

Adds a custom potion effect to this object.

Parameters:

effect - the potion effect to add

overwrite - true if any existing effect of the same type should be overwritten

Returns:

true if the effect was added as a result of this call

removeCustomEffect

boolean removeCustomEffect(PotionEffectType type)

Removes a custom potion effect from this object.

Parameters:

type - the potion effect type to remove

Returns:

true if the effect was removed as a result of this call

Throws:

IllegalArgumentException - if this would place an item or entity in an invalid state

hasCustomEffect

boolean hasCustomEffect(PotionEffectType type)

Checks for a specific custom potion effect type on this object.

Parameters:

type - the potion effect type to check for

Returns:

true if the potion has this effect

hasColor

default boolean hasColor()

Checks for existence of a potion color.

Returns:

true if this has a custom potion color

getColor

Color getColor()

Gets the color of this object.

Returns:

color

setColor

void setColor(Color color)

Sets the color of this object.

Parameters:

color - new color

clearCustomEffects0

void clearCustomEffects0()

Removes all custom potion effects. This method is renamed because of incompatible return types between TippedArrow.clearCustomEffects() and PotionMeta.clearCustomEffects().

Throws:

IllegalArgumentException - if this would create an impossible item or entity

copyFrom

default void copyFrom(PotionDataHolder source)

Copies potion data from another instance.

Parameters:

source - the object to copy from