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

Public Member Functions

void addEffect (FireworkEffect effect) throws IllegalArgumentException
 
void addEffects (FireworkEffect...effects) throws IllegalArgumentException
 
void addEffects (Iterable< FireworkEffect > effects) throws IllegalArgumentException
 
List< FireworkEffectgetEffects ()
 
int getEffectsSize ()
 
void removeEffect (int index) throws IndexOutOfBoundsException
 
void clearEffects ()
 
boolean hasEffects ()
 
int getPower ()
 
void setPower (int power) throws IllegalArgumentException
 
FireworkMeta 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 Material#FIREWORK and its effects.

Definition at line 11 of file FireworkMeta.java.

Member Function Documentation

void org.bukkit.inventory.meta.FireworkMeta.addEffect ( FireworkEffect  effect) throws IllegalArgumentException

Add another effect to this firework.

Parameters
effectThe firework effect to add
Exceptions
IllegalArgumentExceptionIf effect is null
void org.bukkit.inventory.meta.FireworkMeta.addEffects ( FireworkEffect...  effects) throws IllegalArgumentException

Add several effects to this firework.

Parameters
effectsThe firework effects to add
Exceptions
IllegalArgumentExceptionIf effects is null
IllegalArgumentExceptionIf any effect is null (may be thrown after changes have occurred)
void org.bukkit.inventory.meta.FireworkMeta.addEffects ( Iterable< FireworkEffect effects) throws IllegalArgumentException

Add several firework effects to this firework.

Parameters
effectsAn iterable object whose iterator yields the desired firework effects
Exceptions
IllegalArgumentExceptionIf effects is null
IllegalArgumentExceptionIf any effect is null (may be thrown after changes have occurred)
void org.bukkit.inventory.meta.FireworkMeta.clearEffects ( )

Remove all effects from this firework.

List<FireworkEffect> org.bukkit.inventory.meta.FireworkMeta.getEffects ( )

Get the effects in this firework.

Returns
An immutable list of the firework effects
int org.bukkit.inventory.meta.FireworkMeta.getEffectsSize ( )

Get the number of effects in this firework.

Returns
The number of effects
int org.bukkit.inventory.meta.FireworkMeta.getPower ( )

Gets the approximate height the firework will fly.

Returns
approximate flight height of the firework.
boolean org.bukkit.inventory.meta.FireworkMeta.hasEffects ( )

Get whether this firework has any effects.

Returns
true if it has effects, false if there are no effects
void org.bukkit.inventory.meta.FireworkMeta.removeEffect ( int  index) throws IndexOutOfBoundsException

Remove an effect from this firework.

Parameters
indexThe index of the effect to remove
Exceptions
IndexOutOfBoundsExceptionIf index < 0 or index > getEffectsSize()
void org.bukkit.inventory.meta.FireworkMeta.setPower ( int  power) throws IllegalArgumentException

Sets the approximate power of the firework. Each level of power is half a second of flight time.

Parameters
powerthe power of the firework, from 0-128
Exceptions
IllegalArgumentExceptionif height<0 or height>128

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