Interface FireworkEffectMeta

All Superinterfaces:

Cloneable, ConfigurationSerializable, ItemMeta, PersistentDataHolder, PersistentDataViewHolder

public interface FireworkEffectMeta
extends ItemMeta

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

Since:

1.4.6

Method Summary

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

Methods inherited from interface ConfigurationSerializable

serialize

Methods inherited from interface ItemMeta

addAttributeModifier, addEnchant, addItemFlags, customName, customName, displayName, displayName, getAsComponentString, getAsString, getAttributeModifiers, getAttributeModifiers, getAttributeModifiers, getCanDestroy, getCanPlaceOn, getCustomModelData, getCustomModelDataComponent, getCustomTagContainer, getDamageResistant, getDamageResistantTypes, getDestroyableKeys, getDisplayName, getDisplayNameComponent, getEnchantable, getEnchantLevel, getEnchantmentGlintOverride, getEnchants, getEquippable, getFood, getItemFlags, getItemModel, getItemName, getJukeboxPlayable, getLocalizedName, getLore, getLoreComponents, getMaxStackSize, getPlaceableKeys, getRarity, getTool, getTooltipStyle, getUseCooldown, getUseRemainder, hasAttributeModifiers, hasConflictingEnchant, hasCustomModelData, hasCustomModelDataComponent, hasCustomName, hasDamageResistant, hasDestroyableKeys, hasDisplayName, hasEnchant, hasEnchantable, hasEnchantmentGlintOverride, hasEnchants, hasEquippable, hasFood, hasItemFlag, hasItemModel, hasItemName, hasJukeboxPlayable, hasLocalizedName, hasLore, hasMaxStackSize, hasPlaceableKeys, hasRarity, hasTool, hasTooltipStyle, hasUseCooldown, hasUseRemainder, isFireResistant, isGlider, isHideTooltip, isUnbreakable, itemName, itemName, lore, lore, removeAttributeModifier, removeAttributeModifier, removeAttributeModifier, removeEnchant, removeEnchantments, removeItemFlags, setAttributeModifiers, setCanDestroy, setCanPlaceOn, setCustomModelData, setCustomModelDataComponent, setDamageResistant, setDamageResistantTypes, setDestroyableKeys, setDisplayName, setDisplayNameComponent, setEnchantable, setEnchantmentGlintOverride, setEquippable, setFireResistant, setFood, setGlider, setHideTooltip, setItemModel, setItemName, setJukeboxPlayable, setLocalizedName, setLore, setLoreComponents, setMaxStackSize, setPlaceableKeys, setRarity, setTool, setTooltipStyle, setUnbreakable, setUseCooldown, setUseRemainder, setVersion

Methods inherited from interface PersistentDataHolder

getPersistentDataContainer

Method Details

setEffect

void setEffect(@Nullable
 @Nullable FireworkEffect effect)

Sets the firework effect for this meta.

Parameters:

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

Since:

1.4.6

hasEffect

boolean hasEffect()

Checks if this meta has an effect.

Returns:

true if this meta has an effect, false otherwise

Since:

1.4.6

getEffect

@Nullable
@Nullable FireworkEffect getEffect()

Gets the firework effect for this meta.

Returns:

the current effect, or null if none

Since:

1.4.6

clone

@NotNull
@NotNull FireworkEffectMeta clone()

Specified by:

clone in interface ItemMeta