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_CHARGE.


Method Summary
 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
addEnchant, getDisplayName, getEnchantLevel, getEnchants, getLore, hasConflictingEnchant, hasDisplayName, hasEnchant, hasEnchants, hasLore, removeEnchant, setDisplayName, setLore
 
Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable
serialize
 

Method Detail

setEffect

void setEffect(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

FireworkEffect getEffect()
Gets the firework effect for this meta.

Returns:
the current effect, or null if none

clone

FireworkEffectMeta clone()
Specified by:
clone in interface ItemMeta


Copyright © 2014. All rights reserved.