org.bukkit.inventory.meta

Interface FireworkEffectMeta

All Superinterfaces:

Cloneable, ConfigurationSerializable, ItemMeta

public interface FireworkEffectMeta
extends ItemMeta

Represents a meta that can store a single FireworkEffect. An example includes Material.FIREWORK_STAR.

Nested Class Summary

Nested classes/interfaces inherited from interface org.bukkit.inventory.meta.ItemMeta

ItemMeta.Spigot

Method Summary

Modifier and Type	Method and Description
FireworkEffectMeta	clone()
FireworkEffect	getEffect() Gets the firework effect for this meta.
boolean	hasEffect() Checks if this meta has an effect.
void	setEffect(FireworkEffect effect) Sets the firework effect for this meta.

Methods inherited from interface org.bukkit.inventory.meta.ItemMeta

addAttributeModifier, addEnchant, addItemFlags, getAttributeModifiers, getAttributeModifiers, getAttributeModifiers, getCanDestroy, getCanPlaceOn, getCustomTagContainer, getDestroyableKeys, getDisplayName, getEnchantLevel, getEnchants, getItemFlags, getLocalizedName, getLore, getPlaceableKeys, hasAttributeModifiers, hasConflictingEnchant, hasDestroyableKeys, hasDisplayName, hasEnchant, hasEnchants, hasItemFlag, hasLocalizedName, hasLore, hasPlaceableKeys, isUnbreakable, removeAttributeModifier, removeAttributeModifier, removeAttributeModifier, removeEnchant, removeItemFlags, setAttributeModifiers, setCanDestroy, setCanPlaceOn, setDestroyableKeys, setDisplayName, setLocalizedName, setLore, setPlaceableKeys, setUnbreakable, spigot

Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable

serialize

Method Detail

setEffect

void setEffect(@Nullable
               FireworkEffect effect)

Sets the firework effect for this meta.

Parameters:

effect - the effect to set, or null to indicate none.

hasEffect

boolean hasEffect()

Checks if this meta has an effect.

Returns:

true if this meta has an effect, false otherwise

getEffect

@Nullable
FireworkEffect getEffect()

Gets the firework effect for this meta.

Returns:

the current effect, or null if none

clone

@NotNull
FireworkEffectMeta clone()

Specified by:

clone in interface ItemMeta