com.viaversion.viaversion.libs.mcstructs.text.utils

Class TextColorUtils

java.lang.Object

com.viaversion.viaversion.libs.mcstructs.text.utils.TextColorUtils

public class TextColorUtils
extends java.lang.Object

Utility class to color strings with a gradient.
RGB Colors are used which only work in Minecraft 1.16+.
If you want to translate the colors to the old format use TextUtils.replaceRGBColors(TextComponent), but keep in mind that many details will be lost.

Constructor Summary

Constructors

Constructor and Description
TextColorUtils()

Method Summary

Modifier and Type	Method and Description
static TextComponent	gradient(java.lang.String s, TextFormatting... colors) Color a string with a gradient of TextFormattings. The text color is interpolated between the given colors. If no colors are given a new StringComponent is returned. If one color is given the text will only be colored with that color.
static TextComponent	rainbow(java.lang.String s) Color a string with a rainbow gradient. The text color is interpolated between the given colors.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextColorUtils

public TextColorUtils()

Method Detail

gradient

public static TextComponent gradient(java.lang.String s,
                                     TextFormatting... colors)

Color a string with a gradient of TextFormattings.
The text color is interpolated between the given colors.
If no colors are given a new StringComponent is returned.
If one color is given the text will only be colored with that color.

Parameters:

s - The string to color

colors - The colors to use

Returns:

The colored string

rainbow

public static TextComponent rainbow(java.lang.String s)

Color a string with a rainbow gradient.
The text color is interpolated between the given colors.

Parameters:

s - The string to color

Returns:

The colored string