Merge branch 'release/1.0.2.4'

Author: Maxlego08

changelog.md

@@ -28,9 +28,22 @@
 - [ ] 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.
 
 # Unreleased
 
+# 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.
+- Added base64 MaterialLoader. Allows to load ItemStack with all the data it can contain.
+- Added cooldown on button click. The default cooldown will be 350ms.
+- Fix Folia with VersionChecker [#35](https://github.com/Maxlego08/zMenu/issues/35)
+- Fix error with mini message format in 1.16
+- Fix JUMP Button
+- Change `/zm save <item name> <base64/yml>`, saves an element in YML or base64 format. The base64 format will save the itemStack with all its data.
+- Change `page` from JUMP Button to `toPage` 
+
 # 1.0.2.3
 
 - Fixed the pattern display, they will now appear first and let the more important buttons pass over

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.4</version>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <maven.compiler.source>8</maven.compiler.source>

src/fr/maxlego08/menu/MenuPlugin.java

@@ -164,6 +164,7 @@ public void onEnable() {
         this.addSave(this.commandManager);
         this.addSave(this.dataManager);
 
+        this.inventoryManager.registerMaterialLoader(new Base64Loader());
         if (this.isEnable(Plugins.HEADDATABASE)) {
             this.inventoryManager.registerMaterialLoader(new HeadDatabaseLoader());
         }

src/fr/maxlego08/menu/ZInventoryManager.java

@@ -10,11 +10,17 @@
 import fr.maxlego08.menu.api.itemstack.ItemStackSimilar;
 import fr.maxlego08.menu.api.loader.MaterialLoader;
 import fr.maxlego08.menu.api.utils.MetaUpdater;
+import fr.maxlego08.menu.api.utils.OpenWithItem;
 import fr.maxlego08.menu.button.buttons.ZNoneButton;
-import fr.maxlego08.menu.button.loader.*;
+import fr.maxlego08.menu.button.loader.BackLoader;
+import fr.maxlego08.menu.button.loader.HomeLoader;
+import fr.maxlego08.menu.button.loader.JumpLoader;
+import fr.maxlego08.menu.button.loader.MainMenuLoader;
+import fr.maxlego08.menu.button.loader.NextLoader;
+import fr.maxlego08.menu.button.loader.NoneLoader;
+import fr.maxlego08.menu.button.loader.PreviousLoader;
 import fr.maxlego08.menu.exceptions.InventoryException;
 import fr.maxlego08.menu.exceptions.InventoryFileNotFound;
-import fr.maxlego08.menu.api.utils.OpenWithItem;
 import fr.maxlego08.menu.inventory.inventories.InventoryDefault;
 import fr.maxlego08.menu.itemstack.FullSimilar;
 import fr.maxlego08.menu.itemstack.LoreSimilar;
@@ -46,6 +52,7 @@
 import fr.maxlego08.menu.zcore.utils.ZUtils;
 import fr.maxlego08.menu.zcore.utils.loader.Loader;
 import fr.maxlego08.menu.zcore.utils.meta.Meta;
+import fr.maxlego08.menu.zcore.utils.nms.ItemStackUtils;
 import fr.maxlego08.menu.zcore.utils.storage.Persist;
 import org.bukkit.Bukkit;
 import org.bukkit.command.CommandSender;
@@ -519,7 +526,7 @@ public void updateInventory(Player player) {
     }
 
     @Override
-    public void saveItem(CommandSender sender, ItemStack itemStack, String name) {
+    public void saveItem(CommandSender sender, ItemStack itemStack, String name, String type) {
 
         File file = new File(this.plugin.getDataFolder(), "save_items.yml");
         if (!file.exists()) {
@@ -530,9 +537,9 @@ public void saveItem(CommandSender sender, ItemStack itemStack, String name) {
             }
         }
 
-        YamlConfiguration yamlConfiguration = YamlConfiguration.loadConfiguration(file);
+        YamlConfiguration configuration = YamlConfiguration.loadConfiguration(file);
 
-        ConfigurationSection configurationSection = yamlConfiguration.getConfigurationSection("items.");
+        ConfigurationSection configurationSection = configuration.getConfigurationSection("items.");
         if (configurationSection != null) {
             Set<String> names = configurationSection.getKeys(false);
             if (names.contains(name)) {
@@ -543,9 +550,25 @@ public void saveItem(CommandSender sender, ItemStack itemStack, String name) {
 
         Loader<MenuItemStack> loader = new MenuItemStackLoader(this);
         MenuItemStack menuItemStack = MenuItemStack.fromItemStack(this, itemStack);
-        loader.save(menuItemStack, yamlConfiguration, "items." + name + ".", file);
+        if (type.equalsIgnoreCase("yml")) {
+            loader.save(menuItemStack, configuration, "items." + name + ".", file);
+        } else if (type.equalsIgnoreCase("base64")) {
+
+            String base64 = ItemStackUtils.serializeItemStack(itemStack);
+            configuration.set("items." + name + ".material", "base64:" + base64);
+            try {
+                configuration.save(file);
+            } catch (IOException exception) {
+                exception.printStackTrace();
+            }
+
+        } else {
+            message(sender, Message.SAVE_ERROR_TYPE, "%name%", name);
+            return;
+        }
 
         message(sender, Message.SAVE_SUCCESS, "%name%", name);
+
     }
 
     @EventHandler

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

@@ -345,8 +345,9 @@ public interface InventoryManager extends Savable, Listener {
      * @param sender    Command Sender
      * @param itemStack The itemStack
      * @param name      The item name
+     * @param type
      */
-    void saveItem(CommandSender sender, ItemStack itemStack, String name);
+    void saveItem(CommandSender sender, ItemStack itemStack, String name, String type);
 
     /**
      * Transforms a string list into a click list type.

src/fr/maxlego08/menu/button/buttons/ZJumpButton.java

@@ -13,7 +13,7 @@ public class ZJumpButton extends ZNextButton {
     private final InventoryManager inventoryManager;
 
     /**
-     * @param page the real page(start from 0)
+     * @param page             the real page(start from 0)
      * @param inventoryManager the inventory manager
      */
     public ZJumpButton(InventoryManager inventoryManager, int page) {
@@ -32,6 +32,6 @@ public void onClick(Player player, InventoryClickEvent event, InventoryDefault i
 
     @Override
     public boolean checkPermission(Player player, InventoryDefault inventory) {
-        return page >= 0 && page <= inventory.getMaxPage();
+        return this.page != inventory.getPage();
     }
 }

src/fr/maxlego08/menu/button/loader/JumpLoader.java

@@ -1,6 +1,5 @@
 package fr.maxlego08.menu.button.loader;
 
-import fr.maxlego08.menu.MenuPlugin;
 import fr.maxlego08.menu.api.InventoryManager;
 import fr.maxlego08.menu.api.button.Button;
 import fr.maxlego08.menu.api.button.DefaultButtonValue;
@@ -35,7 +34,7 @@ public Plugin getPlugin() {
 
     @Override
     public Button load(YamlConfiguration configuration, String path, DefaultButtonValue defaultButtonValue) {
-        int page = configuration.getInt(path + "page");
+        int page = configuration.getInt(path + "toPage");
         return new ZJumpButton(this.inventoryManager, page);
     }
 }

src/fr/maxlego08/menu/command/commands/CommandMenuSave.java

@@ -9,12 +9,15 @@
 import org.bukkit.Material;
 import org.bukkit.inventory.ItemStack;
 
+import java.util.Arrays;
+
 public class CommandMenuSave extends VCommand {
 
     public CommandMenuSave(MenuPlugin plugin) {
         super(plugin);
         this.addSubCommand("save");
         this.addRequireArg("item name");
+        this.addRequireArg("type", (a, b) -> Arrays.asList("yml", "base64"));
         this.setDescription(Message.DESCRIPTION_SAVE);
         this.setPermission(Permission.ZMENU_SAVE);
         this.setConsoleCanUse(false);
@@ -25,13 +28,15 @@ protected CommandType perform(MenuPlugin plugin) {
 
         InventoryManager inventoryManager = plugin.getInventoryManager();
         String name = this.argAsString(0);
+        String type = this.argAsString(1);
+
         ItemStack itemStack = this.player.getItemInHand();
         if (itemStack == null || itemStack.getType() == Material.AIR) {
             message(this.sender, Message.SAVE_ERROR_EMPTY);
             return CommandType.DEFAULT;
         }
 
-        inventoryManager.saveItem(sender, itemStack, name);
+        inventoryManager.saveItem(sender, itemStack, name, type);
 
         return CommandType.SUCCESS;
     }

src/fr/maxlego08/menu/inventory/VInventory.java

@@ -43,88 +43,39 @@ public int getId() {
         return id;
     }
 
-    /**
-     * Inventory Id
-     *
-     * @param id
-     * @return
-     */
     public VInventory setId(int id) {
         this.id = id;
         return this;
     }
 
-    /**
-     * Allows you to create the spigot inventory object
-     *
-     * @param name
-     */
     protected void createInventory(String name) {
         createInventory(name, 54);
     }
 
-    /**
-     * Allows you to create the spigot inventory object
-     *
-     * @param name - Inventory name
-     * @param size - Inventory Size
-     */
     protected void createInventory(String name, int size) {
         this.guiName = name;
         this.inventory = Bukkit.createInventory(this, size, name);
     }
 
-    /**
-     * Allows you to create the spigot inventory object
-     *
-     * @param name - Inventory name
-     * @param size - Inventory Size
-     */
     protected void createMetaInventory(String name, int size) {
         this.guiName = name;
         this.inventory = Meta.meta.createInventory(name, size, this);
     }
 
-    /**
-     * Create default inventory with default size and name
-     */
     private void createDefaultInventory() {
         if (this.inventory == null) {
             this.inventory = Bukkit.createInventory(this, 54, "§cDefault Inventory");
         }
     }
 
-    /**
-     * Adding an item to the inventory
-     *
-     * @param slot     - Inventory slot
-     * @param material - ItemStack material
-     * @param name     - ItemStack name
-     * @return ItemButton
-     */
     public ItemButton addItem(int slot, Material material, String name) {
         return addItem(slot, new ItemBuilder(material, name).build());
     }
 
-    /**
-     * Adding an item to the inventory
-     *
-     * @param slot - Inventory slot
-     * @param item - ItemBuild
-     * @return ItemButton
-     */
     public ItemButton addItem(int slot, ItemBuilder item) {
         return addItem(slot, item.build());
     }
 
-    /**
-     * Adding an itemStack to the inventory
-     * Creates the default inventory if it does not exist
-     *
-     * @param slot      - Inventory slot
-     * @param itemStack - ItemStack
-     * @return ItemButton
-     */
     public ItemButton addItem(int slot, ItemStack itemStack) {
 
         createDefaultInventory();
@@ -145,85 +96,42 @@ public ItemButton addItem(int slot, ItemStack itemStack) {
         return button;
     }
 
-    /**
-     * Allows you to remove an item from the list of items
-     *
-     * @param slot
-     */
     public void removeItem(int slot) {
         this.items.remove(slot);
     }
 
-    /**
-     * Allows you to delete all items
-     */
     public void clearItem() {
         this.items.clear();
     }
 
-    /**
-     * Allows you to retrieve all items
-     *
-     * @return
-     */
     public Map<Integer, ItemButton> getItems() {
         return items;
     }
 
-    /**
-     * If the click in the inventory is disabled (which is the default)
-     * then it will return true
-     *
-     * @return vrai ou faux
-     */
     public boolean isDisableClick() {
         return disableClick;
     }
 
-    /**
-     * Change the ability to click in the inventory
-     *
-     * @param disableClick
-     */
     public void setDisableClick(boolean disableClick) {
         this.disableClick = disableClick;
     }
 
-    /**
-     * Allows to recover the player
-     *
-     * @return player
-     */
     public Player getPlayer() {
         return player;
     }
 
-    /**
-     * Allows you to retrieve the page
-     *
-     * @return the page
-     */
     public int getPage() {
         return page;
     }
 
-    /**
-     * @return the args
-     */
     public Object[] getArgs() {
         return args;
     }
 
-    /**
-     * @return the inventory
-     */
     public Inventory getSpigotInventory() {
         return inventory;
     }
 
-    /**
-     * @return the guiName
-     */
     public String getGuiName() {
         return guiName;
     }
@@ -245,19 +153,10 @@ protected void onPreClose(InventoryCloseEvent event, MenuPlugin plugin, Player p
         this.onClose(event, plugin, player);
     }
 
-    /**
-     * @param event
-     * @param plugin
-     * @param player
-     */
+
     protected void onClose(InventoryCloseEvent event, MenuPlugin plugin, Player player) {
     }
 
-    /**
-     * @param event
-     * @param plugin
-     * @param player
-     */
     protected void onDrag(InventoryDragEvent event, MenuPlugin plugin, Player player) {
     }