SlimefunItemStack reimplementation

pom.xml

@@ -397,7 +397,7 @@
         <dependency>
             <groupId>com.github.MockBukkit</groupId>
             <artifactId>MockBukkit</artifactId>
-            <version>v3.130.2</version>
+            <version>v3.133.2</version>
             <scope>test</scope>
 
             <exclusions>
@@ -410,6 +410,13 @@
             </exclusions>
         </dependency>
 
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <version>1.18.32</version>
+            <scope>provided</scope>
+        </dependency>
+
         <!-- Third party plugin integrations / soft dependencies -->
         <dependency>
             <groupId>com.sk89q.worldedit</groupId>

src/main/java/io/github/thebusybiscuit/slimefun4/api/gps/GPSNetwork.java

@@ -149,15 +149,15 @@ public void openTransmitterControlPanel(@Nonnull Player p) {
             menu.addItem(slot, ChestMenuUtils.getBackground(), ChestMenuUtils.getEmptyClickHandler());
         }
 
-        menu.addItem(2, new CustomItemStack(SlimefunItems.GPS_TRANSMITTER, im -> {
+        menu.addItem(2, new CustomItemStack(SlimefunItems.GPS_TRANSMITTER.getDelegate(), im -> {
             im.setDisplayName(ChatColor.GRAY + Slimefun.getLocalization().getMessage(p, "machines.GPS_CONTROL_PANEL.transmitters"));
             im.setLore(null);
         }));
 
         menu.addMenuClickHandler(2, ChestMenuUtils.getEmptyClickHandler());
 
         int complexity = getNetworkComplexity(p.getUniqueId());
-        menu.addItem(4, new CustomItemStack(SlimefunItems.GPS_CONTROL_PANEL, "&7Network Info", "", "&8\u21E8 &7Status: " + getStatusText(p, complexity), "&8\u21E8 &7Complexity: &f" + complexity));
+        menu.addItem(4, new CustomItemStack(SlimefunItems.GPS_CONTROL_PANEL.getDelegate(), "&7Network Info", "", "&8\u21E8 &7Status: " + getStatusText(p, complexity), "&8\u21E8 &7Complexity: &f" + complexity));
         menu.addMenuClickHandler(4, ChestMenuUtils.getEmptyClickHandler());
 
         menu.addItem(6, new CustomItemStack(HeadTexture.GLOBE_OVERWORLD.getAsItemStack(), "&7" + Slimefun.getLocalization().getMessage(p, "machines.GPS_CONTROL_PANEL.waypoints"), "", ChatColor.GRAY + "\u21E8 " + Slimefun.getLocalization().getMessage(p, "guide.tooltips.open-itemgroup")));
@@ -177,7 +177,7 @@ public void openTransmitterControlPanel(@Nonnull Player p) {
             if (sfi instanceof GPSTransmitter transmitter) {
                 int slot = inventory[index];
 
-                menu.addItem(slot, new CustomItemStack(SlimefunItems.GPS_TRANSMITTER, "&bGPS Transmitter", "&8\u21E8 &7World: &f" + l.getWorld().getName(), "&8\u21E8 &7X: &f" + l.getX(), "&8\u21E8 &7Y: &f" + l.getY(), "&8\u21E8 &7Z: &f" + l.getZ(), "", "&8\u21E8 &7Signal Strength: &f" + transmitter.getMultiplier(l.getBlockY()), "&8\u21E8 &7Ping: &f" + NumberUtils.roundDecimalNumber(1000D / l.getY()) + "ms"));
+                menu.addItem(slot, new CustomItemStack(SlimefunItems.GPS_TRANSMITTER.getDelegate(), "&bGPS Transmitter", "&8\u21E8 &7World: &f" + l.getWorld().getName(), "&8\u21E8 &7X: &f" + l.getX(), "&8\u21E8 &7Y: &f" + l.getY(), "&8\u21E8 &7Z: &f" + l.getZ(), "", "&8\u21E8 &7Signal Strength: &f" + transmitter.getMultiplier(l.getBlockY()), "&8\u21E8 &7Ping: &f" + NumberUtils.roundDecimalNumber(1000D / l.getY()) + "ms"));
                 menu.addMenuClickHandler(slot, ChestMenuUtils.getEmptyClickHandler());
 
                 index++;
@@ -232,14 +232,14 @@ public void openWaypointControlPanel(@Nonnull Player p) {
                 menu.addItem(slot, ChestMenuUtils.getBackground(), ChestMenuUtils.getEmptyClickHandler());
             }
 
-            menu.addItem(2, new CustomItemStack(SlimefunItems.GPS_TRANSMITTER, "&7" + Slimefun.getLocalization().getMessage(p, "machines.GPS_CONTROL_PANEL.transmitters"), "", ChatColor.GRAY + "\u21E8 " + Slimefun.getLocalization().getMessage(p, "guide.tooltips.open-itemgroup")));
+            menu.addItem(2, new CustomItemStack(SlimefunItems.GPS_TRANSMITTER.getDelegate(), "&7" + Slimefun.getLocalization().getMessage(p, "machines.GPS_CONTROL_PANEL.transmitters"), "", ChatColor.GRAY + "\u21E8 " + Slimefun.getLocalization().getMessage(p, "guide.tooltips.open-itemgroup")));
             menu.addMenuClickHandler(2, (pl, slot, item, action) -> {
                 openTransmitterControlPanel(pl);
                 return false;
             });
 
             int complexity = getNetworkComplexity(p.getUniqueId());
-            menu.addItem(4, new CustomItemStack(SlimefunItems.GPS_CONTROL_PANEL, "&7Network Info", "", "&8\u21E8 &7Status: " + (complexity > 0 ? "&2&lONLINE" : "&4&lOFFLINE"), "&8\u21E8 &7Complexity: &f" + complexity));
+            menu.addItem(4, new CustomItemStack(SlimefunItems.GPS_CONTROL_PANEL.getDelegate(), "&7Network Info", "", "&8\u21E8 &7Status: " + (complexity > 0 ? "&2&lONLINE" : "&4&lOFFLINE"), "&8\u21E8 &7Complexity: &f" + complexity));
             menu.addMenuClickHandler(4, ChestMenuUtils.getEmptyClickHandler());
 
             menu.addItem(6, new CustomItemStack(HeadTexture.GLOBE_OVERWORLD.getAsItemStack(), "&7" + Slimefun.getLocalization().getMessage(p, "machines.GPS_CONTROL_PANEL.waypoints")));

src/main/java/io/github/thebusybiscuit/slimefun4/api/items/SlimefunItem.java

@@ -153,7 +153,7 @@ public SlimefunItem(ItemGroup itemGroup, SlimefunItemStack item, RecipeType reci
         Validate.notNull(recipeType, "'recipeType' is not allowed to be null!");
 
         this.itemGroup = itemGroup;
-        this.itemStackTemplate = item;
+        this.itemStackTemplate = item.getDelegate();
         this.id = item.getItemId();
         this.recipeType = recipeType;
         this.recipe = recipe;
@@ -1185,6 +1185,19 @@ public final int hashCode() {
         return Optional.ofNullable(getById(id));
     }
 
+    public static @Nullable SlimefunItem getByItem(@Nullable SlimefunItemStack slimefunItemStack) {
+        if (slimefunItemStack == null) {
+            return null;
+        }
+
+        var delegate = slimefunItemStack.getDelegate();
+        if (delegate.getType() == Material.AIR) {
+            return null;
+        }
+
+        return getById(slimefunItemStack.getItemId());
+    }
+
     /**
      * Retrieve a {@link SlimefunItem} from an {@link ItemStack}.
      *

src/main/java/io/github/thebusybiscuit/slimefun4/api/items/SlimefunItemStack.java

@@ -11,6 +11,7 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
+import lombok.experimental.Delegate;
 import org.apache.commons.lang.Validate;
 import org.bukkit.ChatColor;
 import org.bukkit.Color;
@@ -41,7 +42,10 @@
  * @author Walshy
  *
  */
-public class SlimefunItemStack extends ItemStack {
+public class SlimefunItemStack {
+
+    @Delegate
+    private ItemStack delegate;
 
     private String id;
     private ItemMetaSnapshot itemMetaSnapshot;
@@ -50,7 +54,7 @@ public class SlimefunItemStack extends ItemStack {
     private String texture = null;
 
     public SlimefunItemStack(@Nonnull String id, @Nonnull ItemStack item) {
-        super(item);
+        delegate = new ItemStack(item);
 
         Validate.notNull(id, "The Item id must never be null!");
         Validate.isTrue(id.equals(id.toUpperCase(Locale.ROOT)), "Slimefun Item Ids must be uppercase! (e.g. 'MY_ITEM_ID')");
@@ -61,7 +65,7 @@ public SlimefunItemStack(@Nonnull String id, @Nonnull ItemStack item) {
 
         this.id = id;
 
-        ItemMeta meta = getItemMeta();
+        ItemMeta meta = delegate.getItemMeta();
 
         Slimefun.getItemDataService().setItemData(meta, id);
         Slimefun.getItemTextureService().setTexture(meta, id);
@@ -72,7 +76,7 @@ public SlimefunItemStack(@Nonnull String id, @Nonnull ItemStack item) {
     public SlimefunItemStack(@Nonnull String id, @Nonnull ItemStack item, @Nonnull Consumer<ItemMeta> consumer) {
         this(id, item);
 
-        ItemMeta im = getItemMeta();
+        ItemMeta im = delegate.getItemMeta();
         consumer.accept(im);
         setItemMeta(im);
     }
@@ -166,7 +170,7 @@ public SlimefunItemStack(@Nonnull String id, @Nonnull Color color, @Nonnull Poti
     }
 
     public SlimefunItemStack(@Nonnull SlimefunItemStack item, int amount) {
-        this(item.getItemId(), item);
+        this(item.getItemId(), item.getDelegate());
         setAmount(amount);
     }
 
@@ -239,24 +243,21 @@ public SlimefunItemStack(@Nonnull String id, @Nonnull String texture, @Nonnull C
         return itemMetaSnapshot;
     }
 
-    @Override
     public boolean setItemMeta(ItemMeta meta) {
         validate();
         itemMetaSnapshot = new ItemMetaSnapshot(meta);
 
-        return super.setItemMeta(meta);
+        return delegate.setItemMeta(meta);
     }
 
-    @Override
     public void setType(Material type) {
         validate();
-        super.setType(type);
+        delegate.setType(type);
     }
 
-    @Override
     public void setAmount(int amount) {
         validate();
-        super.setAmount(amount);
+        delegate.setAmount(amount);
     }
 
     private void validate() {
@@ -306,13 +307,13 @@ public void lock() {
     }
 
     @Override
-    public ItemStack clone() {
-        return new SlimefunItemStack(id, super.clone());
+    public @Nonnull SlimefunItemStack clone() {
+        return new SlimefunItemStack(id, delegate.clone());
     }
 
     @Override
     public String toString() {
-        return "SlimefunItemStack (" + id + (getAmount() > 1 ? (" x " + getAmount()) : "") + ')';
+        return "SlimefunItemStack (" + id + (delegate.getAmount() > 1 ? (" x " + delegate.getAmount()) : "") + ')';
     }
 
     /**
@@ -332,4 +333,11 @@ public final int hashCode() {
         // We don't want people to override this, it should use the super method
         return super.hashCode();
     }
+
+    /**
+     * @return underlying ItemStack used
+     */
+    public @Nonnull ItemStack getDelegate() {
+        return delegate;
+    }
 }

src/main/java/io/github/thebusybiscuit/slimefun4/api/recipes/RecipeType.java

@@ -47,7 +47,7 @@ public class RecipeType implements Keyed {
     public static final RecipeType ENHANCED_CRAFTING_TABLE = new RecipeType(new NamespacedKey(Slimefun.instance(), "enhanced_crafting_table"), SlimefunItems.ENHANCED_CRAFTING_TABLE, "", "&a&oA regular Crafting Table cannot", "&a&ohold this massive Amount of Power...");
     public static final RecipeType JUICER = new RecipeType(new NamespacedKey(Slimefun.instance(), "juicer"), SlimefunItems.JUICER, "", "&a&oUsed for Juice Creation");
 
-    public static final RecipeType ANCIENT_ALTAR = new RecipeType(new NamespacedKey(Slimefun.instance(), "ancient_altar"), SlimefunItems.ANCIENT_ALTAR, (recipe, output) -> {
+    public static final RecipeType ANCIENT_ALTAR = new RecipeType(new NamespacedKey(Slimefun.instance(), "ancient_altar"), SlimefunItems.ANCIENT_ALTAR.getDelegate(), (recipe, output) -> {
         AltarRecipe altarRecipe = new AltarRecipe(Arrays.asList(recipe), output);
         AncientAltar altar = ((AncientAltar) SlimefunItems.ANCIENT_ALTAR.getItem());
         altar.getRecipes().add(altarRecipe);
@@ -91,7 +91,7 @@ public RecipeType(ItemStack item, String machine) {
     }
 
     public RecipeType(NamespacedKey key, SlimefunItemStack slimefunItem, String... lore) {
-        this(key, slimefunItem, null, lore);
+        this(key, slimefunItem.getDelegate(), null, lore);
     }
 
     public RecipeType(NamespacedKey key, ItemStack item, BiConsumer<ItemStack[], ItemStack> callback, String... lore) {

src/main/java/io/github/thebusybiscuit/slimefun4/core/commands/subcommands/BackpackCommand.java

@@ -69,7 +69,7 @@ public void onExecute(CommandSender sender, String[] args) {
                     }
 
                     Slimefun.runSync(() -> {
-                        ItemStack item = SlimefunItems.RESTORED_BACKPACK.clone();
+                        ItemStack item = SlimefunItems.RESTORED_BACKPACK.clone().getDelegate();
                         Slimefun.getBackpackListener().setBackpackId(backpackOwner, item, 2, id);
                         player.getInventory().addItem(item);
                         Slimefun.getLocalization().sendMessage(sender, "commands.backpack.restored-backpack-given");

src/main/java/io/github/thebusybiscuit/slimefun4/core/commands/subcommands/DebugFishCommand.java

@@ -20,7 +20,7 @@ class DebugFishCommand extends SubCommand {
     @Override
     public void onExecute(CommandSender sender, String[] args) {
         if (sender instanceof Player player && sender.hasPermission("slimefun.debugging")) {
-            player.getInventory().addItem(SlimefunItems.DEBUG_FISH.clone());
+            player.getInventory().addItem(SlimefunItems.DEBUG_FISH.clone().getDelegate());
         } else {
             Slimefun.getLocalization().sendMessage(sender, "messages.no-permission", true);
         }

src/main/java/io/github/thebusybiscuit/slimefun4/implementation/items/electric/generators/BioGenerator.java

@@ -69,7 +69,7 @@ protected void registerDefaultFuelTypes() {
         registerFuel(new MachineFuel(4, new ItemStack(Material.SHROOMLIGHT)));
         registerFuel(new MachineFuel(2, new ItemStack(Material.CRIMSON_FUNGUS)));
         registerFuel(new MachineFuel(2, new ItemStack(Material.WARPED_FUNGUS)));
-        registerFuel(new MachineFuel(16, SlimefunItems.STRANGE_NETHER_GOO));
+        registerFuel(new MachineFuel(16, SlimefunItems.STRANGE_NETHER_GOO.getDelegate()));
 
         if (Slimefun.getMinecraftVersion().isAtLeast(MinecraftVersion.MINECRAFT_1_17)) {
             registerFuel(new MachineFuel(2, new ItemStack(Material.GLOW_BERRIES)));

src/main/java/io/github/thebusybiscuit/slimefun4/implementation/items/electric/generators/CombustionGenerator.java

@@ -22,8 +22,8 @@ public CombustionGenerator(ItemGroup itemGroup, SlimefunItemStack item, RecipeTy
 
     @Override
     protected void registerDefaultFuelTypes() {
-        registerFuel(new MachineFuel(30, SlimefunItems.OIL_BUCKET));
-        registerFuel(new MachineFuel(90, SlimefunItems.FUEL_BUCKET));
+        registerFuel(new MachineFuel(30, SlimefunItems.OIL_BUCKET.getDelegate()));
+        registerFuel(new MachineFuel(90, SlimefunItems.FUEL_BUCKET.getDelegate()));
     }
 
     @Override

src/main/java/io/github/thebusybiscuit/slimefun4/implementation/items/electric/machines/AutoAnvil.java

@@ -49,7 +49,7 @@ protected MachineRecipe findNextRecipe(BlockMenu menu) {
             ItemStack item = menu.getItemInSlot(slot);
 
             if (item != null && item.getType().getMaxDurability() > 0 && ((Damageable) item.getItemMeta()).getDamage() > 0) {
-                if (SlimefunUtils.isItemSimilar(ductTape, SlimefunItems.DUCT_TAPE, true, false)) {
+                if (SlimefunUtils.isItemSimilar(ductTape, SlimefunItems.DUCT_TAPE.getDelegate(), true, false)) {
                     ItemStack repairedItem = repair(item);
 
                     if (!menu.fits(repairedItem, getOutputSlots())) {

src/main/java/io/github/thebusybiscuit/slimefun4/implementation/items/electric/machines/AutoDrier.java

@@ -62,25 +62,25 @@ protected void registerDefaultRecipes() {
         recipeList.add(new ItemStack(Material.BUCKET));
 
         recipeList.add(new ItemStack(Material.COOKED_BEEF));
-        recipeList.add(SlimefunItems.BEEF_JERKY);
+        recipeList.add(SlimefunItems.BEEF_JERKY.getDelegate());
 
         recipeList.add(new ItemStack(Material.COOKED_PORKCHOP));
-        recipeList.add(SlimefunItems.PORK_JERKY);
+        recipeList.add(SlimefunItems.PORK_JERKY.getDelegate());
 
         recipeList.add(new ItemStack(Material.COOKED_CHICKEN));
-        recipeList.add(SlimefunItems.CHICKEN_JERKY);
+        recipeList.add(SlimefunItems.CHICKEN_JERKY.getDelegate());
 
         recipeList.add(new ItemStack(Material.COOKED_MUTTON));
-        recipeList.add(SlimefunItems.MUTTON_JERKY);
+        recipeList.add(SlimefunItems.MUTTON_JERKY.getDelegate());
 
         recipeList.add(new ItemStack(Material.COOKED_RABBIT));
-        recipeList.add(SlimefunItems.RABBIT_JERKY);
+        recipeList.add(SlimefunItems.RABBIT_JERKY.getDelegate());
 
         recipeList.add(new ItemStack(Material.COOKED_COD));
-        recipeList.add(SlimefunItems.FISH_JERKY);
+        recipeList.add(SlimefunItems.FISH_JERKY.getDelegate());
 
         recipeList.add(new ItemStack(Material.COOKED_SALMON));
-        recipeList.add(SlimefunItems.FISH_JERKY);
+        recipeList.add(SlimefunItems.FISH_JERKY.getDelegate());
 
         if (Slimefun.getMinecraftVersion().isAtLeast(MinecraftVersion.MINECRAFT_1_19)) {
             recipeList.add(new ItemStack(Material.MUD));

src/main/java/io/github/thebusybiscuit/slimefun4/implementation/items/electric/machines/CarbonPress.java

@@ -24,12 +24,12 @@ public CarbonPress(ItemGroup itemGroup, SlimefunItemStack item, RecipeType recip
     @Override
     protected void registerDefaultRecipes() {
         registerRecipe(15, new ItemStack[] { new ItemStack(Material.CHARCOAL, 4) }, new ItemStack[] { new ItemStack(Material.COAL) });
-        registerRecipe(20, new ItemStack[] { new ItemStack(Material.COAL, 8) }, new ItemStack[] { SlimefunItems.CARBON });
-        registerRecipe(180, new ItemStack[] { new ItemStack(Material.COAL_BLOCK, 8) }, new ItemStack[] { new SlimefunItemStack(SlimefunItems.CARBON, 9) });
-        registerRecipe(30, new ItemStack[] { new CustomItemStack(SlimefunItems.CARBON, 4) }, new ItemStack[] { SlimefunItems.COMPRESSED_CARBON });
-        registerRecipe(60, new ItemStack[] { SlimefunItems.CARBON_CHUNK, SlimefunItems.SYNTHETIC_DIAMOND }, new ItemStack[] { SlimefunItems.RAW_CARBONADO });
-        registerRecipe(60, new ItemStack[] { SlimefunItems.CARBON_CHUNK }, new ItemStack[] { SlimefunItems.SYNTHETIC_DIAMOND });
-        registerRecipe(90, new ItemStack[] { SlimefunItems.RAW_CARBONADO }, new ItemStack[] { SlimefunItems.CARBONADO });
+        registerRecipe(20, new ItemStack[] { new ItemStack(Material.COAL, 8) }, new ItemStack[] { SlimefunItems.CARBON.getDelegate() });
+        registerRecipe(180, new ItemStack[] { new ItemStack(Material.COAL_BLOCK, 8) }, new ItemStack[] { new SlimefunItemStack(SlimefunItems.CARBON, 9).getDelegate() });
+        registerRecipe(30, new ItemStack[] { new CustomItemStack(SlimefunItems.CARBON.getDelegate(), 4) }, new ItemStack[] { SlimefunItems.COMPRESSED_CARBON.getDelegate() });
+        registerRecipe(60, new ItemStack[] { SlimefunItems.CARBON_CHUNK.getDelegate(), SlimefunItems.SYNTHETIC_DIAMOND.getDelegate() }, new ItemStack[] { SlimefunItems.RAW_CARBONADO.getDelegate() });
+        registerRecipe(60, new ItemStack[] { SlimefunItems.CARBON_CHUNK.getDelegate() }, new ItemStack[] { SlimefunItems.SYNTHETIC_DIAMOND.getDelegate() });
+        registerRecipe(90, new ItemStack[] { SlimefunItems.RAW_CARBONADO.getDelegate() }, new ItemStack[] { SlimefunItems.CARBONADO.getDelegate() });
     }
 
     @Override

src/main/java/io/github/thebusybiscuit/slimefun4/implementation/items/electric/machines/ElectricDustWasher.java

@@ -48,21 +48,21 @@ protected MachineRecipe findNextRecipe(BlockMenu menu) {
         for (int slot : getInputSlots()) {
             ItemStack input = menu.getItemInSlot(slot);
             MachineRecipe recipe = null;
-            if (SlimefunUtils.isItemSimilar(input, SlimefunItems.SIFTED_ORE, true, false)) {
+            if (SlimefunUtils.isItemSimilar(input, SlimefunItems.SIFTED_ORE.getDelegate(), true, false)) {
                 if (!legacyMode && !hasFreeSlot(menu)) {
                     return null;
                 }
 
-                recipe = new MachineRecipe(4 / getSpeed(), new ItemStack[] { SlimefunItems.SIFTED_ORE }, new ItemStack[] { oreWasher.getRandomDust() });
+                recipe = new MachineRecipe(4 / getSpeed(), new ItemStack[] { SlimefunItems.SIFTED_ORE.getDelegate() }, new ItemStack[] { oreWasher.getRandomDust() });
 
                 if (!legacyMode || menu.fits(recipe.getOutput()[0], getOutputSlots())) {
                     menu.consumeItem(slot);
                     return recipe;
                 }
-            } else if (SlimefunUtils.isItemSimilar(input, SlimefunItems.PULVERIZED_ORE, true)) {
-                recipe = new MachineRecipe(4 / getSpeed(), new ItemStack[] { SlimefunItems.PULVERIZED_ORE }, new ItemStack[] { SlimefunItems.PURE_ORE_CLUSTER });
+            } else if (SlimefunUtils.isItemSimilar(input, SlimefunItems.PULVERIZED_ORE.getDelegate(), true)) {
+                recipe = new MachineRecipe(4 / getSpeed(), new ItemStack[] { SlimefunItems.PULVERIZED_ORE.getDelegate() }, new ItemStack[] { SlimefunItems.PURE_ORE_CLUSTER.getDelegate() });
             } else if (SlimefunUtils.isItemSimilar(input, new ItemStack(Material.SAND), true)) {
-                recipe = new MachineRecipe(4 / getSpeed(), new ItemStack[] { new ItemStack(Material.SAND) }, new ItemStack[] { SlimefunItems.SALT });
+                recipe = new MachineRecipe(4 / getSpeed(), new ItemStack[] { new ItemStack(Material.SAND) }, new ItemStack[] { SlimefunItems.SALT.getDelegate() });
             }
 
             if (recipe != null && menu.fits(recipe.getOutput()[0], getOutputSlots())) {