Package org.spongepowered.api.item
Interface FireworkEffect.Builder
- All Superinterfaces:
AbstractBuilder<FireworkEffect>
,Builder<FireworkEffect,
,FireworkEffect.Builder> CopyableBuilder<FireworkEffect,
,FireworkEffect.Builder> ResettableBuilder<FireworkEffect,
FireworkEffect.Builder>
- Enclosing interface:
FireworkEffect
public static interface FireworkEffect.Builder
extends Builder<FireworkEffect,FireworkEffect.Builder>, CopyableBuilder<FireworkEffect,FireworkEffect.Builder>
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aFireworkEffect
based on the current state of this builder.Adds the givenColor
to the initial explosion colors.Adds the givenColor
s to the initial explosion colors.Adds the givenColor
s to the initial explosion colors.Adds the givenColor
to the fade colors.Adds the givenColor
s to the fade colors.Adds the givenColor
s to the fade colors.flicker
(boolean flicker) Sets whether theFireworkEffect
is going to flicker on explosion.default FireworkEffect.Builder
shape
(Supplier<? extends FireworkShape> shape) Sets the shape of theFireworkEffect
explosion.shape
(FireworkShape shape) Sets the shape of theFireworkEffect
explosion.trail
(boolean trail) Sets whether theFireworkEffect
is going to have a trail or not.Methods inherited from interface org.spongepowered.api.util.CopyableBuilder
from
-
Method Details
-
trail
Sets whether theFireworkEffect
is going to have a trail or not.- Parameters:
trail
- Whether the firework will have a trail- Returns:
- This builder, for chaining
-
flicker
Sets whether theFireworkEffect
is going to flicker on explosion.- Parameters:
flicker
- Whether the explosion will flicker- Returns:
- This builder, for chaining
-
color
Adds the givenColor
to the initial explosion colors.Colors can be mixed and matched in the order they are added in.
- Parameters:
color
- The color to add to the explosion- Returns:
- This builder, for chaining
-
colors
Adds the givenColor
s to the initial explosion colors.Colors can be mixed and matched in the order they are added in.
- Parameters:
colors
- The colors to add to the explosion- Returns:
- This builder, for chaining
-
colors
Adds the givenColor
s to the initial explosion colors.Colors can be mixed and matched in the order they are added in.
- Parameters:
colors
- The colors to add to the explosion- Returns:
- This builder, for chaining
-
fade
Adds the givenColor
to the fade colors.Colors can be mixed and matched in the order they are added in.
- Parameters:
color
- The colors to add to the fade- Returns:
- This builder, for chaining
-
fades
Adds the givenColor
s to the fade colors.Colors can be mixed and matched in the order they are added in.
- Parameters:
colors
- The colors to add to the fade- Returns:
- This builder, for chaining
-
fades
Adds the givenColor
s to the fade colors.Colors can be mixed and matched in the order they are added in.
- Parameters:
colors
- The colors to add to the fade- Returns:
- This builder, for chaining
-
shape
Sets the shape of theFireworkEffect
explosion.- Parameters:
shape
- The shape of the explosion- Returns:
- This builder, for chaining
-
shape
Sets the shape of theFireworkEffect
explosion.- Parameters:
shape
- The shape of the explosion- Returns:
- This builder, for chaining
-
build
FireworkEffect build()Builds aFireworkEffect
based on the current state of this builder.- Specified by:
build
in interfaceAbstractBuilder<FireworkEffect>
- Returns:
- A newly created firework effect
-