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 Details

    • trail

      FireworkEffect.Builder trail(boolean trail)
      Sets whether the FireworkEffect is going to have a trail or not.
      Parameters:
      trail - Whether the firework will have a trail
      Returns:
      This builder, for chaining

    • flicker

      FireworkEffect.Builder flicker(boolean flicker)
      Sets whether the FireworkEffect is going to flicker on explosion.
      Parameters:
      flicker - Whether the explosion will flicker
      Returns:
      This builder, for chaining

    • color

      FireworkEffect.Builder color(Color color)
      Adds the given Color 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

      FireworkEffect.Builder colors(Color... colors)
      Adds the given Colors 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

      FireworkEffect.Builder colors(Iterable<Color> colors)
      Adds the given Colors 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

      FireworkEffect.Builder fade(Color color)
      Adds the given Color 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

      FireworkEffect.Builder fades(Color... colors)
      Adds the given Colors 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

      FireworkEffect.Builder fades(Iterable<Color> colors)
      Adds the given Colors 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

      FireworkEffect.Builder shape(FireworkShape shape)
      Sets the shape of the FireworkEffect explosion.
      Parameters:
      shape - The shape of the explosion
      Returns:
      This builder, for chaining

    • shape

      default FireworkEffect.Builder shape(Supplier<? extends FireworkShape> shape)
      Sets the shape of the FireworkEffect explosion.
      Parameters:
      shape - The shape of the explosion
      Returns:
      This builder, for chaining

    • build

      FireworkEffect build()
      Builds a FireworkEffect based on the current state of this builder.
      Specified by:
      build in interface AbstractBuilder<FireworkEffect>
      Returns:
      A newly created firework effect