程序包 org.bukkit

# 类 FireworkEffect.Builder

java.lang.Object
org.bukkit.FireworkEffect.Builder

封闭类:
  FireworkEffect

public static final class FireworkEffect.Builder extends Object
这是一个烟花效果的生成器。

原文： This is a builder for FireworkEffects.

另请参阅:
  - `FireworkEffect.builder()`

- ## 方法概要

  修饰符和类型
  方法
  说明
  `@NotNull FireworkEffect`
  `build()`
  根据这个生成器的当前内容创建一个`FireworkEffect`。
  `@NotNull FireworkEffect.Builder`
  `flicker(boolean flicker)`
  设置烟花是否具有闪烁效果。
  `@NotNull FireworkEffect.Builder`
  `trail(boolean trail)`
  设置烟花是否有尾迹效果。
  `@NotNull FireworkEffect.Builder`
  `with(@NotNull FireworkEffect.Type type)`
  指定烟花效果的类型。
  `@NotNull FireworkEffect.Builder`
  `withColor(@NotNull Iterable<?> colors)`
  向烟花效果添加几种主颜色。
  `@NotNull FireworkEffect.Builder`
  `withColor(@NotNull Color color)`
  向烟花效果添加一种主颜色。
  `@NotNull FireworkEffect.Builder`
  `withColor(@NotNull Color... colors)`
  向烟花效果添加几种主颜色。
  `@NotNull FireworkEffect.Builder`
  `withFade(@NotNull Iterable<?> colors)`
  向烟花效果添加几种淡出颜色。
  `@NotNull FireworkEffect.Builder`
  `withFade(@NotNull Color color)`
  向烟花效果添加一种淡出颜色。
  `@NotNull FireworkEffect.Builder`
  `withFade(@NotNull Color... colors)`
  向烟花效果添加几种淡出颜色。
  `@NotNull FireworkEffect.Builder`
  `withFlicker()`
  向烟花添加一个闪烁效果。
  `@NotNull FireworkEffect.Builder`
  `withTrail()`
  向烟花添加一个尾迹效果。

  ### 从类继承的方法 java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## 方法详细资料

  - ### with

    @NotNull public @NotNull FireworkEffect.Builder with(@NotNull @NotNull FireworkEffect.Type type) throws IllegalArgumentException
    指定烟花效果的类型。

    原文： Specify the type of the firework effect.

    参数:
      `type` - 效果类型
    返回:
      用于链接的对象
    抛出:
      `IllegalArgumentException` - 如果类型为空则抛出错误

  - ### withFlicker

    @NotNull public @NotNull FireworkEffect.Builder withFlicker()
    向烟花添加一个闪烁效果。

    原文： Add a flicker to the firework effect.

    返回:
      用于链接的对象

  - ### flicker

    @NotNull public @NotNull FireworkEffect.Builder flicker(boolean flicker)
    设置烟花是否具有闪烁效果。

    原文： Set whether the firework effect should flicker.

    参数:
      `flicker` - 具有闪烁效果为true，否则为false
    返回:
      用于链接的对象

  - ### withTrail

    @NotNull public @NotNull FireworkEffect.Builder withTrail()
    向烟花添加一个尾迹效果。

    原文： Add a trail to the firework effect.

    返回:
      用于链接的对象

  - ### trail

    @NotNull public @NotNull FireworkEffect.Builder trail(boolean trail)
    设置烟花是否有尾迹效果。

    原文： Set whether the firework effect should have a trail.

    参数:
      `trail` - 如果具有尾迹效果则返回true，否则返回false
    返回:
      用于链接的对象

  - ### withColor

    @NotNull public @NotNull FireworkEffect.Builder withColor(@NotNull @NotNull Color color) throws IllegalArgumentException
    向烟花效果添加一种主颜色。

    原文： Add a primary color to the firework effect.

    参数:
      `color` - 添加的颜色
    返回:
      用于链接的对象
    抛出:
      `IllegalArgumentException` - 如果颜色为空则抛出错误

  - ### withColor

    @NotNull public @NotNull FireworkEffect.Builder withColor(@NotNull @NotNull Color... colors) throws IllegalArgumentException
    向烟花效果添加几种主颜色。

    原文： Add several primary colors to the firework effect.

    参数:
      `colors` - 添加的颜色
    返回:
      用于链接的对象
    抛出:
      `IllegalArgumentException` - 如果颜色为空则抛出错误
      `IllegalArgumentException` - 如果任一颜色为空则抛出错误（可能在改变生效后抛出）

  - ### withColor

    @NotNull public @NotNull FireworkEffect.Builder withColor(@NotNull @NotNull Iterable<?> colors) throws IllegalArgumentException
    向烟花效果添加几种主颜色。

    原文： Add several primary colors to the firework effect.

    参数:
      `colors` - 一个可迭代的对象，其迭代器可产生所需的颜色。
    返回:
      用于链接的对象
    抛出:
      `IllegalArgumentException` - 如果颜色为空则抛出错误
      `IllegalArgumentException` - 如果任一颜色为空则抛出错误（可能在改变生效后抛出）

  - ### withFade

    @NotNull public @NotNull FireworkEffect.Builder withFade(@NotNull @NotNull Color color) throws IllegalArgumentException
    向烟花效果添加一种淡出颜色。

    原文： Add a fade color to the firework effect.

    参数:
      `color` - 添加的颜色
    返回:
      用于链接的对象
    抛出:
      `IllegalArgumentException` - 如果颜色为空则抛出错误
      `IllegalArgumentException` - 如果任一颜色为空则抛出错误（可能在改变生效后抛出）

  - ### withFade

    @NotNull public @NotNull FireworkEffect.Builder withFade(@NotNull @NotNull Color... colors) throws IllegalArgumentException
    向烟花效果添加几种淡出颜色。

    原文： Add several fade colors to the firework effect.

    参数:
      `colors` - 添加的颜色
    返回:
      用于链接的对象
    抛出:
      `IllegalArgumentException` - 如果颜色为空则抛出错误
      `IllegalArgumentException` - 如果任一颜色为空则抛出错误（可能在改变生效后抛出）

  - ### withFade

    @NotNull public @NotNull FireworkEffect.Builder withFade(@NotNull @NotNull Iterable<?> colors) throws IllegalArgumentException
    向烟花效果添加几种淡出颜色。

    原文： Add several fade colors to the firework effect.

    参数:
      `colors` - 一个可迭代的对象，其迭代器可产生所需的颜色。
    返回:
      用于链接的对象
    抛出:
      `IllegalArgumentException` - 如果颜色为空则抛出错误
      `IllegalArgumentException` - 如果任一颜色为空则抛出错误（可能在改变生效后抛出）

  - ### build

    @NotNull public @NotNull FireworkEffect build()
    根据这个生成器的当前内容创建一个`FireworkEffect`。

    成功生成需要指定至少一种颜色。

    原文： Create a `FireworkEffect` from the current contents of this builder.

    To successfully build, you must have specified at least one color.

    返回:
      烟花效果模板