Implemented cache for the map item custom render

This will make images or text fast to load when is pre-loaded and also when the itemstack is created and also adding tread-safe option to update the image or text.

Author: broken1arrow

Item Creator/src/main/java/org/broken/arrow/library/itemcreator/ItemCreator.java

@@ -5,6 +5,7 @@
 import org.broken.arrow.library.itemcreator.utility.ConvertToItemStack;
 import org.broken.arrow.library.itemcreator.utility.ServerVersion;
 import org.broken.arrow.library.itemcreator.utility.builders.ItemBuilder;
+import org.broken.arrow.library.logging.Logging;
 import org.broken.arrow.library.logging.Validate;
 import org.broken.arrow.library.logging.Validate.ValidateExceptions;
 import org.broken.arrow.library.nbt.RegisterNbtAPI;
@@ -28,11 +29,11 @@
  * Supports setting display names, lore, NBT data, and color translation.
  */
 public class ItemCreator {
-
+    private static final Logging log = new Logging(ItemCreator.class);
     private static ServerVersion serverVersion;
+    private static Plugin plugin;
     private final NBTManger nbtManger;
     private final ConvertToItemStack convertItems;
-    private final Plugin plugin;
     private boolean haveTextTranslator = true;
     private boolean enableColorTranslation = true;
 
@@ -56,13 +57,13 @@ public ItemCreator(final Plugin plugin) {
     /**
      * Constructs an ItemCreator instance associated with the given plugin.
      *
-     * @param plugin        the plugin instance
-     * @param turnOffLogger whether to disable logging for NBT manager
+     * @param pluginInstance the plugin instance
+     * @param turnOffLogger  whether to disable logging for NBT manager
      */
-    public ItemCreator(final Plugin plugin, boolean turnOffLogger) {
-        this.plugin = plugin;
-        this.nbtManger = new NBTManger(plugin, turnOffLogger);
-        setServerVersion(plugin);
+    public ItemCreator(final Plugin pluginInstance, boolean turnOffLogger) {
+        this.setPlugin(pluginInstance);
+        this.nbtManger = new NBTManger(pluginInstance, turnOffLogger);
+        setServerVersion(pluginInstance);
 
         this.convertItems = new ConvertToItemStack(serverVersion.getServerVersion());
 
@@ -440,4 +441,32 @@ private static Enchantment getEnchantment(@Nullable final NamespacedKey key, @Nu
         return enchantment == null ? Enchantment.VANISHING_CURSE : enchantment;
     }
 
+    /**
+     * Executes the given runnable safely, falling back to direct execution if
+     * Bukkit or the plugin instance is not available.
+     *
+     * @param runnable the task to run
+     */
+    public static void runSync(@Nonnull final Runnable runnable) {
+        try {
+            Plugin plugin = ItemCreator.plugin;
+            if (plugin == null || !plugin.isEnabled()) {
+                runnable.run();
+                return;
+            }
+            Bukkit.getScheduler().runTask(plugin, runnable);
+        } catch (NoClassDefFoundError | ExceptionInInitializerError ex) {
+            runnable.run();
+        } catch (Throwable t) {
+            if (t instanceof NullPointerException || t instanceof IllegalStateException) {
+                throw t;
+            }
+            log.logError(t, () -> "Failed to execute scheduled task safely. The runnable crashed.");
+        }
+    }
+
+    private void setPlugin(final Plugin pluginInstance) {
+        plugin = pluginInstance;
+    }
+
 }

Item Creator/src/main/java/org/broken/arrow/library/itemcreator/meta/map/BuildMapView.java

@@ -193,6 +193,14 @@ public MapRendererData addRenderer(@Nonnull final Consumer<MapRendererData> data
         return mapRenderer;
     }
 
+    /**
+     * Add your cached image data.
+     *
+     * @param cache the cache to get the image.
+     */
+    public void addAllCachedRenderers(@Nonnull MapRendererDataCache cache) {
+        this.renderers.addAll(cache.getAllRendererData());
+    }
     /**
      * Adds a map list of renderer instance's.
      *

Item Creator/src/main/java/org/broken/arrow/library/itemcreator/meta/map/MapRendererData.java

@@ -5,7 +5,6 @@
 import org.broken.arrow.library.itemcreator.meta.map.color.parser.ColorParser;
 import org.broken.arrow.library.itemcreator.meta.map.cursor.MapCursorAdapter;
 import org.broken.arrow.library.itemcreator.meta.map.cursor.MapCursorWrapper;
-import org.broken.arrow.library.itemcreator.meta.map.font.customdraw.MapTextRenderer;
 import org.broken.arrow.library.itemcreator.meta.map.font.customdraw.RenderState;
 import org.broken.arrow.library.itemcreator.meta.map.pixel.ImageOverlay;
 import org.broken.arrow.library.itemcreator.meta.map.pixel.MapPixel;
@@ -22,6 +21,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
 /**
@@ -41,11 +41,14 @@ public class MapRendererData {
     private static int id;
     private final int mapRenderId;
     private final MapRenderer mapRenderer;
-    private MapCursorAdapter mapCursors = new MapCursorAdapter();
     private final List<MapPixel> pixels = new ArrayList<>();
+    private MapCursorAdapter mapCursors = new MapCursorAdapter();
+
     private MapRenderHandler dynamicRenderer;
+
     private char[] fontChars = Characters.getFontCharsArray();
     private ColorParser colorParser = new AmpersandHexColorParser();
+    private boolean contextual;
 
     /**
      * Constructs a new MapRendererData instance with no associated {@link MapRenderer}.
@@ -75,6 +78,7 @@ public void setDynamicRenderer(MapRenderHandler handler) {
         this.dynamicRenderer = handler;
     }
 
+
     /**
      * Adds a colored pixel overlay to the map at the specified coordinates.
      *
@@ -103,7 +107,7 @@ public void addPixel(@Nonnull final MapColoredPixel mapColoredPixel) {
      * @param text The text to display.
      * @return returns the newly created text overlay, so you could set some of the options after.
      */
-    public TextOverlay addText(final int x, int y, final String text) {
+    public TextOverlay addText(final int x, int y,@Nonnull final String text) {
         return this.addText(x, y, text, null, null);
     }
 
@@ -117,7 +121,7 @@ public TextOverlay addText(final int x, int y, final String text) {
      * @param font The  font for the character.
      * @return returns the newly created text overlay, so you could set some of the options after.
      */
-    public TextOverlay addText(final int x, int y, final String text, @Nullable final Font font) {
+    public TextOverlay addText(final int x, int y,@Nonnull final String text, @Nullable final Font font) {
         return this.addText(x, y, text, null, font);
     }
 
@@ -240,6 +244,52 @@ public MapCursorWrapper addCursor(@Nonnull final MapCursorWrapper cursorWrapper)
         return cursorWrapper;
     }
 
+    /**
+     * Adds a collection of map overlays (pixels, text, or images) to this renderer.
+     * <p>
+     * This method appends the provided overlays to the existing pixel list
+     * without clearing previous entries. It can be used to add multiple
+     * overlay types at once or to batch-apply preprocessed render data.
+     * </p>
+     *
+     * <p><strong>Note:</strong> For most use cases, prefer the more specific
+     * methods such as {@link #addPixel(int, int, Color)},{@link #addText(int, int, String)}
+     * or {@link #addImage(int, int, Image)} for clarity.</p>
+     *
+     * @param mapPixels the list of {@link MapPixel} instances to add
+     */
+    public void addAll(List<MapPixel> mapPixels) {
+        this.pixels.addAll(mapPixels);
+    }
+
+    /**
+     * Clear the list of set pixels.
+     */
+    public void clear() {
+        this.pixels.clear();
+    }
+
+    /**
+     * Set whether the renderer is contextual, i.e. has different canvases for
+     * different players.
+     *
+     * @param contextual Whether the renderer is contextual. See {@link
+     *                   #isContextual()}.
+     */
+    public void setContextual(boolean contextual) {
+        this.contextual = contextual;
+    }
+
+    /**
+     * Get whether the renderer is contextual, i.e. has different canvases for
+     * different players.
+     *
+     * @return True if contextual, false otherwise.
+     */
+    public final boolean isContextual() {
+        return contextual;
+    }
+
     /**
      * Returns the unique ID assigned to this map renderer data instance.
      *
@@ -277,20 +327,20 @@ public MapRenderer getMapRenderer() {
         if (this.mapRenderer != null) {
             return mapRenderer;
         }
-        return new MapRenderer() {
+        return new MapRenderer(this.contextual) {
             @Override
             public void render(@Nonnull MapView map, @Nonnull MapCanvas canvas, @Nonnull Player player) {
                 if (dynamicRenderer != null && dynamicRenderer.render(map, canvas, player))
                     return;
                 canvas.setCursors(mapCursors.getMapCursorCollection());
+
                 if (!getPixels().isEmpty()) {
                     setPixels(canvas);
                 }
             }
         };
     }
 
-
     @Override
     public boolean equals(Object o) {
         if (o == null || getClass() != o.getClass()) return false;
@@ -365,4 +415,5 @@ private void setPixels(@Nonnull final MapCanvas canvas) {
         getPixels().forEach(mapPixel -> mapPixel.render(this, canvas));
     }
 
+
 }