Package com.github.fierioziy.particlenativeapi.api.particle.type

Interface ParticleTypeDustColorTransition

public interface ParticleTypeDustColorTransition

Class used to represent dust particle type that needs a starting color, transition color and a size.

It provides a non-reflective color method overloads to construct ParticleType with selected colors and size.

All color methods does not validate parameters in any way.

IMPORTANT NOTE: All methods annotated with Shared annotation caches and returns exactly one and the same instance with changed state between method calls. For an independent copy of returned instances, check detachCopy methods on them.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    ParticleType
    color(float r, float g, float b, float tr, float tg, float tb, float size)
    Selects a color this particle should get and to what color it should transition on fading away.
    ParticleType
    color(int r, int g, int b, int tr, int tg, int tb, double size)
    Selects a color this particle should get and to what color it should transition on fading away.
    ParticleType
    color(org.bukkit.Color color, org.bukkit.Color transition, double size)
    Selects a color this particle should get and to what color it should transition on fading away.
    boolean
    isPresent()
    Checks if this particle is supported by this Spigot version.

  • Method Details

    • color

      ParticleType color(org.bukkit.Color color, org.bukkit.Color transition, double size)

      Selects a color this particle should get and to what color it should transition on fading away.

      Parameters are not validated in any way.

      Parameters:
      color - a Color object representing desired particle color.
      transition - a Color object representing desired color on fade.
      size - size of a particle.
      Returns:
      a valid ParticleType object with selected colors and size.

    • color

      ParticleType color(int r, int g, int b, int tr, int tg, int tb, double size)

      Selects a color this particle should get and to what color it should transition on fading away.

      Parameters are not validated in any way.

      Parameters:
      r - red color value that should be between 0 and 255.
      g - green color value that should be between 0 and 255.
      b - blue color value that should be between 0 and 255.
      tr - red fade color value that should be between 0 and 255.
      tg - green fade color value that should be between 0 and 255.
      tb - blue fade color value that should be between 0 and 255.
      size - size of a particle.
      Returns:
      a valid ParticleType object with selected colors and size.

    • color

      ParticleType color(float r, float g, float b, float tr, float tg, float tb, float size)

      Selects a color this particle should get and to what color it should transition on fading away.

      Parameters are not validated in any way.

      This method is overridden by dynamically generated subclasses.

      Parameters:
      r - red color value that should be between 0.0 and 1.0.
      g - green color value that should be between 0.0 and 1.0.
      b - blue color value that should be between 0.0 and 1.0.
      tr - red fade color value that should be between 0 and 255.
      tg - green fade color value that should be between 0 and 255.
      tb - blue fade color value that should be between 0 and 255.
      size - size of a particle.
      Returns:
      a valid ParticleType object with selected colors and size.

    • isPresent

      boolean isPresent()

      Checks if this particle is supported by this Spigot version.

      This method is overridden by dynamically generated subclasses.

      Returns:
      true if this particle is supported by this Spigot version, false otherwise.