Class Color

java.lang.Object
org.bukkit.Color
All Implemented Interfaces:
ARGBLike, RGBLike, ConfigurationSerializable
public final class Color extends Object implements ConfigurationSerializable, ARGBLike
A container for a color palette. This class is immutable; the set methods return a new color. The color names listed as fields are HTML4 standards, but subject to change.

  • Field Details

    • WHITE

      public static final Color WHITE
      White, or (0xFF,0xFF,0xFF) in (R,G,B)

    • SILVER

      public static final Color SILVER
      Silver, or (0xC0,0xC0,0xC0) in (R,G,B)

    • GRAY

      public static final Color GRAY
      Gray, or (0x80,0x80,0x80) in (R,G,B)

    • BLACK

      public static final Color BLACK
      Black, or (0x00,0x00,0x00) in (R,G,B)

    • RED

      public static final Color RED
      Red, or (0xFF,0x00,0x00) in (R,G,B)

    • MAROON

      public static final Color MAROON
      Maroon, or (0x80,0x00,0x00) in (R,G,B)

    • YELLOW

      public static final Color YELLOW
      Yellow, or (0xFF,0xFF,0x00) in (R,G,B)

    • OLIVE

      public static final Color OLIVE
      Olive, or (0x80,0x80,0x00) in (R,G,B)

    • LIME

      public static final Color LIME
      Lime, or (0x00,0xFF,0x00) in (R,G,B)

    • GREEN

      public static final Color GREEN
      Green, or (0x00,0x80,0x00) in (R,G,B)

    • AQUA

      public static final Color AQUA
      Aqua, or (0x00,0xFF,0xFF) in (R,G,B)

    • TEAL

      public static final Color TEAL
      Teal, or (0x00,0x80,0x80) in (R,G,B)

    • BLUE

      public static final Color BLUE
      Blue, or (0x00,0x00,0xFF) in (R,G,B)

    • FUCHSIA

      public static final Color FUCHSIA
      Fuchsia, or (0xFF,0x00,0xFF) in (R,G,B)

    • PURPLE

      public static final Color PURPLE
      Purple, or (0x80,0x00,0x80) in (R,G,B)

    • ORANGE

      public static final Color ORANGE
      Orange, or (0xFF,0xA5,0x00) in (R,G,B)

  • Method Details

    • fromARGB

      @NotNull public static @NotNull Color fromARGB(@Range(from=0L,to=255L) int alpha, @Range(from=0L,to=255L) int red, @Range(from=0L,to=255L) int green, @Range(from=0L,to=255L) int blue) throws IllegalArgumentException
      Creates a new Color object from an alpha, red, green, and blue
      Parameters:
      alpha - integer from 0-255
      red - integer from 0-255
      green - integer from 0-255
      blue - integer from 0-255
      Returns:
      a new Color object for the alpha, red, green, blue
      Throws:
      IllegalArgumentException - if any value is strictly >255 or <0

    • fromRGB

      @NotNull public static @NotNull Color fromRGB(@Range(from=0L,to=255L) int red, @Range(from=0L,to=255L) int green, @Range(from=0L,to=255L) int blue) throws IllegalArgumentException
      Creates a new Color object from a red, green, and blue
      Parameters:
      red - integer from 0-255
      green - integer from 0-255
      blue - integer from 0-255
      Returns:
      a new Color object for the red, green, blue
      Throws:
      IllegalArgumentException - if any value is strictly >255 or <0

    • fromBGR

      @NotNull public static @NotNull Color fromBGR(@Range(from=0L,to=255L) int blue, @Range(from=0L,to=255L) int green, @Range(from=0L,to=255L) int red) throws IllegalArgumentException
      Creates a new Color object from a blue, green, and red
      Parameters:
      blue - integer from 0-255
      green - integer from 0-255
      red - integer from 0-255
      Returns:
      a new Color object for the blue, green, red
      Throws:
      IllegalArgumentException - if any value is strictly >255 or <0

    • fromRGB

      @NotNull public static @NotNull Color fromRGB(int rgb) throws IllegalArgumentException
      Creates a new color object from an integer that contains the red, green, and blue bytes in the lowest order 24 bits.
      Parameters:
      rgb - the integer storing the red, green, and blue values
      Returns:
      a new color object for specified values
      Throws:
      IllegalArgumentException - if any data is in the highest order 8 bits

    • fromARGB

      @NotNull public static @NotNull Color fromARGB(int argb)
      Creates a new color object from an integer that contains the alpha, red, green, and blue bytes.
      Parameters:
      argb - the integer storing the alpha, red, green, and blue values
      Returns:
      a new color object for specified values

    • fromBGR

      @NotNull public static @NotNull Color fromBGR(int bgr) throws IllegalArgumentException
      Creates a new color object from an integer that contains the blue, green, and red bytes in the lowest order 24 bits.
      Parameters:
      bgr - the integer storing the blue, green, and red values
      Returns:
      a new color object for specified values
      Throws:
      IllegalArgumentException - if any data is in the highest order 8 bits

    • getAlpha

      public @Range(from=0L,to=255L) int getAlpha()
      Gets the alpha component.
      Returns:
      alpha component, from 0 to 255

    • alpha

      public @Range(from=0L,to=255L) int alpha()
      Gets the alpha component.
      Specified by:
      alpha in interface ARGBLike
      Returns:
      alpha component, from 0 to 255

    • setAlpha

      @NotNull public @NotNull Color setAlpha(@Range(from=0L,to=255L) int alpha)
      Creates a new Color object with a specified component.
      Parameters:
      alpha - the alpha component, from 0 to 255
      Returns:
      a new color object with the alpha component

    • getRed

      public @Range(from=0L,to=255L) int getRed()
      Gets the red component.
      Returns:
      red component, from 0 to 255

    • red

      public @Range(from=0L,to=255L) int red()
      Gets the red component.
      Specified by:
      red in interface RGBLike
      Returns:
      red component, from 0 to 255

    • setRed

      @NotNull public @NotNull Color setRed(@Range(from=0L,to=255L) int red)
      Creates a new Color object with a specified component.
      Parameters:
      red - the red component, from 0 to 255
      Returns:
      a new color object with the red component

    • getGreen

      public @Range(from=0L,to=255L) int getGreen()
      Gets the green component.
      Returns:
      green component, from 0 to 255

    • green

      public @Range(from=0L,to=255L) int green()
      Gets the green component.
      Specified by:
      green in interface RGBLike
      Returns:
      green component, from 0 to 255

    • setGreen

      @NotNull public @NotNull Color setGreen(@Range(from=0L,to=255L) int green)
      Creates a new Color object with a specified component.
      Parameters:
      green - the green component, from 0 to 255
      Returns:
      a new color object with the green component

    • getBlue

      public @Range(from=0L,to=255L) int getBlue()
      Gets the blue component.
      Returns:
      blue component, from 0 to 255

    • blue

      public @Range(from=0L,to=255L) int blue()
      Gets the blue component.
      Specified by:
      blue in interface RGBLike
      Returns:
      blue component, from 0 to 255

    • setBlue

      @NotNull public @NotNull Color setBlue(@Range(from=0L,to=255L) int blue)
      Creates a new Color object with a specified component.
      Parameters:
      blue - the blue component, from 0 to 255
      Returns:
      a new color object with the blue component

    • asRGB

      public int asRGB()
      Gets the color as an RGB integer.
      Returns:
      An integer representation of this color, as 0xRRGGBB

    • asARGB

      public int asARGB()
      Gets the color as an ARGB integer.
      Returns:
      An integer representation of this color, as 0xAARRGGBB

    • asBGR

      public int asBGR()
      Gets the color as an BGR integer.
      Returns:
      An integer representation of this color, as 0xBBGGRR

    • mixDyes

      @NotNull public @NotNull Color mixDyes(@NotNull @NotNull DyeColor... colors)
      Creates a new color with its RGB components changed as if it was dyed with the colors passed in, replicating vanilla workbench dyeing.
      Parameters:
      colors - The DyeColors to dye with
      Returns:
      A new color with the changed rgb components

    • mixColors

      @NotNull public @NotNull Color mixColors(@NotNull @NotNull Color... colors)
      Creates a new color with its RGB components changed as if it was dyed with the colors passed in, replicating vanilla workbench dyeing.
      Note that this method does not currently take into account alpha components.
      Parameters:
      colors - The colors to dye with
      Returns:
      A new color with the changed rgb components

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • serialize

      @NotNull public @NotNull Map<String,Object> serialize()
      Description copied from interface: ConfigurationSerializable
      Creates a Map representation of this class.

      This class must provide a method to restore this class, as defined in the ConfigurationSerializable interface javadocs. nb: It is not intended for this method to be called directly, this will be called by the ConfigurationSerialization class.

      Specified by:
      serialize in interface ConfigurationSerializable
      Returns:
      Map containing the current state of this class

    • deserialize

      @NotNull public static @NotNull Color deserialize(@NotNull @NotNull Map<String,Object> map)

    • toString

      public String toString()
      Overrides:
      toString in class Object