Module net.minestom.server

Package net.minestom.server.color

Class Color

java.lang.Object

net.minestom.server.color.Color

All Implemented Interfaces:

RGBLike

Direct Known Subclasses:

AlphaColor

public class Color
extends Object
implements RGBLike

A general purpose class for representing colors.

Colors must be in the range of 0-255.

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<RGBLike>	CODEC
static final NetworkBuffer.Type<RGBLike>	NETWORK_TYPE
static final NetworkBuffer.Type<RGBLike>	RGB_BYTE_NETWORK_TYPE
static final RGBLike	WHITE

Constructor Summary

Constructors

Constructor	Description
Color(int rgb)	Creates a color from an integer.
Color(int red, int green, int blue)
Color(RGBLike rgbLike)	Creates a color from an RGB-like color.

Method Summary

Modifier and Type	Method	Description
int	asRGB()	Gets the color as an RGB integer.
int	blue()
boolean	equals(Object obj)
static Color	fromRGBLike(RGBLike rgbLike)
int	getBlue()	Deprecated.
int	getGreen()	Deprecated.
int	getRed()	Deprecated.
int	green()
int	hashCode()
Color	mixWith(RGBLike... colors)	Mixes this color with a series of other colors, as if they were combined in a crafting table.
int	red()
String	toString()
AlphaColor	withAlpha(int alpha)
Color	withBlue(int blue)
Color	withGreen(int green)
Color	withRed(int red)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.kyori.adventure.util.RGBLike

asHSV

Field Details

NETWORK_TYPE

public static final NetworkBuffer.Type<RGBLike> NETWORK_TYPE

RGB_BYTE_NETWORK_TYPE

public static final NetworkBuffer.Type<RGBLike> RGB_BYTE_NETWORK_TYPE

CODEC

public static final Codec<RGBLike> CODEC

WHITE

public static final RGBLike WHITE

Constructor Details

Color

public Color(int red,
 int green,
 int blue)

Color

public Color(int rgb)

Creates a color from an integer. This is done by reading each color component from the lowest order 24 bits of the integer, and creating a color from those components.

Parameters:

rgb - the integer

Color

public Color(RGBLike rgbLike)

Creates a color from an RGB-like color.

Parameters:

rgbLike - the color

Method Details

fromRGBLike

public static Color fromRGBLike(RGBLike rgbLike)

withRed

public Color withRed(int red)

withGreen

public Color withGreen(int green)

withBlue

public Color withBlue(int blue)

withAlpha

public AlphaColor withAlpha(int alpha)

asRGB

public int asRGB()

Gets the color as an RGB integer.

Returns:

An integer representation of this color, as 0xRRGGBB

mixWith

public Color mixWith(RGBLike... colors)

Mixes this color with a series of other colors, as if they were combined in a crafting table. This function works out the average of each RGB component and then multiplies the components by a scale factor that is calculated from the average of all maximum values divided by the maximum of each average value. This is how Minecraft mixes colors.

Parameters:

colors - the colors

getRed

@Deprecated
public int getRed()

Deprecated.

getGreen

@Deprecated
public int getGreen()

Deprecated.

getBlue

@Deprecated
public int getBlue()

Deprecated.

red

public int red()

Specified by:

red in interface RGBLike

green

public int green()

Specified by:

green in interface RGBLike

blue

public int blue()

Specified by:

blue in interface RGBLike

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object