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

Class TextUtils

java.lang.Object

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

public class TextUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TextUtils()

Method Summary

Modifier and Type	Method and Description
static void	iterateAll(TextComponent component, java.util.function.Consumer<TextComponent> consumer) Iterate over all siblings of the given component. This includes all arguments of translation components.
static TextComponent	join(TextComponent separator, TextComponent... components) Join the given components with the given separator. All components are copied before they are joined. If there are no components an empty StringComponent will be returned. If there is only one component it will be copied and returned.
static TextComponent	makeURLsClickable(TextComponent component) Make URLs in the given text component clickable. The lenient parser is used by default, be aware that this can cause exceptions if the URL is not a valid URI.
static TextComponent	makeURLsClickable(TextComponent component, boolean lenient) Make URLs in the given text component clickable.
static TextComponent	replace(TextComponent component, java.util.function.Function<TextComponent,TextComponent> replaceFunction) Replace components in the given component and all siblings with the given function. This includes all arguments of translation components.
static TextComponent	replace(TextComponent component, java.lang.String searchRegex, java.util.function.Function<TextComponent,TextComponent> replaceFunction) Replace all matches of the given pattern in this component and all siblings. This only works for StringComponent components.
static TextComponent	replaceRGBColors(TextComponent component) Replace all rgb color codes with the nearest formatting color. This can not perfectly convert the colors since there is only a limited amount of formatting colors. Minecraft 1.16 has added support for rgb colors which older versions can't display.
static void	setTranslator(TextComponent component, Translator translator) Recursively set the translator for all translation and keybind components in the given component. This includes all arguments of translation components.
static void	setTranslator(TextComponent component, Translator textTranslator, Translator keyTranslator) Recursively set the translators for all translation and keybind components in the given component. This includes all arguments of translation components.
static TextComponent[]	split(TextComponent component, java.lang.String split, boolean resolveTranslations) Split the given component by the given split string. An array of components will be returned where each component is a part. This method behaves like string.split(split, -1) without regex. The original component will not be modified.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextUtils

public TextUtils()

Method Detail

makeURLsClickable

public static TextComponent makeURLsClickable(TextComponent component)

Make URLs in the given text component clickable.
The lenient parser is used by default, be aware that this can cause exceptions if the URL is not a valid URI. If you are using Minecraft 1.21.5 or newer, it is recommended to use makeURLsClickable(TextComponent, boolean) with lenient set to false to avoid potential exceptions.

Parameters:

component - The component to make clickable

Returns:

The component with clickable URLs

makeURLsClickable

public static TextComponent makeURLsClickable(TextComponent component,
                                              boolean lenient)

Make URLs in the given text component clickable.

Parameters:

component - The component to make clickable

lenient - If true, the URL will be used as is. Minecraft 1.21.5+ started parsing the URL as URI, the serializer can throw an exception if an invalid URI is entered. If false, the URL will be parsed as a URI and ignored if it is invalid. This is the recommended option for Minecraft 1.21.5+.

Returns:

The component with clickable URLs

replace

public static TextComponent replace(TextComponent component,
                                    java.util.function.Function<TextComponent,TextComponent> replaceFunction)

Replace components in the given component and all siblings with the given function.
This includes all arguments of translation components.

Parameters:

component - The component to replace in

replaceFunction - The function that will be called for every component

Returns:

A new component with the replaced components

replace

public static TextComponent replace(TextComponent component,
                                    java.lang.String searchRegex,
                                    java.util.function.Function<TextComponent,TextComponent> replaceFunction)

Replace all matches of the given pattern in this component and all siblings.
This only works for StringComponent components.

Parameters:

component - The component to replace in

searchRegex - The regex to search for

replaceFunction - The function that will be called for every match

Returns:

A new component with the replaced text

replaceRGBColors

public static TextComponent replaceRGBColors(TextComponent component)

Replace all rgb color codes with the nearest formatting color.
This can not perfectly convert the colors since there is only a limited amount of formatting colors.
Minecraft 1.16 has added support for rgb colors which older versions can't display.

Parameters:

component - The component to replace in

Returns:

A new component with the replaced text

join

public static TextComponent join(TextComponent separator,
                                 TextComponent... components)

Join the given components with the given separator.
All components are copied before they are joined.
If there are no components an empty StringComponent will be returned.
If there is only one component it will be copied and returned.

Parameters:

separator - The separator

components - The components

Returns:

The joined component

iterateAll

public static void iterateAll(TextComponent component,
                              java.util.function.Consumer<TextComponent> consumer)

Iterate over all siblings of the given component.
This includes all arguments of translation components.

Parameters:

component - The component to iterate over

consumer - The consumer that will be called for every component

See Also:

TextComponent.forEach(Consumer)

setTranslator

public static void setTranslator(TextComponent component,
                                 @Nullable
                                 Translator translator)

Recursively set the translator for all translation and keybind components in the given component.
This includes all arguments of translation components.

Parameters:

component - The component to set the translator for

translator - The translator function

setTranslator

public static void setTranslator(TextComponent component,
                                 @Nullable
                                 Translator textTranslator,
                                 @Nullable
                                 Translator keyTranslator)

Recursively set the translators for all translation and keybind components in the given component.
This includes all arguments of translation components.

Parameters:

component - The component to set the translators for

textTranslator - The translator function for text components

keyTranslator - The translator function for keybind components

split

public static TextComponent[] split(TextComponent component,
                                    java.lang.String split,
                                    boolean resolveTranslations)

Split the given component by the given split string.
An array of components will be returned where each component is a part.
This method behaves like string.split(split, -1) without regex.
The original component will not be modified.

Parameters:

component - The component to split

split - The split string

resolveTranslations - If translations should be resolved before splitting

Returns:

An array of components