Add ability to register custom item transformers. #4871
+69
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
|
Thanks for your interest in contributing to EssentialsX! As it stands, |
pop4959
added
type: enhancement
Author
|
It's been a while, just would like to see if this could still be merged as the rework to |
Author
|
Heyo! I recently found a need for this again and wanted to know if this could get merged in quickly. Thanks! |
JRoy
requested changes
Nov 16, 2025
Member
JRoy
left a comment
JRoy
left a comment
There was a problem hiding this comment.
minor nit + fix the formatting issues + fix the merge conflicts
Author
|
I've addressed the changes. Should I modify anything else? |
JRoy
requested changes
Nov 17, 2025
| private static final Pattern STRICTINVALIDCHARS = Pattern.compile("[^a-z0-9]"); | ||
| @SuppressWarnings("CheckStyle") | ||
| private static final Pattern INVALIDCHARS = Pattern.compile("[^\t\n\r\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFC]"); | ||
| private static final Pattern INVALIDCHARS = Pattern.compile("[^\t\n\r -~\u0085\u00A0-\uD7FF\uE000-\uFFFC]"); |
Comment on lines
10
to
11
| if(thePlugin == null) | ||
| throw new IllegalArgumentException("Plugin cannot be null!"); |
Member
There was a problem hiding this comment.
Suggested change
| if(thePlugin == null) | |
| throw new IllegalArgumentException("Plugin cannot be null!"); | |
| if (thePlugin == null) { | |
| throw new IllegalArgumentException("Plugin cannot be null!"); | |
| } |
| public abstract class PluginItemTransformer { | ||
| private final Plugin plugin; | ||
|
|
||
| public PluginItemTransformer(Plugin thePlugin){ |
Member
There was a problem hiding this comment.
Suggested change
| public PluginItemTransformer(Plugin thePlugin){ | |
| public PluginItemTransformer(final Plugin thePlugin) { |
Comment on lines
399
to
412
| private void transformItem(String key, String data){ | ||
| final PluginItemTransformer transformer = itemTransformers.get(key); | ||
|
|
||
| //Ignore, the plugin is disabled. | ||
| if(!transformer.getPlugin().isEnabled()) | ||
| return; | ||
|
|
||
| try{ | ||
| stack = transformer.apply(data, stack); | ||
| }catch(Throwable thr){ | ||
| Bukkit.getLogger().severe(String.format("[Essentials] - Error applying data \"%s\" to itemstack! Plugin: %s, Key: %s", data, transformer.getPlugin().getName(), key)); | ||
| thr.printStackTrace(); | ||
| } | ||
| } |
Member
There was a problem hiding this comment.
Suggested change
| private void transformItem(String key, String data){ | |
| final PluginItemTransformer transformer = itemTransformers.get(key); | |
| //Ignore, the plugin is disabled. | |
| if(!transformer.getPlugin().isEnabled()) | |
| return; | |
| try{ | |
| stack = transformer.apply(data, stack); | |
| }catch(Throwable thr){ | |
| Bukkit.getLogger().severe(String.format("[Essentials] - Error applying data \"%s\" to itemstack! Plugin: %s, Key: %s", data, transformer.getPlugin().getName(), key)); | |
| thr.printStackTrace(); | |
| } | |
| } | |
| private void transformItem(final String key, final String data){ | |
| final PluginItemTransformer transformer = itemTransformers.get(key); | |
| //Ignore, the plugin is disabled. | |
| if (!transformer.getPlugin().isEnabled()) { | |
| return; | |
| } | |
| try { | |
| stack = transformer.apply(data, stack); | |
| } catch(final Throwable thr) { | |
| Bukkit.getLogger().severe(String.format("[Essentials] - Error applying data \"%s\" to itemstack! Plugin: %s, Key: %s", data, transformer.getPlugin().getName(), key)); | |
| thr.printStackTrace(); | |
| } | |
| } |
| * Unregisters a certain item transformer under key "key". | ||
| * @param key the transformer key. | ||
| */ | ||
| public static void unregisterItemTransformer(String key){ |
Member
There was a problem hiding this comment.
Suggested change
| public static void unregisterItemTransformer(String key){ | |
| public static void unregisterItemTransformer(final String key) { |
Comment on lines
97
to
99
| public static void registerItemTransformer(String key, PluginItemTransformer itemTransformer){ | ||
| //Warn people if they're trying to register over top of someone else. | ||
| if(itemTransformers.containsKey(key)){ |
Member
There was a problem hiding this comment.
Suggested change
| public static void registerItemTransformer(String key, PluginItemTransformer itemTransformer){ | |
| //Warn people if they're trying to register over top of someone else. | |
| if(itemTransformers.containsKey(key)){ | |
| public static void registerItemTransformer(final String key, final PluginItemTransformer itemTransformer) { | |
| //Warn people if they're trying to register over top of someone else. | |
| if (itemTransformers.containsKey(key)) { |
Comment on lines
58
to
59
|
|
||
| //Contains plugin registered item meta data transformers. |
Member
There was a problem hiding this comment.
Suggested change
| //Contains plugin registered item meta data transformers. |
Author
|
Addressed! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Information
This PR closes Nothing.
Details
Proposed feature:
A system to allow plugin developers to add custom item transformers to metadata on items. Would be useful for plugins seeking to add custom item templates that could be dynamic or have special data on the item.
Environments tested:
OS: Windows 10
Java version: 1.8.0_281
Demonstration:
A demonstration isn't fully applicable to the situation as it's not something that immediately affects anything.