Package org.bukkit
Class FireworkEffect.Builder
java.lang.Object
org.bukkit.FireworkEffect.Builder
- Enclosing class:
FireworkEffect
This is a builder for FireworkEffects.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Create aFireworkEffect
from the current contents of this builder.flicker
(boolean flicker) Set whether the firework effect should flicker.trail
(boolean trail) Set whether the firework effect should have a trail.with
(@NotNull FireworkEffect.Type type) Specify the type of the firework effect.Add several primary colors to the firework effect.Add a primary color to the firework effect.Add several primary colors to the firework effect.Add several fade colors to the firework effect.Add a fade color to the firework effect.Add several fade colors to the firework effect.Add a flicker to the firework effect.Add a trail to the firework effect.
-
Method Details
-
with
@NotNull public @NotNull FireworkEffect.Builder with(@NotNull @NotNull FireworkEffect.Type type) throws IllegalArgumentException Specify the type of the firework effect.- Parameters:
type
- The effect type- Returns:
- This object, for chaining
- Throws:
IllegalArgumentException
- If type is null
-
withFlicker
Add a flicker to the firework effect.- Returns:
- This object, for chaining
-
flicker
Set whether the firework effect should flicker.- Parameters:
flicker
- true if it should flicker, false if not- Returns:
- This object, for chaining
-
withTrail
Add a trail to the firework effect.- Returns:
- This object, for chaining
-
trail
Set whether the firework effect should have a trail.- Parameters:
trail
- true if it should have a trail, false for no trail- Returns:
- This object, for chaining
-
withColor
@NotNull public @NotNull FireworkEffect.Builder withColor(@NotNull @NotNull Color color) throws IllegalArgumentException Add a primary color to the firework effect.- Parameters:
color
- The color to add- Returns:
- This object, for chaining
- Throws:
IllegalArgumentException
- If color is null
-
withColor
@NotNull public @NotNull FireworkEffect.Builder withColor(@NotNull @NotNull Color... colors) throws IllegalArgumentException Add several primary colors to the firework effect.- Parameters:
colors
- The colors to add- Returns:
- This object, for chaining
- Throws:
IllegalArgumentException
- If colors is nullIllegalArgumentException
- If any color is null (may be thrown after changes have occurred)
-
withColor
@NotNull public @NotNull FireworkEffect.Builder withColor(@NotNull @NotNull Iterable<?> colors) throws IllegalArgumentException Add several primary colors to the firework effect.- Parameters:
colors
- An iterable object whose iterator yields the desired colors- Returns:
- This object, for chaining
- Throws:
IllegalArgumentException
- If colors is nullIllegalArgumentException
- If any color is null (may be thrown after changes have occurred)
-
withFade
@NotNull public @NotNull FireworkEffect.Builder withFade(@NotNull @NotNull Color color) throws IllegalArgumentException Add a fade color to the firework effect.- Parameters:
color
- The color to add- Returns:
- This object, for chaining
- Throws:
IllegalArgumentException
- If colors is nullIllegalArgumentException
- If any color is null (may be thrown after changes have occurred)
-
withFade
@NotNull public @NotNull FireworkEffect.Builder withFade(@NotNull @NotNull Color... colors) throws IllegalArgumentException Add several fade colors to the firework effect.- Parameters:
colors
- The colors to add- Returns:
- This object, for chaining
- Throws:
IllegalArgumentException
- If colors is nullIllegalArgumentException
- If any color is null (may be thrown after changes have occurred)
-
withFade
@NotNull public @NotNull FireworkEffect.Builder withFade(@NotNull @NotNull Iterable<?> colors) throws IllegalArgumentException Add several fade colors to the firework effect.- Parameters:
colors
- An iterable object whose iterator yields the desired colors- Returns:
- This object, for chaining
- Throws:
IllegalArgumentException
- If colors is nullIllegalArgumentException
- If any color is null (may be thrown after changes have occurred)
-
build
Create aFireworkEffect
from the current contents of this builder.To successfully build, you must have specified at least one color.
- Returns:
- The representative firework effect
-