Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.inventory.meta.FireworkEffectMeta Interface Reference
Inheritance diagram for org.bukkit.inventory.meta.FireworkEffectMeta:
org.bukkit.inventory.meta.ItemMeta org.bukkit.configuration.serialization.ConfigurationSerializable

Public Member Functions

void setEffect (FireworkEffect effect)
 
boolean hasEffect ()
 
FireworkEffect getEffect ()
 
FireworkEffectMeta clone ()
 
- Public Member Functions inherited from org.bukkit.inventory.meta.ItemMeta
boolean hasDisplayName ()
 
String getDisplayName ()
 
void setDisplayName (String name)
 
boolean hasLore ()
 
List< String > getLore ()
 
void setLore (List< String > lore)
 
boolean hasEnchants ()
 
boolean hasEnchant (Enchantment ench)
 
int getEnchantLevel (Enchantment ench)
 
Map< Enchantment, Integer > getEnchants ()
 
boolean addEnchant (Enchantment ench, int level, boolean ignoreLevelRestriction)
 
boolean removeEnchant (Enchantment ench)
 
boolean hasConflictingEnchant (Enchantment ench)
 
- Public Member Functions inherited from org.bukkit.configuration.serialization.ConfigurationSerializable
Map< String, Object > serialize ()
 

Detailed Description

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

Definition at line 10 of file FireworkEffectMeta.java.

Member Function Documentation

FireworkEffect org.bukkit.inventory.meta.FireworkEffectMeta.getEffect ( )

Gets the firework effect for this meta.

Returns
the current effect, or null if none
boolean org.bukkit.inventory.meta.FireworkEffectMeta.hasEffect ( )

Checks if this meta has an effect.

Returns
true if this meta has an effect, false otherwise
void org.bukkit.inventory.meta.FireworkEffectMeta.setEffect ( FireworkEffect  effect)

Sets the firework effect for this meta.

Parameters
effectthe effect to set, or null to indicate none.

The documentation for this interface was generated from the following file: