Merge pull request #31 from OneLiteFeatherNET/develop

Release 1.11.0

Author: theEvilReaper

build.gradle.kts

@@ -7,7 +7,7 @@ plugins {
 }
 
 group = "net.theevilreaper"
-version = "1.10.1"
+version = "1.11.0"
 description = "Aves"
 
 java {

settings.gradle.kts

@@ -26,7 +26,7 @@ dependencyResolutionManagement {
     }
     versionCatalogs {
         create("libs") {
-            version("bom", "1.4.0")
+            version("bom", "1.4.2")
             version("publishdata", "1.4.0")
             library("mycelium.bom", "net.onelitefeather", "mycelium-bom").versionRef("bom")
             library("minestom","net.minestom", "minestom").withoutVersion()

src/main/java/net/theevilreaper/aves/inventory/InventoryBuilder.java

@@ -25,10 +25,12 @@
 import org.slf4j.LoggerFactory;
 
 import java.util.Locale;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
 
 /**
  * @author Patrick Zdarsky / Rxcki
- * @version 1.2.0
+ * @version 1.3.0
  * @since 1.0.12
  */
 @SuppressWarnings("java:S3252")
@@ -53,34 +55,55 @@ public abstract class InventoryBuilder {
     protected InventoryBuilder(@NotNull InventoryType type) {
         this.type = type;
 
-        this.inventoryClick = (player, slot, clickType) -> {
-            if (slot == InventoryConstants.INVALID_SLOT_ID) return ClickHolder.noClick();
+        this.inventoryClick = (player, slot, clickType, stack, result) -> {
+            if (slot == InventoryConstants.INVALID_SLOT_ID) {
+                result.accept(ClickHolder.noClick());
+                return;
+            }
 
             if (this.dataLayout != null) {
                 var clickedSlot = this.dataLayout.getSlot(slot);
-                return acceptClick(clickedSlot, player, clickType, slot);
+                acceptClick(clickedSlot, player, clickType, slot, stack, result);
+                return;
             }
 
             if (this.inventoryLayout != null) {
                 var clickedSlot = this.inventoryLayout.getSlot(slot);
-                return acceptClick(clickedSlot, player, clickType, slot);
+                acceptClick(clickedSlot, player, clickType, slot, stack, result);
+                return;
             }
 
-            return ClickHolder.noClick();
+            result.accept(ClickHolder.noClick());
         };
     }
 
     /**
      * Handles the click request on a given slot.
      *
-     * @param slot      the {@link ISlot} which is clicked
-     * @param player    the {@link Player} who is involved
-     * @param clickType the given {@link ClickType}
+     * @param slot   the {@link ISlot} which is clicked
+     * @param player the {@link Player} who is involved
+     * @param click  the given {@link ClickType}
+     * @param slotID the slot ID which is clicked
+     * @param stack  the {@link ItemStack} which is clicked
+     * @param result the consumer to accept the {@link ClickHolder} result
      */
-    private @NotNull ClickHolder acceptClick(@Nullable ISlot slot, @NotNull Player player, @NotNull Click clickType, int slotID) {
-        if (slot == null) return ClickHolder.noClick();
-        if (slot instanceof EmptySlot) return ClickHolder.noClick();
-        return slot.getClick().onClick(player, slotID, clickType);
+    private void acceptClick(
+            @Nullable ISlot slot,
+            @NotNull Player player,
+            @NotNull Click click,
+            int slotID,
+            @NotNull ItemStack stack,
+            @NotNull Consumer<ClickHolder> result
+    ) {
+        if (slot == null) {
+            result.accept(ClickHolder.noClick());
+            return;
+        }
+        if (slot instanceof EmptySlot) {
+            result.accept(ClickHolder.noClick());
+            return;
+        }
+        slot.getClick().onClick(player, slotID, click, stack, result);
     }
 
     /**

src/main/java/net/theevilreaper/aves/inventory/InventoryListenerHandler.java

@@ -14,12 +14,14 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.util.function.Consumer;
+
 /**
  * Handles the {@link EventListener} creation for some {@link InventoryEvent}'s.
  * The class reduces some duplicated code parts in the inventory system.
  *
  * @author theEvilReaper
- * @version 1.0.0
+ * @version 1.1.0
  * @since 1.0.0
  **/
 sealed interface InventoryListenerHandler permits BaseInventoryBuilderImpl {
@@ -130,15 +132,16 @@ default EventListener<InventoryPreClickEvent> registerClick(
     ) {
         return EventListener.of(InventoryPreClickEvent.class, event -> {
             if (event.getInventory() instanceof CustomInventory customInventory && customInventory.getHolder() == holder) {
-                ClickHolder click = builder.inventoryClick.onClick(event.getPlayer(), event.getSlot(), event.getClick());
-
-                switch (click) {
-                    case ClickHolder.CancelClick ignored1 -> event.setCancelled(true);
-                    case ClickHolder.MinestomClick(@NotNull Click minestomClick) -> event.setClick(minestomClick);
-                    case ClickHolder.NOPClick ignored -> {
-                        // No operation
+                Consumer<ClickHolder> result = click -> {
+                    switch (click) {
+                        case ClickHolder.CancelClick ignored1 -> event.setCancelled(true);
+                        case ClickHolder.MinestomClick(@NotNull Click minestomClick) -> event.setClick(minestomClick);
+                        case ClickHolder.NOPClick ignored -> {
+                            // No operation
+                        }
                     }
-                }
+                };
+                builder.inventoryClick.onClick(event.getPlayer(), event.getSlot(), event.getClick(), event.getClickedItem(), result);
             }
         });
     }

src/main/java/net/theevilreaper/aves/inventory/function/InventoryClick.java

@@ -3,26 +3,37 @@
 import net.minestom.server.entity.Player;
 import net.minestom.server.inventory.click.Click;
 import net.minestom.server.inventory.click.ClickType;
+import net.minestom.server.item.ItemStack;
 import net.theevilreaper.aves.inventory.click.ClickHolder;
 import net.theevilreaper.aves.inventory.slot.ISlot;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.function.Consumer;
+
 /**
  * Represents a click function which can be applied to an implementation from the {@link ISlot} interface.
  *
  * @author theEvilReaper
  * @version 1.0.0
- * @since 1.2.0
+ * @since 1.3.0
  **/
 @FunctionalInterface
 public interface InventoryClick {
 
     /**
-     * Handles what happen when a player clicks on an item in a inventory.
+     * Handles what happen when a player clicks on an item in an inventory.
      *
-     * @param player    the {@link Player} who is involved
-     * @param clickType the given {@link ClickType}
-     * @param slot      the clicked slot as int
+     * @param player the {@link Player} who is involved
+     * @param slot   the clicked slot as int
+     * @param click  the given {@link ClickType}
+     * @param stack  the {@link ItemStack} which was clicked
+     * @param result a {@link Consumer} which will be called with a {@link ClickHolder} to handle the result of the click
      */
-    @NotNull ClickHolder onClick(@NotNull Player player, int slot, @NotNull Click clickType);
+    void onClick(
+            @NotNull Player player,
+            int slot, @NotNull
+            Click click,
+            @NotNull ItemStack stack,
+            @NotNull Consumer<@NotNull ClickHolder> result
+    );
 }

src/main/java/net/theevilreaper/aves/inventory/pageable/PlayerPageableInventoryImpl.java

@@ -92,14 +92,14 @@ public final class PlayerPageableInventoryImpl implements PageableInventory {
         ISlot givenForwardSlot = this.layout.getSlot(this.pageableControls.getNextSlot());
         this.forwardSlot = givenForwardSlot == null ? BLANK_SLOT : ISlot.of(givenForwardSlot);
 
-        this.forwardClick = (clickPlayer, slot, click) -> {
+        this.forwardClick = (clickPlayer, slot, click, stack, result) -> {
             this.update(PageAction.FORWARD);
-            return ClickHolder.cancelClick();
+            result.accept(ClickHolder.cancelClick());
         };
 
-        this.backwardsClick = (clickPlayer, slot, click) -> {
+        this.backwardsClick = (clickPlayer, slot, click,  stack,result) -> {
             this.update(PageAction.BACKWARDS);
-            return ClickHolder.cancelClick();
+            result.accept(ClickHolder.cancelClick());
         };
 
         this.builder.setDataLayoutFunction(inventoryLayout -> dataLayout);

src/main/java/net/theevilreaper/aves/inventory/util/InventoryConstants.java

@@ -15,7 +15,7 @@
  **/
 public final class InventoryConstants {
 
-    public static final InventoryClick CANCEL_CLICK = (player, slot, click) -> ClickHolder.cancelClick();
+    public static final InventoryClick CANCEL_CLICK = (player, slot, click, stack, result) -> result.accept(ClickHolder.cancelClick());
     @Deprecated(forRemoval = true, since = "Not needed anymore due to the changes to the inventory system")
     public static final Consumer<CancellableEvent> CANCELLABLE_EVENT = event -> event.setCancelled(true);
     public static final EmptySlot BLANK_SLOT = new EmptySlot();

src/main/java/net/theevilreaper/aves/map/BaseMap.java

@@ -46,45 +46,6 @@ public BaseMap(@NotNull String name, Pos spawn, String... builders) {
         this.spawn = spawn;
     }
 
-    /**
-     * Creates a new instance from the {@link BaseMap} with all given values.
-     * Deprecated since 1.9.0, use {@link #builder()} instead.
-     *
-     * @param name the name from the map
-     */
-    @Deprecated(forRemoval = true, since = "1.9.0")
-    @Contract(value = "_ -> new", pure = true)
-    public static @NotNull BaseMap of(@NotNull String name) {
-        return new BaseMap(name, null);
-    }
-
-    /**
-     * The constructor sets all relevant values for a map.
-     * Deprecated since 1.9.0, use {@link #builder()} instead.
-     *
-     * @param name  the name from the map
-     * @param spawn the spawn location from the map
-     */
-    @Deprecated(forRemoval = true, since = "1.9.0")
-    @Contract(value = "_, _ -> new", pure = true)
-    public static @NotNull BaseMap of(@NotNull String name, Pos spawn) {
-        return new BaseMap(name, spawn, "team");
-    }
-
-    /**
-     * The constructor sets all relevant values for a map.
-     * Deprecated since 1.9.0, use {@link #builder()} instead.
-     *
-     * @param name     the name from the map
-     * @param builders the builders from the map
-     * @param spawn    the spawn location from the map
-     */
-    @Contract(value = "_, _, _ -> new", pure = true)
-    @Deprecated(forRemoval = true, since = "1.9.0")
-    public static @NotNull BaseMap of(@NotNull String name, Pos spawn, String... builders) {
-        return new BaseMap(name, spawn, builders);
-    }
-
     /**
      * Creates a new instance of the {@link BaseMapBuilder} to build a new map.
      * The builder can be used to set all values that are required for a map.

src/test/java/net/theevilreaper/aves/file/FileHandlerTest.java

@@ -41,7 +41,7 @@ void testOtherConstructor() {
     @Test
     void testGsonFileHandlerWrite() {
         var path = tempDir.toPath().resolve(testMap);
-        var baseMap = BaseMap.of("TestMap");
+        var baseMap = new BaseMap("TestMap", null);
         baseMap.setBuilders("Builder1", "Builder2");
         fileHandler.save(path, baseMap);
         assertTrue(Files.exists(path));

src/test/java/net/theevilreaper/aves/file/ModernFileHandlerTest.java

@@ -46,7 +46,7 @@ void testOtherConstructor() {
     @Test
     void testGsonFileHandlerWrite() {
         var path = tempDir.toPath().resolve(testMap);
-        var baseMap = BaseMap.of("TestMap");
+        var baseMap = new BaseMap("TestMap", null);
         baseMap.setBuilders("Builder1", "Builder2");
         fileHandler.save(path, baseMap, TypeToken.get(BaseMap.class));
         assertTrue(Files.exists(path));
@@ -77,7 +77,7 @@ void testFileNotExistsRead() {
     @Test
     void testInvalidPathSave() {
         var path = tempDir.toPath();
-        var baseMap = BaseMap.of("TestMap");
+        var baseMap = new BaseMap("TestMap", null);
         var exception = assertThrows(
                 IllegalArgumentException.class,
                 () -> fileHandler.save(path, baseMap, TypeToken.get(BaseMap.class))