org.bukkit.inventory.meta.FireworkEffectMeta Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of walk-server Show documentation

A spigot fork to kotlin structure and news.

There is a newer version: 2.4.0

package org.bukkit.inventory.meta;

import org.bukkit.FireworkEffect;
import org.bukkit.Material;

/**
 * Represents a meta that can store a single FireworkEffect. An example
 * includes {@link Material#FIREWORK_CHARGE}.
 */
public interface FireworkEffectMeta extends ItemMeta {

  /**
   * Checks if this meta has an effect.
   *
   * @return true if this meta has an effect, false otherwise
   */
  boolean hasEffect();

  /**
   * Gets the firework effect for this meta.
   *
   * @return the current effect, or null if none
   */
  FireworkEffect getEffect();

  /**
   * Sets the firework effect for this meta.
   *
   * @param effect the effect to set, or null to indicate none.
   */
  void setEffect(FireworkEffect effect);

  FireworkEffectMeta clone();
}