Package net.kyori.adventure.text.format
Class NamedTextColor
java.lang.Object
net.kyori.adventure.text.format.NamedTextColor
- All Implemented Interfaces:
Comparable<TextColor>
,ComponentBuilderApplicable
,StyleBuilderApplicable
,TextColor
,TextFormat
,RGBLike
,net.kyori.examination.Examinable
public final class NamedTextColor extends Object implements TextColor
The named text colours in Minecraft: Java Edition.
- Since:
- 4.0.0
-
Field Summary
Fields Modifier and Type Field Description static NamedTextColor
AQUA
The standardaqua
colour.static NamedTextColor
BLACK
The standardblack
colour.static NamedTextColor
BLUE
The standardblue
colour.static NamedTextColor
DARK_AQUA
The standarddark_aqua
colour.static NamedTextColor
DARK_BLUE
The standarddark_blue
colour.static NamedTextColor
DARK_GRAY
The standarddark_gray
colour.static NamedTextColor
DARK_GREEN
The standarddark_green
colour.static NamedTextColor
DARK_PURPLE
The standarddark_purple
colour.static NamedTextColor
DARK_RED
The standarddark_red
colour.static NamedTextColor
GOLD
The standardgold
colour.static NamedTextColor
GRAY
The standardgray
colour.static NamedTextColor
GREEN
The standardgreen
colour.static NamedTextColor
LIGHT_PURPLE
The standardlight_purple
colour.static Index<String,NamedTextColor>
NAMES
An index of name to color.static NamedTextColor
RED
The standardred
colour.static NamedTextColor
WHITE
The standardwhite
colour.static NamedTextColor
YELLOW
The standardyellow
colour. -
Method Summary
Modifier and Type Method Description static @NonNull NamedTextColor
nearestTo(@NonNull TextColor any)
Find the named colour nearest to the provided colour.static @Nullable NamedTextColor
ofExact(int value)
Gets the named color exactly matching the provided color.@NonNull String
toString()
int
value()
The color, as an RGB value packed into an int.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.kyori.adventure.text.format.StyleBuilderApplicable
componentBuilderApply
Methods inherited from interface net.kyori.adventure.text.format.TextColor
asHexString, blue, compareTo, examinableProperties, green, red, styleApply
-
Field Details
-
BLACK
The standardblack
colour.- Since:
- 4.0.0
-
DARK_BLUE
The standarddark_blue
colour.- Since:
- 4.0.0
-
DARK_GREEN
The standarddark_green
colour.- Since:
- 4.0.0
-
DARK_AQUA
The standarddark_aqua
colour.- Since:
- 4.0.0
-
DARK_RED
The standarddark_red
colour.- Since:
- 4.0.0
-
DARK_PURPLE
The standarddark_purple
colour.- Since:
- 4.0.0
-
GOLD
The standardgold
colour.- Since:
- 4.0.0
-
GRAY
The standardgray
colour.- Since:
- 4.0.0
-
DARK_GRAY
The standarddark_gray
colour.- Since:
- 4.0.0
-
BLUE
The standardblue
colour.- Since:
- 4.0.0
-
GREEN
The standardgreen
colour.- Since:
- 4.0.0
-
AQUA
The standardaqua
colour.- Since:
- 4.0.0
-
RED
The standardred
colour.- Since:
- 4.0.0
-
LIGHT_PURPLE
The standardlight_purple
colour.- Since:
- 4.0.0
-
YELLOW
The standardyellow
colour.- Since:
- 4.0.0
-
WHITE
The standardwhite
colour.- Since:
- 4.0.0
-
NAMES
An index of name to color.- Since:
- 4.0.0
-
-
Method Details
-
ofExact
Gets the named color exactly matching the provided color.- Parameters:
value
- the color to match- Returns:
- the matched color, or null
- Since:
- 4.0.0
-
nearestTo
Find the named colour nearest to the provided colour.- Parameters:
any
- colour to match- Returns:
- nearest named colour. will always return a value
- Since:
- 4.0.0
-
value
public int value()Description copied from interface:TextColor
The color, as an RGB value packed into an int. -
toString
-