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
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description @NotNull HSVLike
asHSV()
Converts the color represented by this RGBLike to the HSV color space.@NotNull Stream<? extends net.kyori.examination.ExaminableProperty>
examinableProperties()
static @Nullable NamedTextColor
namedColor(int value)
Gets the named color exactly matching the provided color.static @NotNull NamedTextColor
nearestTo(@NotNull TextColor any)
Find the named colour nearest to the provided colour.static @Nullable NamedTextColor
ofExact(int value)
Deprecated.for removal since 4.10.0, usenamedColor(int)
instead@NotNull 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, green, red, styleApply
-
-
-
-
Field Detail
-
BLACK
public static final NamedTextColor BLACK
The standardblack
colour.- Since:
- 4.0.0
-
DARK_BLUE
public static final NamedTextColor DARK_BLUE
The standarddark_blue
colour.- Since:
- 4.0.0
-
DARK_GREEN
public static final NamedTextColor DARK_GREEN
The standarddark_green
colour.- Since:
- 4.0.0
-
DARK_AQUA
public static final NamedTextColor DARK_AQUA
The standarddark_aqua
colour.- Since:
- 4.0.0
-
DARK_RED
public static final NamedTextColor DARK_RED
The standarddark_red
colour.- Since:
- 4.0.0
-
DARK_PURPLE
public static final NamedTextColor DARK_PURPLE
The standarddark_purple
colour.- Since:
- 4.0.0
-
GOLD
public static final NamedTextColor GOLD
The standardgold
colour.- Since:
- 4.0.0
-
GRAY
public static final NamedTextColor GRAY
The standardgray
colour.- Since:
- 4.0.0
-
DARK_GRAY
public static final NamedTextColor DARK_GRAY
The standarddark_gray
colour.- Since:
- 4.0.0
-
BLUE
public static final NamedTextColor BLUE
The standardblue
colour.- Since:
- 4.0.0
-
GREEN
public static final NamedTextColor GREEN
The standardgreen
colour.- Since:
- 4.0.0
-
AQUA
public static final NamedTextColor AQUA
The standardaqua
colour.- Since:
- 4.0.0
-
RED
public static final NamedTextColor RED
The standardred
colour.- Since:
- 4.0.0
-
LIGHT_PURPLE
public static final NamedTextColor LIGHT_PURPLE
The standardlight_purple
colour.- Since:
- 4.0.0
-
YELLOW
public static final NamedTextColor YELLOW
The standardyellow
colour.- Since:
- 4.0.0
-
WHITE
public static final NamedTextColor WHITE
The standardwhite
colour.- Since:
- 4.0.0
-
NAMES
public static final Index<String,NamedTextColor> NAMES
An index of name to color.- Since:
- 4.0.0
-
-
Method Detail
-
namedColor
@Nullable public static @Nullable NamedTextColor namedColor(int value)
Gets the named color exactly matching the provided color.- Parameters:
value
- the color to match- Returns:
- the matched color, or null
- Since:
- 4.10.0
-
ofExact
@Deprecated @ScheduledForRemoval(inVersion="5.0.0") @Nullable public static @Nullable NamedTextColor ofExact(int value)
Deprecated.for removal since 4.10.0, usenamedColor(int)
insteadGets 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
@NotNull public static @NotNull NamedTextColor nearestTo(@NotNull @NotNull TextColor any)
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.
-
asHSV
@NotNull public @NotNull HSVLike asHSV()
Description copied from interface:RGBLike
Converts the color represented by this RGBLike to the HSV color space.
-
examinableProperties
@NotNull public @NotNull Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()
- Specified by:
examinableProperties
in interfacenet.kyori.examination.Examinable
- Specified by:
examinableProperties
in interfaceTextColor
-
-