Expose some item- and inventory utilities

NichtStudioCode · NichtStudioCode · commit 78fc555158fa · 2026-05-03T23:18:38.000+02:00
diff --git a/invui-kotlin/src/main/kotlin/xyz/xenondevs/invui/dsl/WindowDsl.kt b/invui-kotlin/src/main/kotlin/xyz/xenondevs/invui/dsl/WindowDsl.kt
@@ -11,7 +11,7 @@ import xyz.xenondevs.commons.provider.mutableProvider
 import xyz.xenondevs.commons.provider.provider
 import xyz.xenondevs.invui.ClickEvent
 import xyz.xenondevs.invui.ExperimentalReactiveApi
-import xyz.xenondevs.invui.internal.util.InventoryUtils
+import xyz.xenondevs.invui.internal.util.InventoryUtils2
 import xyz.xenondevs.invui.window.Window
 import xyz.xenondevs.invui.window.setCloseable
 import xyz.xenondevs.invui.window.setTitle
@@ -488,7 +488,7 @@ internal abstract class AbstractSplitWindowDsl<W : Window, B : Window.Builder.Sp
     viewer: Player
 ) : AbstractWindowDsl<W, B>(viewer), SplitWindowDsl {
     
-    override val lowerGui = GuiDslProperty(9, 4) { InventoryUtils.createPlayerReferencingInventoryGui(viewer) }
+    override val lowerGui = GuiDslProperty(9, 4) { InventoryUtils2.createPlayerReferencingInventoryGui(viewer) }
     
     override fun applyToBuilder(builder: B) {
         super.applyToBuilder(builder)
diff --git a/invui/src/main/java/xyz/xenondevs/invui/internal/menu/CustomCartographyMenu.java b/invui/src/main/java/xyz/xenondevs/invui/internal/menu/CustomCartographyMenu.java
@@ -7,14 +7,14 @@
 import net.minecraft.network.protocol.game.ClientboundMapItemDataPacket;
 import net.minecraft.world.inventory.MenuType;
 import net.minecraft.world.level.saveddata.maps.*;
-import org.bukkit.Material;
 import org.bukkit.craftbukkit.inventory.CraftItemStack;
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.ItemType;
 import org.jspecify.annotations.Nullable;
 import xyz.xenondevs.invui.internal.network.PacketListener;
-import xyz.xenondevs.invui.internal.util.ItemUtils2;
 import xyz.xenondevs.invui.internal.util.MathUtils;
+import xyz.xenondevs.invui.util.ItemUtils;
 import xyz.xenondevs.invui.window.CartographyWindow;
 import xyz.xenondevs.invui.window.CartographyWindow.MapIcon;
 import xyz.xenondevs.invui.window.CartographyWindow.MapPatch;
@@ -55,12 +55,12 @@ public void setItem(int slot, @Nullable ItemStack item) {
             super.setItem(slot, clone);
         } else if (slot == 1 && item != null) {
             var targetType = switch (view) {
-                case NORMAL -> Material.STONE;
-                case SMALL -> Material.PAPER;
-                case DUPLICATE -> Material.MAP;
-                case LOCK -> Material.GLASS_PANE;
+                case NORMAL -> ItemType.STONE;
+                case SMALL -> ItemType.PAPER;
+                case DUPLICATE -> ItemType.MAP;
+                case LOCK -> ItemType.GLASS_PANE;
             };
-            super.setItem(slot, ItemUtils2.asType(item, targetType));
+            super.setItem(slot, ItemUtils.asType(item, targetType));
         } else {
             super.setItem(slot, item);
         }
diff --git a/invui/src/main/java/xyz/xenondevs/invui/internal/menu/CustomContainerMenu.java b/invui/src/main/java/xyz/xenondevs/invui/internal/menu/CustomContainerMenu.java
@@ -171,12 +171,12 @@ protected CustomContainerMenu(MenuType<?> menuType, org.bukkit.entity.Player pla
         this.serverPlayer = ((CraftPlayer) player).getHandle();
         this.containerId = serverPlayer.nextContainerCounter();
         
-        int size = InventoryUtils.getSizeOf(menuType) + LOWER_INVENTORY_SIZE;
+        int size = InventoryUtils2.getSizeOf(menuType) + LOWER_INVENTORY_SIZE;
         this.items = ArrayUtils.newArray(ItemStack[]::new, size, ItemStack.EMPTY);
         this.remoteSlots = ArrayUtils.newArrayBy(RemoteSlot.Synchronized[]::new, size, _ -> remoteSlot(ItemStack.EMPTY));
         this.remoteOffHand = remoteSlot(serverPlayer.getOffhandItem());
         
-        int dataSize = InventoryUtils.getDataSlotCountOf(menuType);
+        int dataSize = InventoryUtils2.getDataSlotCountOf(menuType);
         this.dataSlots = new int[dataSize];
         this.remoteDataSlots = new int[dataSize];
         
diff --git a/invui/src/main/java/xyz/xenondevs/invui/internal/menu/CustomPlainMenu.java b/invui/src/main/java/xyz/xenondevs/invui/internal/menu/CustomPlainMenu.java
@@ -1,7 +1,7 @@
 package xyz.xenondevs.invui.internal.menu;
 
 import org.bukkit.entity.Player;
-import xyz.xenondevs.invui.internal.util.InventoryUtils;
+import xyz.xenondevs.invui.internal.util.InventoryUtils2;
 
 /**
  * A packet-based generic menu.
@@ -18,7 +18,7 @@ public class CustomPlainMenu extends CustomContainerMenu {
      * @throws IllegalArgumentException if there is no matching generic menu type
      */
     public CustomPlainMenu(int width, int height, Player player) {
-        super(InventoryUtils.getMatchingGenericMenuType(width, height), player);
+        super(InventoryUtils2.getMatchingGenericMenuType(width, height), player);
     }
     
 }
diff --git a/invui/src/main/java/xyz/xenondevs/invui/internal/util/ArrayUtils.java b/invui/src/main/java/xyz/xenondevs/invui/internal/util/ArrayUtils.java
@@ -7,7 +7,9 @@
 import java.util.Set;
 import java.util.function.IntFunction;
 
-public class ArrayUtils {
+public final class ArrayUtils {
+    
+    private ArrayUtils() {}
     
     /**
      * Concatenates a single element with an array.
diff --git a/invui/src/main/java/xyz/xenondevs/invui/internal/util/CollectionUtils.java b/invui/src/main/java/xyz/xenondevs/invui/internal/util/CollectionUtils.java
@@ -10,7 +10,9 @@
 import java.util.function.Consumer;
 import java.util.function.Function;
 
-public class CollectionUtils {
+public final class CollectionUtils {
+    
+    private CollectionUtils() {}
     
     /**
      * Creates an unmodifiable view of the specified list, while performing an unchecked cast
diff --git a/invui/src/main/java/xyz/xenondevs/invui/internal/util/ComponentUtils.java b/invui/src/main/java/xyz/xenondevs/invui/internal/util/ComponentUtils.java
@@ -5,7 +5,9 @@
 import net.kyori.adventure.text.format.Style;
 import net.kyori.adventure.text.format.TextDecoration;
 
-public class ComponentUtils {
+public final class ComponentUtils {
+    
+    private ComponentUtils() {}
     
     private static final Style FORMATTING_TEMPLATE = Style.style()
         .color(NamedTextColor.WHITE)
diff --git a/invui/src/main/java/xyz/xenondevs/invui/internal/util/DataUtils.java b/invui/src/main/java/xyz/xenondevs/invui/internal/util/DataUtils.java
@@ -14,7 +14,9 @@
 
 import java.io.*;
 
-public class DataUtils {
+public final class DataUtils {
+    
+    private DataUtils() {}
     
     public static byte[] readByteArray(DataInputStream din) throws IOException {
         int size = din.readInt();
diff --git a/invui/src/main/java/xyz/xenondevs/invui/internal/util/FakeInventoryView.java b/invui/src/main/java/xyz/xenondevs/invui/internal/util/FakeInventoryView.java
@@ -10,7 +10,7 @@
 import org.jspecify.annotations.Nullable;
 
 @SuppressWarnings("UnstableApiUsage")
-public class FakeInventoryView implements InventoryView {
+public final class FakeInventoryView implements InventoryView {
     
     private final Player player;
     private final Inventory top;
diff --git a/invui/src/main/java/xyz/xenondevs/invui/internal/util/FuncUtils.java b/invui/src/main/java/xyz/xenondevs/invui/internal/util/FuncUtils.java
@@ -6,7 +6,9 @@
 
 import java.util.function.Supplier;
 
-public class FuncUtils {
+public final class FuncUtils {
+    
+    private FuncUtils() {}
     
     /**
      * Resolves the value from the given supplier, catching any exceptions that may occur and
diff --git a/invui/src/main/java/xyz/xenondevs/invui/internal/util/InventoryUtils2.java b/invui/src/main/java/xyz/xenondevs/invui/internal/util/InventoryUtils2.java
@@ -4,21 +4,19 @@
 import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap;
 import it.unimi.dsi.fastutil.ints.IntList;
 import net.minecraft.world.inventory.MenuType;
-import org.bukkit.Location;
-import org.bukkit.entity.Item;
 import org.bukkit.entity.Player;
 import org.bukkit.event.inventory.ClickType;
-import org.bukkit.event.player.PlayerDropItemEvent;
 import org.bukkit.inventory.InventoryView;
 import org.bukkit.inventory.ItemStack;
-import org.jspecify.annotations.Nullable;
 import xyz.xenondevs.invui.gui.Gui;
 import xyz.xenondevs.invui.inventory.Inventory;
 import xyz.xenondevs.invui.inventory.OperationCategory;
 import xyz.xenondevs.invui.inventory.ReferencingInventory;
 import xyz.xenondevs.invui.util.ItemUtils;
 
-public class InventoryUtils {
+public final class InventoryUtils2 {
+    
+    private InventoryUtils2() {}
     
     /**
      * Gets the amount of slots that a menu type has.
@@ -140,49 +138,6 @@ public static MenuType<?> getMatchingGenericMenuType(int width, int height) {
         };
     }
     
-    /**
-     * Spawns an item entity as if the player dropped it, also firing {@link PlayerDropItemEvent}.
-     *
-     * @param player    The player
-     * @param itemStack The item stack
-     * @return Whether the item was dropped. False if the event was cancelled.
-     */
-    @SuppressWarnings("UnstableApiUsage")
-    public static boolean dropItemLikePlayer(Player player, @Nullable ItemStack itemStack) {
-        if (ItemUtils.isEmpty(itemStack))
-            return true;
-        
-        Location location = player.getLocation();
-        location.add(0, 1.5, 0); // not the eye location
-        
-        Item item = location.getWorld().createEntity(location, Item.class);
-        item.setItemStack(itemStack.clone());
-        item.setPickupDelay(40);
-        item.setVelocity(location.getDirection().multiply(0.35));
-        
-        if (new PlayerDropItemEvent(player, item).callEvent()) {
-            location.getWorld().addEntity(item);
-            return true;
-        }
-        
-        return false;
-    }
-    
-    /**
-     * Adds an item stack to the player's inventory or drops it if it doesn't fit.
-     * Also fires {@link PlayerDropItemEvent}, effectively deleting the item if the event is cancelled.
-     *
-     * @param player    The player
-     * @param itemStack The item stack
-     */
-    public static void addToInventoryOrDrop(Player player, ItemStack itemStack) {
-        player.getInventory().addItem(itemStack.clone())
-            .entrySet()
-            .stream()
-            .findFirst()
-            .ifPresent(entry -> dropItemLikePlayer(player, entry.getValue()));
-    }
-    
     /**
      * Creates a new gui that references the player's inventory and handles interactions in the same way
      * that the player inventory does.
diff --git a/invui/src/main/java/xyz/xenondevs/invui/internal/util/ItemUtils2.java b/invui/src/main/java/xyz/xenondevs/invui/internal/util/ItemUtils2.java
@@ -1,24 +1,22 @@
 package xyz.xenondevs.invui.internal.util;
 
-import io.papermc.paper.datacomponent.DataComponentType;
 import io.papermc.paper.datacomponent.DataComponentTypes;
 import net.minecraft.core.component.DataComponents;
 import net.minecraft.world.item.component.BundleContents;
-import org.bukkit.Material;
-import org.bukkit.Registry;
 import org.bukkit.craftbukkit.inventory.CraftItemStack;
 import org.bukkit.inventory.ItemStack;
 import org.jspecify.annotations.Nullable;
 import xyz.xenondevs.invui.util.ItemUtils;
 
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Objects;
 
 import static io.papermc.paper.datacomponent.item.BundleContents.bundleContents;
 
 @SuppressWarnings("UnstableApiUsage")
-public class ItemUtils2 {
+public final class ItemUtils2 {
+    
+    private ItemUtils2() {}
     
     /**
      * Creates a new list where all intermediary empty item stacks are replaced with the non-empty placeholder item
@@ -223,36 +221,4 @@ public static void setSelectedBundleSlot(ItemStack bundle, int bundleSlot) {
         }
     }
     
-    /**
-     * Creates a new {@link ItemStack} of the given target type, copying all data components (prototype + patch) to
-     * the new item stack. This will make the new item stack look exactly like the original item stack, except
-     * that it is a different type.
-     *
-     * @param original   the original item stack to copy data components from
-     * @param targetType the target type of the new item stack
-     * @return a new item stack of the target type with all data components copied from the original item stack
-     */
-    public static ItemStack asType(ItemStack original, Material targetType) {
-        if (original.isEmpty())
-            return ItemStack.empty();
-        
-        ItemStack result = ItemStack.of(targetType, original.getAmount());
-        for (var type : Registry.DATA_COMPONENT_TYPE) {
-            if (original.hasData(type)) {
-                if (type instanceof DataComponentType.Valued<?> valuedType) {
-                    copyDataComponent(valuedType, original, result);
-                } else if (type instanceof DataComponentType.NonValued nonValuedType) {
-                    result.setData(nonValuedType);
-                }
-            } else {
-                result.unsetData(type);
-            }
-        }
-        return result;
-    }
-    
-    private static <T> void copyDataComponent(DataComponentType.Valued<T> type, ItemStack from, ItemStack to) {
-        to.setData(type, Objects.requireNonNull(from.getData(type)));
-    }
-    
 }
diff --git a/invui/src/main/java/xyz/xenondevs/invui/internal/util/MathUtils.java b/invui/src/main/java/xyz/xenondevs/invui/internal/util/MathUtils.java
@@ -2,8 +2,10 @@
 
 import java.util.Random;
 
-public class MathUtils {
+public final class MathUtils {
     
     public static final Random RANDOM = new Random();
     
+    private MathUtils() {}
+    
 }
diff --git a/invui/src/main/java/xyz/xenondevs/invui/internal/util/SlotUtils.java b/invui/src/main/java/xyz/xenondevs/invui/internal/util/SlotUtils.java
@@ -7,7 +7,9 @@
 
 import java.util.*;
 
-public class SlotUtils {
+public final class SlotUtils {
+    
+    private SlotUtils() {}
     
     public static SequencedSet<Integer> getSlotsRow(int row, int width) {
         var slots = new LinkedHashSet<Integer>();
diff --git a/invui/src/main/java/xyz/xenondevs/invui/internal/util/ThreadCheck.java b/invui/src/main/java/xyz/xenondevs/invui/internal/util/ThreadCheck.java
@@ -3,7 +3,9 @@
 import org.bukkit.Bukkit;
 import org.bukkit.entity.Entity;
 
-public class ThreadCheck {
+public final class ThreadCheck {
+    
+    private ThreadCheck() {}
     
     public static void checkOwnedBy(Entity entity) {
         if (Bukkit.isOwnedByCurrentRegion(entity))
diff --git a/invui/src/main/java/xyz/xenondevs/invui/util/InventoryUtils.java b/invui/src/main/java/xyz/xenondevs/invui/util/InventoryUtils.java
@@ -0,0 +1,56 @@
+package xyz.xenondevs.invui.util;
+
+import org.bukkit.Location;
+import org.bukkit.entity.Item;
+import org.bukkit.entity.Player;
+import org.bukkit.event.player.PlayerDropItemEvent;
+import org.bukkit.inventory.ItemStack;
+import org.jspecify.annotations.Nullable;
+
+public final class InventoryUtils {
+
+    private InventoryUtils() {}
+    
+    /**
+     * Spawns an item entity as if the player dropped it, also firing {@link PlayerDropItemEvent}.
+     *
+     * @param player    The player
+     * @param itemStack The item stack
+     * @return Whether the item was dropped. False if the event was cancelled.
+     */
+    @SuppressWarnings("UnstableApiUsage")
+    public static boolean dropItemLikePlayer(Player player, @Nullable ItemStack itemStack) {
+        if (ItemUtils.isEmpty(itemStack))
+            return true;
+        
+        Location location = player.getLocation();
+        location.add(0, 1.5, 0); // not the eye location
+        
+        Item item = location.getWorld().createEntity(location, Item.class);
+        item.setItemStack(itemStack.clone());
+        item.setPickupDelay(40);
+        item.setVelocity(location.getDirection().multiply(0.35));
+        
+        if (new PlayerDropItemEvent(player, item).callEvent()) {
+            location.getWorld().addEntity(item);
+            return true;
+        }
+        
+        return false;
+    }
+    
+    /**
+     * Adds an item stack to the player's inventory or drops it if it doesn't fit.
+     * Also fires {@link PlayerDropItemEvent}, effectively deleting the item if the event is cancelled.
+     *
+     * @param player    The player
+     * @param itemStack The item stack
+     */
+    public static void addToInventoryOrDrop(Player player, ItemStack itemStack) {
+        player.getInventory().addItem(itemStack.clone())
+            .entrySet()
+            .stream()
+            .findFirst()
+            .ifPresent(entry -> dropItemLikePlayer(player, entry.getValue()));
+    }
+}
diff --git a/invui/src/main/java/xyz/xenondevs/invui/util/ItemUtils.java b/invui/src/main/java/xyz/xenondevs/invui/util/ItemUtils.java
diff --git a/invui/src/main/java/xyz/xenondevs/invui/window/AbstractSplitWindow.java b/invui/src/main/java/xyz/xenondevs/invui/window/AbstractSplitWindow.java
diff --git a/invui/src/main/java/xyz/xenondevs/invui/window/AbstractWindow.java b/invui/src/main/java/xyz/xenondevs/invui/window/AbstractWindow.java
diff --git a/invui/src/test/java/xyz/xenondevs/invui/internal/util/InventoryUtilsTest.java b/invui/src/test/java/xyz/xenondevs/invui/internal/util/InventoryUtilsTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`package xyz.xenondevs.invui.internal.menu;`
`2`	`2`
`3`	`3`	`import org.bukkit.entity.Player;`
`4`		`-import xyz.xenondevs.invui.internal.util.InventoryUtils;`
	`4`	`+import xyz.xenondevs.invui.internal.util.InventoryUtils2;`
`5`	`5`
`6`	`6`	`/**`
`7`	`7`	`* A packet-based generic menu.`
`@@ -18,7 +18,7 @@ public class CustomPlainMenu extends CustomContainerMenu {`
`18`	`18`	`* @throws IllegalArgumentException if there is no matching generic menu type`
`19`	`19`	`*/`
`20`	`20`	`public CustomPlainMenu(int width, int height, Player player) {`
`21`		`- super(InventoryUtils.getMatchingGenericMenuType(width, height), player);`
	`21`	`+ super(InventoryUtils2.getMatchingGenericMenuType(width, height), player);`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`}`