Package org.bukkit.inventory.meta

Interface FireworkMeta

All Superinterfaces:
java.lang.Cloneable, ConfigurationSerializable, ItemMeta
public interface FireworkMeta
extends ItemMeta
Represents a Material.FIREWORK and its effects.

  • Method Details

    • addEffect

      void addEffect​(FireworkEffect effect) throws java.lang.IllegalArgumentException
      Add another effect to this firework.
      Parameters:
      effect - The firework effect to add
      Throws:
      java.lang.IllegalArgumentException - If effect is null

    • addEffects

      void addEffects​(FireworkEffect... effects) throws java.lang.IllegalArgumentException
      Add several effects to this firework.
      Parameters:
      effects - The firework effects to add
      Throws:
      java.lang.IllegalArgumentException - If effects is null
      java.lang.IllegalArgumentException - If any effect is null (may be thrown after changes have occurred)

    • addEffects

      void addEffects​(java.lang.Iterable<FireworkEffect> effects) throws java.lang.IllegalArgumentException
      Add several firework effects to this firework.
      Parameters:
      effects - An iterable object whose iterator yields the desired firework effects
      Throws:
      java.lang.IllegalArgumentException - If effects is null
      java.lang.IllegalArgumentException - If any effect is null (may be thrown after changes have occurred)

    • getEffects

      java.util.List<FireworkEffect> getEffects()
      Get the effects in this firework.
      Returns:
      An immutable list of the firework effects

    • getEffectsSize

      int getEffectsSize()
      Get the number of effects in this firework.
      Returns:
      The number of effects

    • removeEffect

      void removeEffect​(int index) throws java.lang.IndexOutOfBoundsException
      Remove an effect from this firework.
      Parameters:
      index - The index of the effect to remove
      Throws:
      java.lang.IndexOutOfBoundsException - If index < 0 or index > getEffectsSize()

    • clearEffects

      void clearEffects()
      Remove all effects from this firework.

    • hasEffects

      boolean hasEffects()
      Get whether this firework has any effects.
      Returns:
      true if it has effects, false if there are no effects

    • getPower

      int getPower()
      Gets the approximate height the firework will fly.
      Returns:
      approximate flight height of the firework.

    • setPower

      void setPower​(int power) throws java.lang.IllegalArgumentException
      Sets the approximate power of the firework. Each level of power is half a second of flight time.
      Parameters:
      power - the power of the firework, from 0-128
      Throws:
      java.lang.IllegalArgumentException - if height<0 or height>128

    • clone

      FireworkMeta clone()
      Specified by:
      clone in interface ItemMeta