Merge branch 'release/1.0.2.5'

Author: Maxlego08

changelog.md

@@ -24,15 +24,27 @@
 - [ ] Add the Pagination button, it will allow to take an input number, an output number and browse the value number
 - [ ] Add a way to display the list of online players in a button list
 - [ ] Add Citizen and [ZNPCsPlus](https://www.spigotmc.org/resources/znpcsplus.109380/) support to open an inventory by clicking on an NPC
-- [ ] Add a tool to transform ItemStack to base64 and vice versa. This tool can be used to all my plugins.
+- [x] Add a tool to transform ItemStack to base64 and vice versa. This tool can be used to all my plugins.
 - [ ] Fix the bug about the `clearInventory: true`. It does not restore inventory when the menu is closed.
 - [ ] Add the support for the `http://textures.minecraft.net/texture/e34969c2684e4f62d5f87875460441a9f849d296c01e4c621636bb6acda696f7` in the URL of a custom head.
 - [ ] Update pom.xml for add {projet.version} in plugin.yml
 - [ ] Add matrix support for slot (like this: https://abstractmenus.github.io/docs/general/item_format.html#way-4-matrix)
 - [ ] Adding more logs on the errors that can occur with custom items like ItemAdder, this will cause an error but the user will not have the information of why, for example when the item does not exist.
+- [ ] Create a new class for loading buttons to add more elements, like a boolean to check if the button needs an itemstack
 
 # Unreleased
 
+# 1.0.2.5
+
+- Add new lore as string support
+- Fix itemstack amount of 0
+- Support file with space
+- Improved API, added many new methods to make API more permissive.
+- Patterns can now be on multiple pages
+- Add custom sound to SoundOption
+- Added ability to add arguments and select page for INVENTORY button [#45](https://github.com/Maxlego08/zMenu/issues/45)
+- Change update interval to milliseconds [#37](https://github.com/Maxlego08/zMenu/issues/37)
+
 # 1.0.2.4
 
 - Added replacement of , by . for  placeholders requirements. If your placeholder returns a number with a comma instead of a period, the plugin can handle that.

dependency-reduced-pom.xml

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>fr.maxlego08</groupId>
   <artifactId>zmenu</artifactId>
-  <version>1.0.2.3</version>
+  <version>1.0.2.5</version>
   <build>
     <sourceDirectory>src</sourceDirectory>
     <plugins>

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>fr.maxlego08</groupId>
     <artifactId>zmenu</artifactId>
-    <version>1.0.2.4</version>
+    <version>1.0.2.5</version>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <maven.compiler.source>8</maven.compiler.source>

src/fr/maxlego08/menu/MenuItemStack.java

@@ -200,7 +200,7 @@ public ItemStack build(Player player, boolean useCache) {
             return null;
         }
 
-        itemStack.setAmount(amount);
+        itemStack.setAmount(amount <= 0 ? 1 : amount);
 
         if (this.durability != 0) {
             itemStack.setDurability((short) this.durability);

src/fr/maxlego08/menu/MenuPlugin.java

@@ -216,6 +216,11 @@ public void onEnable() {
             Logger.info("DupeManager: " + this.dupeManager);
         }
 
+        Logger.info("");
+        Logger.info("You can support zMenu by upgrading your account here: https://minecraft-inventory-builder.com/account-upgrade");
+        Logger.info("zMenu’s site includes an inventory editor (under development), a marketplace (already available) is a forum (under development)");
+        Logger.info("");
+
         this.postEnable();
     }
 

src/fr/maxlego08/menu/ZInventory.java

@@ -2,17 +2,18 @@
 
 import fr.maxlego08.menu.api.Inventory;
 import fr.maxlego08.menu.api.button.Button;
-import fr.maxlego08.menu.api.utils.OpenWithItem;
 import fr.maxlego08.menu.api.pattern.Pattern;
 import fr.maxlego08.menu.api.players.inventory.InventoriesPlayer;
 import fr.maxlego08.menu.api.requirement.Requirement;
+import fr.maxlego08.menu.api.utils.OpenWithItem;
 import fr.maxlego08.menu.inventory.inventories.InventoryDefault;
 import fr.maxlego08.menu.zcore.utils.inventory.InventoryResult;
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.InventoryHolder;
 import org.bukkit.plugin.Plugin;
 
 import java.io.File;
+import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
@@ -82,6 +83,7 @@ public Plugin getPlugin() {
     }
 
     @Override
+    @Deprecated
     public int getMaxPage(Player player, Object... objects) {
         Optional<Integer> optional = this.buttons.stream().map(Button::getSlot).max(Integer::compare);
         if (optional.isPresent()) {
@@ -91,6 +93,20 @@ public int getMaxPage(Player player, Object... objects) {
         return 1;
     }
 
+    @Override
+    public int getMaxPage(Collection<Pattern> patterns, Player player, Object... objects) {
+        List<Button> buttons = new ArrayList<>();
+        buttons.addAll(this.buttons);
+        buttons.addAll(patterns.stream().flatMap(pattern -> pattern.getButtons().stream()).collect(Collectors.toList()));
+
+        Optional<Integer> optional = buttons.stream().map(Button::getSlot).max(Integer::compare);
+        if (optional.isPresent()) {
+            int maxSlot = optional.get();
+            return (maxSlot / this.size) + 1;
+        }
+        return 1;
+    }
+
     @Override
     public List<Button> sortButtons(int page, Object... objects) {
         return this.buttons.stream().filter(button -> {
@@ -99,6 +115,15 @@ public List<Button> sortButtons(int page, Object... objects) {
         }).collect(Collectors.toList());
     }
 
+    @Override
+    public List<Button> sortPatterns(Pattern pattern, int page, Object... objects) {
+        if (!pattern.enableMultiPage()) return new ArrayList<>(pattern.getButtons());
+        return pattern.getButtons().stream().filter(button -> {
+            int slot = button.getRealSlot(this.size, page);
+            return slot >= 0 && slot < this.size;
+        }).collect(Collectors.toList());
+    }
+
     @Override
     public InventoryResult openInventory(Player player, InventoryDefault inventoryDefault) {
 
@@ -187,6 +212,10 @@ public Requirement getOpenRequirement() {
         return this.openRequirement;
     }
 
+    public void setOpenRequirement(Requirement openRequirement) {
+        this.openRequirement = openRequirement;
+    }
+
     @Override
     public OpenWithItem getOpenWithItem() {
         return this.openWithItem;
@@ -196,10 +225,6 @@ public void setOpenWithItem(OpenWithItem openWithItem) {
         this.openWithItem = openWithItem;
     }
 
-    public void setOpenRequirement(Requirement openRequirement) {
-        this.openRequirement = openRequirement;
-    }
-
     public void setClearInventory(boolean clearInventory) {
         this.clearInventory = clearInventory;
     }

src/fr/maxlego08/menu/ZInventoryManager.java

@@ -40,6 +40,7 @@
 import fr.maxlego08.menu.loader.actions.PlayerCommandLoader;
 import fr.maxlego08.menu.loader.actions.ShopkeeperLoader;
 import fr.maxlego08.menu.loader.actions.SoundLoader;
+import fr.maxlego08.menu.loader.actions.TitleLoader;
 import fr.maxlego08.menu.loader.permissible.ItemPermissibleLoader;
 import fr.maxlego08.menu.loader.permissible.PermissionPermissibleLoader;
 import fr.maxlego08.menu.loader.permissible.PlaceholderPermissibleLoader;
@@ -269,6 +270,7 @@ public void loadButtons() {
         buttonManager.registerAction(new ConsoleCommandLoader());
         buttonManager.registerAction(new fr.maxlego08.menu.loader.actions.BackLoader(this.plugin));
         buttonManager.registerAction(new ShopkeeperLoader());
+        buttonManager.registerAction(new TitleLoader());
 
         // Loading ButtonLoader
         // The first step will be to load the buttons in the plugin, so each
@@ -277,7 +279,7 @@ public void loadButtons() {
         buttonManager.register(new NoneLoader(this.plugin, ZNoneButton.class, "none"));
         buttonManager.register(new NoneLoader(this.plugin, ZNoneButton.class, "none_slot"));
         buttonManager.register(new NoneLoader(this.plugin, ZNoneButton.class, "perform_command"));
-        buttonManager.register(new fr.maxlego08.menu.button.loader.InventoryLoader(this.plugin, this));
+        buttonManager.register(new fr.maxlego08.menu.button.loader.InventoryLoader(this.plugin, this, this.plugin.getCommandManager()));
         buttonManager.register(new BackLoader(this.plugin, this));
         buttonManager.register(new HomeLoader(this.plugin, this));
         buttonManager.register(new NextLoader(this.plugin, this));

src/fr/maxlego08/menu/api/Inventory.java

@@ -81,8 +81,19 @@ public interface Inventory {
      * @param objects Additional elements.
      * @return The maximum number of pages.
      */
+    @Deprecated
     int getMaxPage(Player player, Object... objects);
 
+    /**
+     * Returns the maximum number of pages for the inventory.
+     *
+     * @param patterns Pattern list
+     * @param player  The player for whom the page count is determined.
+     * @param objects Additional elements.
+     * @return The maximum number of pages.
+     */
+    int getMaxPage(Collection<Pattern> patterns, Player player, Object... objects);
+
     /**
      * Sorts the buttons based on the current page and additional elements.
      *
@@ -92,6 +103,16 @@ public interface Inventory {
      */
     List<Button> sortButtons(int page, Object... objects);
 
+    /**
+     * Sorts the pattern buttons based on the current page and additional elements.
+     *
+     * @param pattern The pattern
+     * @param page    The current page.
+     * @param objects Additional elements.
+     * @return A list of sorted buttons.
+     */
+    List<Button> sortPatterns(Pattern pattern, int page, Object... objects);
+
     /**
      * Opens the inventory for a player and returns the result of the operation.
      *

src/fr/maxlego08/menu/api/button/Button.java

@@ -10,6 +10,7 @@
 import fr.maxlego08.menu.inventory.inventories.InventoryDefault;
 import org.bukkit.entity.Player;
 import org.bukkit.event.inventory.InventoryClickEvent;
+import org.bukkit.event.inventory.InventoryDragEvent;
 import org.bukkit.inventory.ItemStack;
 
 import java.util.List;
@@ -251,4 +252,34 @@ public interface Button extends PermissibleButton, PlaceholderButton, SlotButton
      * @return actions
      */
     List<Action> getActions();
+
+    /**
+     * Called when the player drags items within the inventory or from their player inventory into the zMenu inventory.
+     * This method allows for custom drag behavior to be implemented, providing flexibility in how items can be moved
+     * around within an inventory and how these actions interact with the overall functionality of the menu.
+     *
+     * Implementations can use this method to prevent unwanted item movements, to trigger specific actions when
+     * certain items are dragged to specific slots, or to manage the addition or removal of items in custom ways
+     * that align with the menu's logic and requirements.
+     *
+     * @param event            The inventory drag event that occurred, containing details about the drag action.
+     * @param player           The player who performed the drag action.
+     * @param inventoryDefault The zMenu inventory where the drag action occurred, providing context for the action
+     *                         and allowing for inventory-specific handling.
+     */
+    void onDrag(InventoryDragEvent event, Player player, InventoryDefault inventoryDefault);
+
+    /**
+     * Called when the player clicks an item within the zMenu inventory. This method is a general handler for all
+     * inventory click events, offering a centralized way to manage interactions within the inventory. It can be used
+     * to implement custom click behavior on a global scale, regardless of the specific button or slot clicked.
+     *
+     * @param event            The inventory click event that occurred, including details such as the click type
+     *                         and the slot that was clicked.
+     * @param player           The player who performed the click action.
+     * @param inventoryDefault The zMenu inventory where the click action occurred, providing the context needed
+     *                         to appropriately respond to the interaction.
+     */
+    void onInventoryClick(InventoryClickEvent event, Player player, InventoryDefault inventoryDefault);
+
 }

src/fr/maxlego08/menu/api/button/buttons/InventoryButton.java

@@ -2,19 +2,49 @@
 
 import fr.maxlego08.menu.api.button.Button;
 
+import java.util.List;
+
 /**
- * Represents a button that allows the player to open a new inventory.
- * The inventory to be opened is specified by its unique identifier.
+ * Represents a button within a user interface in a Minecraft plugin that allows the player
+ * to open a new inventory. This interface extends the basic functionality of a Button
+ * to specifically handle inventory interactions, enabling the creation of complex GUIs
+ * where actions can lead to different inventory screens.
+ * <p>
+ * The inventory to be opened by this button is identified by a unique identifier, allowing
+ * for dynamic and flexible GUI navigation based on the game's logic or player's actions.
+ * Additional parameters such as arguments and page numbers can be used to further customize
+ * the behavior or content of the inventory to be opened.
+ * </p>
  */
 public interface InventoryButton extends Button {
 
     /**
-     * Returns the unique identifier of the inventory to be opened.
+     * Returns the unique identifier of the inventory to be opened when this button is interacted with.
+     * This identifier is used to determine which inventory screen is to be displayed to the player,
+     * facilitating the linking of multiple GUI screens within the plugin.
      *
-     * @return The identifier of the target inventory.
+     * @return The unique identifier of the target inventory as a {@code String}.
      */
     String getInventory();
 
-    // Additional documentation or context can be added here if needed
+    /**
+     * Provides a list of arguments that may be required for opening the inventory.
+     * These arguments can include specific details or parameters that modify the
+     * inventory's appearance or functionality, allowing for a dynamic and contextual
+     * user experience based on the game's state or player's input.
+     *
+     * @return A list of {@code String} arguments that are associated with the inventory to be opened.
+     */
+    List<String> getArguments();
+
+    /**
+     * Retrieves the page number of the inventory to be opened if the inventory supports pagination.
+     * This is useful for inventories that display a large amount of content that is divided across
+     * multiple pages, allowing users to navigate through pages of items or options.
+     *
+     * @return The page number as an {@code int} indicating which page of the inventory should be shown.
+     */
+    int getToPage();
 
 }
+