api/org.kryptonmc.api.util/Color

Color

class Color : Record, RGBLike

A standard colour in RGB format, with a red, green, and blue component.

Parameters

red

the red component

green

the green component

blue

the blue component

Constructors

Color

constructor(red: Int, green: Int, blue: Int)

constructor(value: Int)

Creates a new colour from the given encoded RGB value.

Functions

asHSV

open fun asHSV(): @NotNull HSVLike

blue

abstract fun blue(): Int

encode

open fun encode(): Int

Gets this colour in encoded RGB form.

equals

abstract fun equals(p: Any): Boolean

fromHsv

@NotNull

open fun fromHsv(@NotNull hsv: @NotNull HSVLike): @NotNull Color

Creates a new colour from the given hsv colour.

@NotNull

open fun fromHsv(hue: Float, saturation: Float, value: Float): @NotNull Color

Creates a new colour from the given hue, saturation, and value components.

green

abstract fun green(): Int

hashCode

abstract fun hashCode(): Int

red

abstract fun red(): Int

toString

abstract fun toString(): String

withBlue

@NotNull

open fun withBlue(blue: Int): @NotNull Color

Creates a new colour with the given new [blue] value.

withGreen

@NotNull

open fun withGreen(green: Int): @NotNull Color

Creates a new colour with the given new [green] value.

withRed

@NotNull

open fun withRed(red: Int): @NotNull Color

Creates a new colour with the given new [red] value.

Properties

BLACK

@NotNull

val BLACK: @NotNull Color

BLUE

@NotNull

val BLUE: @NotNull Color

CYAN

@NotNull

val CYAN: @NotNull Color

GRAY

@NotNull

val GRAY: @NotNull Color

GREEN

@NotNull

val GREEN: @NotNull Color

MAGENTA

@NotNull

val MAGENTA: @NotNull Color

RED

@NotNull

val RED: @NotNull Color

WHITE

@NotNull

val WHITE: @NotNull Color

YELLOW

@NotNull

val YELLOW: @NotNull Color