Package io.github.lucfr1746.llibrary.itemstack

Class FireworkEffectBuilder

java.lang.Object

io.github.lucfr1746.llibrary.itemstack.ItemBuilder

io.github.lucfr1746.llibrary.itemstack.FireworkEffectBuilder

public class FireworkEffectBuilder
extends ItemBuilder

The FireworkEffectBuilder class extends ItemBuilder to provide additional functionality for modifying FireworkEffectMeta of an ItemStack. This class allows setting firework effects, including colors, fade colors, flicker, and trail.

Constructor Summary

Constructors

Constructor	Description
FireworkEffectBuilder()	Constructs a FireworkEffectBuilder with a new Material.FIREWORK_STAR.
FireworkEffectBuilder(@NotNull org.bukkit.inventory.ItemStack itemStack)	Constructs a FireworkEffectBuilder using an existing ItemStack.

Method Summary

Modifier and Type	Method	Description
org.bukkit.FireworkEffect	getEffect()	Gets the firework effect.
boolean	hasEffect()	Checks if the firework effect exists.
FireworkEffectBuilder	setEffect(@NotNull org.bukkit.FireworkEffect effect)	Sets the firework effect.

Methods inherited from class io.github.lucfr1746.llibrary.itemstack.ItemBuilder

addAttributeModifier, addEnchant, addEnchant, addEnchant, addItemFlags, addLore, build, getAmount, getAttributeModifiers, getAttributeModifiers, getAttributeModifiers, getCustomModelData, getDamageResistant, getDisplayName, getEnchantable, getEnchantLevel, getEnchantmentGlintOverride, getEnchants, getEquippableComponent, getFoodComponent, getItemFlags, getItemMeta, getItemModel, getJukeboxPlayableComponent, getMaxStackSize, getRarity, getToolComponent, getTooltipStyle, getTranslationKey, getType, getUseCooldownComponent, getUseRemainder, hasAttributeModifiers, hasConflictingEnchant, hasCustomModelData, hasDamageResistant, hasEnchant, hasEnchantable, hasEnchantmentGlintOverride, hasEnchants, hasEquippableComponent, hasFoodComponent, hasItemFlag, hasItemModel, hasJukeboxPlayableComponent, hasMaxStackSize, hasRarity, hasToolComponent, hasTooltipStyle, hasUseCooldownComponent, hasUseRemainder, hideAllItemFlags, insertLore, isGlider, isHideTooltip, isUnbreakable, removeAttributeModifier, removeAttributeModifier, removeAttributeModifier, removeEnchant, removeEnchants, removeItemFlags, replaceLore, setAmount, setAttributeModifiers, setCustomModelData, setDamageResistant, setDisplayName, setEnchantable, setEnchantmentGlintOverride, setEquippableComponent, setEquippableComponent, setFood, setFoodComponent, setGlider, setHideTooltip, setItemModel, setItemModel, setJukeboxPlayableComponent, setJukeboxPlayableComponent, setJukeboxPlayableComponent, setLores, setLores, setMaxStackSize, setRarity, setToolComponent, setToolComponent, setTooltipStyle, setTooltipStyle, setType, setUnbreakable, setUseCooldownComponent, setUseCooldownComponent, setUseCooldownComponent, setUseRemainder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FireworkEffectBuilder

public FireworkEffectBuilder()

Constructs a FireworkEffectBuilder with a new Material.FIREWORK_STAR.

FireworkEffectBuilder

public FireworkEffectBuilder(@NotNull
 @NotNull org.bukkit.inventory.ItemStack itemStack)

Constructs a FireworkEffectBuilder using an existing ItemStack.

Parameters:

itemStack - the item stack to modify

Throws:

IllegalArgumentException - if the item's meta is not an instance of FireworkEffectMeta

Method Details

setEffect

public FireworkEffectBuilder setEffect(@NotNull
 @NotNull org.bukkit.FireworkEffect effect)

Sets the firework effect.

Parameters:

effect - the firework effect

Returns:

this FireworkEffectBuilder instance for method chaining

Throws:

IllegalArgumentException - if the effect is null

getEffect

public org.bukkit.FireworkEffect getEffect()

Gets the firework effect.

Returns:

the firework effect, or null if not set

hasEffect

public boolean hasEffect()

Checks if the firework effect exists.

Returns:

true if there is a firework effect, false otherwise