SpigotMC-Mirrors/PlaceholderAPI
1
0
Fork 0
mirror of https://github.com/PlaceholderAPI/PlaceholderAPI synced 2024-11-18 00:46:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add missing setPlaceholder methods (#234)

Browse Source 
* Add missing setPlaceholder methods
Also includes setBracketPlaceholders and setRelationPlaceholders

* Update PlaceholderAPI.java
This commit is contained in:
Andre_601 2020-04-09 17:37:06 +02:00 committed by GitHub
parent d706469ed8
commit 2caf5f0232
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 263 additions and 149 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

274
src/main/java/me/clip/placeholderapi/PlaceholderAPI.java
View File

@ -50,9 +50,9 @@ public class PlaceholderAPI {
} }
/** /**
* check if a specific placeholder identifier is currently registered * Check if a specific placeholder identifier is currently registered
* *
* @param identifier to check * @param identifier The identifier to check
* @return true if identifier is already registered * @return true if identifier is already registered
*/ */
public static boolean isRegistered(String identifier) { public static boolean isRegistered(String identifier) {
@ -64,7 +64,7 @@ public class PlaceholderAPI {
* Register a new placeholder hook * Register a new placeholder hook
* *
* @param identifier Identifier of the placeholder -> "%(identifier)_(args...)% * @param identifier Identifier of the placeholder -> "%(identifier)_(args...)%
* @param placeholderHook implementing class that contains the onPlaceholderRequest method which * @param placeholderHook Implementing class that contains the onPlaceholderRequest method which
* is called when a value is needed for the specific placeholder * is called when a value is needed for the specific placeholder
* @return true if the hook was successfully registered, false if there is already a hook * @return true if the hook was successfully registered, false if there is already a hook
* registered for the specified identifier * registered for the specified identifier
@ -83,9 +83,9 @@ public class PlaceholderAPI {
} }
/** /**
* unregister a placeholder hook by identifier * Unregister a placeholder hook by identifier
* *
* @param identifier the identifier for the placeholder hook to unregister * @param identifier The identifier for the placeholder hook to unregister
* @return true if the placeholder hook was successfully unregistered, false if there was no * @return true if the placeholder hook was successfully unregistered, false if there was no
* placeholder hook registered for the identifier specified * placeholder hook registered for the identifier specified
*/ */
@ -97,7 +97,7 @@ public class PlaceholderAPI {
/** /**
* Get all registered placeholder identifiers * Get all registered placeholder identifiers
* *
* @return all registered placeholder identifiers * @return All registered placeholder identifiers
*/ */
public static Set<String> getRegisteredIdentifiers() { public static Set<String> getRegisteredIdentifiers() {
return ImmutableSet.copyOf(placeholders.keySet()); return ImmutableSet.copyOf(placeholders.keySet());
@ -106,7 +106,7 @@ public class PlaceholderAPI {
/** /**
* Get map of registered placeholders * Get map of registered placeholders
* *
* @return copy of the internal placeholder map * @return Copy of the internal placeholder map
*/ */
public static Map<String, PlaceholderHook> getPlaceholders() { public static Map<String, PlaceholderHook> getPlaceholders() {
return ImmutableMap.copyOf(placeholders); return ImmutableMap.copyOf(placeholders);
@ -121,7 +121,7 @@ public class PlaceholderAPI {
} }
/** /**
* check if a String contains any PlaceholderAPI placeholders * Check if a String contains any PlaceholderAPI placeholders ({@literal %<identifier>_<params>%}).
* *
* @param text String to check * @param text String to check
* @return true if String contains any registered placeholder identifiers, false otherwise * @return true if String contains any registered placeholder identifiers, false otherwise
@ -131,7 +131,7 @@ public class PlaceholderAPI {
} }
/** /**
* check if a String contains any PlaceholderAPI bracket placeholders * Check if a String contains any PlaceholderAPI bracket placeholders ({@literal {<identifier>_<params>}}).
* *
* @param text String to check * @param text String to check
* @return true if String contains any registered placeholder identifiers, false otherwise * @return true if String contains any registered placeholder identifiers, false otherwise
@ -141,96 +141,165 @@ public class PlaceholderAPI {
} }
/** /**
* set placeholders in the list<String> text provided placeholders are matched with the pattern * Translates all placeholders into their corresponding values.
* {<placeholder>} when set with this method * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
* *
* @param p Player to parse the placeholders for * @param player Player to parse the placeholders against
* @param text text to set the placeholder values in * @param text List of Strings to set the placeholder values in
* @return modified list with all placeholders set to the corresponding values * @return String containing all translated placeholders
*/ */
public static List<String> setBracketPlaceholders(OfflinePlayer p, List<String> text) { public static List<String> setBracketPlaceholders(OfflinePlayer player, List<String> text) {
return setPlaceholders(p, text, BRACKET_PLACEHOLDER_PATTERN); return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true);
} }
/** /**
* set placeholders in the list<String> text provided placeholders are matched with the pattern * Translates all placeholders into their corresponding values.
* %(identifier)_(params)>% when set with this method * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
* *
* @param p Player to parse the placeholders for * @param player Player to parse the placeholders against
* @param text text to parse the placeholder values in * @param text List of Strings to set the placeholder values in
* @return modified list with all placeholders set to the corresponding values * @param colorize If color codes (&[0-1a-fk-o]) should be translated
* @return String containing all translated placeholders
*/ */
public static List<String> setPlaceholders(OfflinePlayer p, List<String> text) { public static List<String> setBracketPlaceholders(OfflinePlayer player, List<String> text, boolean colorize) {
return setPlaceholders(p, text, PLACEHOLDER_PATTERN); return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize);
} }
/**
* Translates all placeholders into their corresponding values.
* <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
*
* @param player Player to parse the placeholders against
* @param text List of Strings to set the placeholder values in
* @return String containing all translated placeholders
*/
public static List<String> setPlaceholders(OfflinePlayer player, List<String> text) {
return setPlaceholders(player, text, PLACEHOLDER_PATTERN, true);
}
/** /**
* set placeholders in the list<String> text provided placeholders are matched with the pattern * Translates all placeholders into their corresponding values.
* %(identifier)_(params)>% when set with this method * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
* *
* @param p Player to parse the placeholders for * @param player Player to parse the placeholders against
* @param text text to parse the placeholder values in * @param text List of Strings to set the placeholder values in
* @return modified list with all placeholders set to the corresponding values * @param colorize If color codes (&[0-1a-fk-o]) should be translated
* @return String containing all translated placeholders
*/ */
public static List<String> setPlaceholders(OfflinePlayer p, List<String> text, Pattern pattern) { public static List<String> setPlaceholders(OfflinePlayer player, List<String> text, boolean colorize) {
return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize);
}
/**
* Translates all placeholders into their corresponding values.
* <br>You set the pattern yourself through this method.
*
* @param player Player to parse the placeholders against
* @param text List of Strings to set the placeholder values in
* @param pattern The pattern to match placeholders to. Capture group 1 must contain an underscore separating the
* identifier from the params
* @return String containing all translated placeholders
*/
public static List<String> setPlaceholders(OfflinePlayer player, List<String> text, Pattern pattern) {
return setPlaceholders(player, text, pattern, true);
}
/**
* Translates all placeholders into their corresponding values.
* <br>You set the pattern yourself through this method.
*
* @param player Player to parse the placeholders against
* @param text List of Strings to set the placeholder values in
* @param pattern The pattern to match placeholders to. Capture group 1 must contain an underscore separating the
* identifier from the params
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
* @return String containing all translated placeholders
*/
public static List<String> setPlaceholders(OfflinePlayer player, List<String> text, Pattern pattern, boolean colorize) {
if(text == null) { if(text == null) {
return null; return null;
} }
return text.stream().map(line -> setPlaceholders(p, line, pattern)) return text.stream().map(line -> setPlaceholders(player, line, pattern, colorize))
.collect(Collectors.toList()); .collect(Collectors.toList());
} }
/** /**
* set placeholders in the text specified placeholders are matched with the pattern * Translates all placeholders into their corresponding values.
* {<placeholder>} when set with this method * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
* *
* @param player Player to parse the placeholders for * @param player Player to parse the placeholders against
* @param text text to parse the placeholder values to * @param text Text to set the placeholder values in
* @return modified text with all placeholders set to the corresponding values * @return String containing all translated placeholders
*/ */
public static String setBracketPlaceholders(OfflinePlayer player, String text) { public static String setBracketPlaceholders(OfflinePlayer player, String text) {
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN); return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true);
} }
/** /**
* set placeholders in the text specified placeholders are matched with the pattern * Translates all placeholders into their corresponding values.
* %<(identifier)_(params)>% when set with this method * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}
* *
* @param player Player to parse the placeholders for * @param player Player to parse the placeholders against
* @param text text to parse the placeholder values to * @param text Text to set the placeholder values in
* @return text with all placeholders set to the corresponding values * @param colorize If color codes (&[0-1a-fk-o]) should be translated
* @return String containing all translated placeholders
*/
public static String setBracketPlaceholders(OfflinePlayer player, String text, boolean colorize) {
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize);
}
/**
* Translates all placeholders into their corresponding values.
* <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
*
* @param player Player to parse the placeholders against
* @param text Text to set the placeholder values in
* @return String containing all translated placeholders
*/ */
public static String setPlaceholders(OfflinePlayer player, String text) { public static String setPlaceholders(OfflinePlayer player, String text) {
return setPlaceholders(player, text, PLACEHOLDER_PATTERN); return setPlaceholders(player, text, PLACEHOLDER_PATTERN);
} }
/** /**
* set placeholders in the text specified placeholders are matched with the pattern * Translates all placeholders into their corresponding values.
* %<(identifier)_(params)>% when set with this method * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
* *
* @param player Player to parse the placeholders for * @param player Player to parse the placeholder against
* @param text text to parse the placeholder values to * @param text Text to parse the placeholders in
* @param placeholderPattern the pattern to match placeholders to. Capture group 1 must contain an * @param colorize If color codes (&[0-1a-fk-o]) should be translated
* underscore separating the identifier from the params * @return The text containing the parsed placeholders
* @return text with all placeholders set to the corresponding values
*/ */
public static String setPlaceholders(OfflinePlayer player, String text, Pattern placeholderPattern) { public static String setPlaceholders(OfflinePlayer player, String text, boolean colorize) {
return setPlaceholders(player, text, placeholderPattern, true); return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize);
} }
/** /**
* set placeholders in the text specified placeholders are matched with the pattern * Translates all placeholders into their corresponding values.
* %<(identifier)_(params)>% when set with this method * <br>You set the pattern yourself through this method.
* *
* @param player Player to parse the placeholders for * @param player Player to parse the placeholders against
* @param text text to parse the placeholder values to * @param text Text to set the placeholder values in
* @param placeholderPattern the pattern to match placeholders to. Capture group 1 must contain an * @param pattern The pattern to match placeholders to. Capture group 1 must contain an underscore separating the
* @param colorize true/false if color codes should be translated within the output text * identifier from the params
* @return text with all placeholders set to the corresponding values * @return The text containing the parsed placeholders
*/ */
public static String setPlaceholders(OfflinePlayer player, String text, Pattern placeholderPattern, boolean colorize) { public static String setPlaceholders(OfflinePlayer player, String text, Pattern pattern) {
return setPlaceholders(player, text, pattern, true);
}
/**
* Translates all placeholders into their corresponding values.
* <br>You set the pattern yourself through this method.
*
* @param player Player to parse the placeholders against
* @param text Text to set the placeholder values in
* @param pattern The pattern to match placeholders to. Capture group 1 must contain an underscore separating the
* identifier from the params
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
* @return The text containing the parsed placeholders
*/
public static String setPlaceholders(OfflinePlayer player, String text, Pattern pattern, boolean colorize) {
if (text == null) { if (text == null) {
return null; return null;
} }
@ -239,7 +308,7 @@ public class PlaceholderAPI {
return colorize ? color(text) : text; return colorize ? color(text) : text;
} }
Matcher m = placeholderPattern.matcher(text); Matcher m = pattern.matcher(text);
Map<String, PlaceholderHook> hooks = getPlaceholders(); Map<String, PlaceholderHook> hooks = getPlaceholders();
while (m.find()) { while (m.find()) {
@ -265,20 +334,34 @@ public class PlaceholderAPI {
} }
/** /**
* set relational placeholders in the text specified placeholders are matched with the pattern * Translate placeholders in the provided List based on the relation of the two provided players.
* %<rel_(identifier)_(params)>% when set with this method * <br>The pattern of a valid placeholder is {@literal %rel_<identifier>_<param>%}.
* *
* @param one Player to compare * @param one Player to compare
* @param two Player to compare * @param two Player to compare
* @param text text to parse the placeholder values to * @param text text to parse the placeholder values to
* @return text with all relational placeholders set to the corresponding values * @return The text containing the parsed relational placeholders
*/ */
public static List<String> setRelationalPlaceholders(Player one, Player two, List<String> text) { public static List<String> setRelationalPlaceholders(Player one, Player two, List<String> text) {
return setRelationalPlaceholders(one, two, text, true);
}
/**
* Translate placeholders in the provided list based on the relation of the two provided players.
* <br>The pattern of a valid placeholder is {@literal %rel_<identifier>_<params>%}.
*
* @param one First player to compare
* @param two Second player to compare
* @param text Text to parse the placeholders in
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
* @return The text containing the parsed relational placeholders
*/
public static List<String> setRelationalPlaceholders(Player one, Player two, List<String> text, boolean colorize) {
if(text == null) { if(text == null) {
return null; return null;
} }
return text.stream().map(line -> setRelationalPlaceholders(one, two, line)) return text.stream().map(line -> setRelationalPlaceholders(one, two, line, colorize))
.collect(Collectors.toList()); .collect(Collectors.toList());
} }
@ -286,10 +369,10 @@ public class PlaceholderAPI {
* set relational placeholders in the text specified placeholders are matched with the pattern * set relational placeholders in the text specified placeholders are matched with the pattern
* %<rel_(identifier)_(params)>% when set with this method * %<rel_(identifier)_(params)>% when set with this method
* *
* @param one Player to compare * @param one First player to compare
* @param two Player to compare * @param two Second player to compare
* @param text text to parse the placeholder values to * @param text Text to parse the placeholders in
* @return text with all relational placeholders set to the corresponding values * @return The text containing the parsed relational placeholders
*/ */
public static String setRelationalPlaceholders(Player one, Player two, String text) { public static String setRelationalPlaceholders(Player one, Player two, String text) {
return setRelationalPlaceholders(one,two, text, true); return setRelationalPlaceholders(one,two, text, true);
@ -301,9 +384,9 @@ public class PlaceholderAPI {
* *
* @param one Player to compare * @param one Player to compare
* @param two Player to compare * @param two Player to compare
* @param text text to parse the placeholder values to * @param text Text to parse the placeholders in
* @param colorize true/false if color codes should be translated within the output text * @param colorize If color codes (&[0-1a-fk-o]) should be translated
* @return text with all relational placeholders set to the corresponding values * @return The text containing the parsed relational placeholders
*/ */
public static String setRelationalPlaceholders(Player one, Player two, String text, boolean colorize) { public static String setRelationalPlaceholders(Player one, Player two, String text, boolean colorize) {
if (text == null) { if (text == null) {
@ -346,7 +429,7 @@ public class PlaceholderAPI {
} }
/** /**
* unregister ALL placeholder hooks that are currently registered * Unregister ALL placeholder hooks that are currently registered
*/ */
protected static void unregisterAll() { protected static void unregisterAll() {
unregisterAllProvidedExpansions(); unregisterAllProvidedExpansions();
@ -354,7 +437,7 @@ public class PlaceholderAPI {
} }
/** /**
* unregister all expansions provided by PlaceholderAPI * Unregister all expansions provided by PlaceholderAPI
*/ */
public static void unregisterAllProvidedExpansions() { public static void unregisterAllProvidedExpansions() {
if (placeholders.isEmpty()) { if (placeholders.isEmpty()) {
@ -391,14 +474,29 @@ public class PlaceholderAPI {
return false; return false;
} }
/**
* Gets the placeholder pattern for the default placeholders.
*
* @return The pattern for {@literal %<identifier>_<params>%}
*/
public static Pattern getPlaceholderPattern() { public static Pattern getPlaceholderPattern() {
return PLACEHOLDER_PATTERN; return PLACEHOLDER_PATTERN;
} }
/**
* Gets the placeholder pattern for the bracket placeholders.
*
* @return The pattern for {@literal {<identifier>_<params>}}
*/
public static Pattern getBracketPlaceholderPattern() { public static Pattern getBracketPlaceholderPattern() {
return BRACKET_PLACEHOLDER_PATTERN; return BRACKET_PLACEHOLDER_PATTERN;
} }
/**
* Gets the placeholder pattern for the relational placeholders.
*
* @return The pattern for {@literal %rel_<identifier>_<params>%}
*/
public static Pattern getRelationalPlaceholderPattern() { public static Pattern getRelationalPlaceholderPattern() {
return RELATIONAL_PLACEHOLDER_PATTERN; return RELATIONAL_PLACEHOLDER_PATTERN;
} }
@ -423,19 +521,35 @@ public class PlaceholderAPI {
return plugin != null && unregisterPlaceholderHook(plugin.getName()); return plugin != null && unregisterPlaceholderHook(plugin.getName());
} }
public static String setPlaceholders(Player p, String text) { public static String setPlaceholders(Player player, String text) {
return setPlaceholders(p, text, PLACEHOLDER_PATTERN); return setPlaceholders(player, text, PLACEHOLDER_PATTERN, true);
} }
public static List<String> setPlaceholders(Player p, List<String> text) { public static String setPlaceholders(Player player, String text, boolean colorize) {
return setPlaceholders(p, text, PLACEHOLDER_PATTERN); return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize);
} }
public static String setBracketPlaceholders(Player p, String text) { public static List<String> setPlaceholders(Player player, List<String> text) {
return setPlaceholders(p, text, BRACKET_PLACEHOLDER_PATTERN); return setPlaceholders(player, text, PLACEHOLDER_PATTERN, true);
} }
public static List<String> setBracketPlaceholders(Player p, List<String> text) { public static List<String> setPlaceholders(Player player, List<String> text, boolean colorize) {
return setPlaceholders(p, text, BRACKET_PLACEHOLDER_PATTERN); return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize);
}
public static String setBracketPlaceholders(Player player, String text) {
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true);
}
public static String setBracketPlaceholders(Player player, String text, boolean colorize) {
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize);
}
public static List<String> setBracketPlaceholders(Player player, List<String> text) {
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true);
}
public static List<String> setBracketPlaceholders(Player player, List<String> text, boolean colorize) {
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize);
} }
} }