net.md_5.bungee.util

Class ChatComponentTransformer

java.lang.Object

net.md_5.bungee.util.ChatComponentTransformer

public final class ChatComponentTransformer
extends Object

This class transforms chat components by attempting to replace transformable fields with the appropriate value.
ScoreComponents are transformed by replacing their ScoreComponent.getName()} into the matching entity's name as well as replacing the ScoreComponent.getValue() with the matching value in the Scoreboard if and only if the ScoreComponent.getValue() is not present.

Constructor Summary

Constructors

Constructor and Description
ChatComponentTransformer()

Method Summary

Modifier and Type	Method and Description
static ChatComponentTransformer	getInstance()
boolean	isSelectorPattern(String pattern) Checks if the given string is an entity selector.
net.md_5.bungee.api.chat.BaseComponent[]	transform(ProxiedPlayer player, net.md_5.bungee.api.chat.BaseComponent... component) Transform a set of components, and attempt to transform the transformable fields.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChatComponentTransformer

public ChatComponentTransformer()

Method Detail

getInstance

public static ChatComponentTransformer getInstance()

transform

public net.md_5.bungee.api.chat.BaseComponent[] transform(ProxiedPlayer player,
                                                          net.md_5.bungee.api.chat.BaseComponent... component)

Transform a set of components, and attempt to transform the transformable fields. Entity selectors cannot be evaluated. This will recursively search for all extra components (see BaseComponent.getExtra()).

Parameters:

player - player

component - the component to transform

Returns:

the transformed component, or an array containing a single empty TextComponent if the components are null or empty

Throws:

IllegalArgumentException - if an entity selector pattern is present

isSelectorPattern

public boolean isSelectorPattern(String pattern)

Checks if the given string is an entity selector.

Parameters:

pattern - the pattern to check

Returns:

true if it is an entity selector