Merge branch 'release/1.0.3.5'

Author: Maxlego08

changelog.md

@@ -1,14 +1,10 @@
 # ToDo
 
-- [x] Add anti dupe system with NMS Tag
-- [x] Add the BACK action, to return to the previous inventory when clicking
-- [x] Add the ability to perform actions when clicking
 - [ ] Improve the firework system to put more buttonOption. Being able to put several effects, power etc.
 - [ ] Add a system that allows you to cache an ItemStack, so instead of returning the ItemStack at each opening, there
   can be several minutes without having to recreate a new ItemStack. For decorations, buttons without placeholders for
   example.
 - [ ] Add an order to display the list of official addons.
-- [ ] Add a ``/zm help`` command to send to documentation.
 - [ ] Add a ``/zm command <command> <inventory>`` command to create an order file for an inventory.
 - [ ] Add a system to translate plugin messages.
 - [ ] Update developer doc
@@ -29,27 +25,29 @@
 - [ ] 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
-- [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
 - [ ] Can split a file into several and thus avoid having too large files
-- [x] Add open link with a book
 - [ ] Add slot type for create pattern (Allows to fill slot areas as do the outline of the inventory)
-- [ ] Be able to set default values for player data
-- [x] Create a command `/zm download <link>` to download a configuration from a link (Allows to simply share its
-  configurations, from discord for example)
 
 # Unreleased
 
+# 1.0.3.5
+
+- Added support for DeluxeMenus configurations. You no longer need to convert your DeluxeMenu configurations to zMenu, they are now automatically compatible!
+- Added command ``/zm documentation [<word>]``
+- Added key `title` for inventory name, you can use `name` or `title` now
+- Fixed itemstack with 1.21, components was added when it should not be added by default.
+- Fixed the item backup system for potions and firework (use in `/zm save` command and in `zEssentials`)
+
 # 1.0.3.4
 
 - Add support for ``\n`` in item lore

dependency-reduced-pom.xml

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>fr.maxlego08</groupId>
   <artifactId>zmenu</artifactId>
-  <version>1.0.3.4</version>
+  <version>1.0.3.5</version>
   <build>
     <sourceDirectory>src</sourceDirectory>
     <resources>

pom.xml

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

src/fr/maxlego08/menu/MenuItemStack.java

@@ -25,6 +25,7 @@
 import org.bukkit.Bukkit;
 import org.bukkit.Color;
 import org.bukkit.DyeColor;
+import org.bukkit.FireworkEffect;
 import org.bukkit.Material;
 import org.bukkit.OfflinePlayer;
 import org.bukkit.block.banner.Pattern;
@@ -36,7 +37,10 @@
 import org.bukkit.inventory.meta.ArmorMeta;
 import org.bukkit.inventory.meta.Damageable;
 import org.bukkit.inventory.meta.EnchantmentStorageMeta;
+import org.bukkit.inventory.meta.FireworkEffectMeta;
+import org.bukkit.inventory.meta.FireworkMeta;
 import org.bukkit.inventory.meta.ItemMeta;
+import org.bukkit.inventory.meta.PotionMeta;
 import org.bukkit.inventory.meta.Repairable;
 import org.bukkit.inventory.meta.SkullMeta;
 import org.bukkit.inventory.meta.trim.ArmorTrim;
@@ -83,14 +87,14 @@ public class MenuItemStack extends ZUtils {
     private int maxDamage;
     private int damage;
     private int repairCost;
-    private boolean unbreakableEnabled;
-    private boolean unbreakableShowInTooltip;
-    private boolean fireResistant;
-    private boolean hideTooltip;
-    private boolean hideAdditionalTooltip;
+    private Boolean unbreakableEnabled;
+    private Boolean unbreakableShowInTooltip;
+    private Boolean fireResistant;
+    private Boolean hideTooltip;
+    private Boolean hideAdditionalTooltip;
     private Boolean enchantmentGlint;
-    private boolean enchantmentShowInTooltip;
-    private boolean attributeShowInTooltip;
+    private Boolean enchantmentShowInTooltip;
+    private Boolean attributeShowInTooltip;
     private MenuItemRarity itemRarity;
     private TrimConfiguration trimConfiguration;
 
@@ -144,6 +148,43 @@ public static MenuItemStack fromItemStack(InventoryManager manager, ItemStack it
                     menuItemStack.setEnchantments(enchantmentStorageMeta.getEnchants());
                 }
             }
+
+            try {
+                if (itemMeta instanceof PotionMeta) {
+                    PotionMeta potionMeta = (PotionMeta) itemMeta;
+                    PotionType type = potionMeta.getBasePotionType();
+                    if (type != null) {
+                        Potion menuPotion = new Potion(type, 0);
+                        menuItemStack.setPotion(menuPotion);
+                    }
+                }
+            } catch (Exception ignored) {
+            }
+
+            try {
+                // ToDo, upgrade for multiple effect
+                if (itemMeta instanceof FireworkMeta) {
+                    FireworkMeta fireworkMeta = (FireworkMeta) itemMeta;
+                    List<FireworkEffect> fireworkEffects = fireworkMeta.getEffects();
+                    if (!fireworkEffects.isEmpty()) {
+                        FireworkEffect effect = fireworkEffects.get(0);
+                        Firework menuFirework = new Firework(false, effect);
+                        menuItemStack.setFirework(menuFirework);
+                    }
+                }
+            } catch (Exception ignored) {
+            }
+
+            try {
+                // ToDo, upgrade for multiple effect
+                if (itemMeta instanceof FireworkEffectMeta) {
+                    FireworkEffectMeta fireworkMeta = (FireworkEffectMeta) itemMeta;
+                    FireworkEffect effect = fireworkMeta.getEffect();
+                    Firework menuFirework = new Firework(true, effect);
+                    menuItemStack.setFirework(menuFirework);
+                }
+            } catch (Exception ignored) {
+            }
         }
 
         return menuItemStack;
@@ -275,7 +316,7 @@ public ItemStack build(Player player, boolean useCache, Placeholders placeholder
             }
 
             if (!this.lore.isEmpty()) {
-                List<String> lore = placeholders.parse(locale == null ? this.lore : this.translatedLore.getOrDefault(locale, this.lore));
+                List<String> lore = papi(placeholders.parse(locale == null ? this.lore : this.translatedLore.getOrDefault(locale, this.lore)), player, useCache);
                 lore = lore.stream().flatMap(str -> Arrays.stream(str.split("\n"))).collect(Collectors.toList());
                 Meta.meta.updateLore(itemMeta, lore, offlinePlayer == null ? player : offlinePlayer);
             }
@@ -336,37 +377,39 @@ private void buildNewItemStackAPI(ItemStack itemStack, ItemMeta itemMeta, Player
 
         if (itemMeta instanceof Damageable) {
             Damageable damageable = (Damageable) itemMeta;
+
             if (this.maxDamage > 0) damageable.setMaxDamage(this.maxDamage);
-            damageable.setDamage(this.damage);
-            damageable.setUnbreakable(this.unbreakableEnabled);
+            if (this.damage != 0) damageable.setDamage(this.damage);
+
+            if (this.unbreakableEnabled != null) damageable.setUnbreakable(this.unbreakableEnabled);
 
-            if (!this.unbreakableShowInTooltip) {
+            if (this.unbreakableShowInTooltip != null && !this.unbreakableShowInTooltip) {
                 itemMeta.addItemFlags(ItemFlag.HIDE_UNBREAKABLE);
             }
         }
 
-        if (itemMeta instanceof Repairable) {
+        if (itemMeta instanceof Repairable && this.repairCost > 0) {
             ((Repairable) itemMeta).setRepairCost(this.repairCost);
         }
 
-        itemMeta.setHideTooltip(this.hideTooltip);
-        if (this.hideAdditionalTooltip) {
+        if (this.hideTooltip != null) itemMeta.setHideTooltip(this.hideTooltip);
+        if (this.hideAdditionalTooltip != null && this.hideAdditionalTooltip) {
             for (ItemFlag value : ItemFlag.values()) {
                 itemMeta.addItemFlags(value);
             }
         }
 
-        if (!this.enchantmentShowInTooltip) {
+        if (this.enchantmentShowInTooltip != null && !this.enchantmentShowInTooltip) {
             itemMeta.addItemFlags(ItemFlag.HIDE_ENCHANTS);
         }
 
         if (this.enchantmentGlint != null) {
             itemMeta.setEnchantmentGlintOverride(this.enchantmentGlint);
         }
 
-        itemMeta.setFireResistant(this.fireResistant);
+        if (this.fireResistant != null) itemMeta.setFireResistant(this.fireResistant);
 
-        if (!this.attributeShowInTooltip) {
+        if (this.attributeShowInTooltip != null && !this.attributeShowInTooltip) {
             itemMeta.addItemFlags(ItemFlag.HIDE_ATTRIBUTES);
         }
 
@@ -897,39 +940,39 @@ public boolean isUnbreakableEnabled() {
         return unbreakableEnabled;
     }
 
-    public void setUnbreakableEnabled(boolean unbreakableEnabled) {
+    public void setUnbreakableEnabled(Boolean unbreakableEnabled) {
         this.unbreakableEnabled = unbreakableEnabled;
     }
 
     public boolean isUnbreakableShowInTooltip() {
         return unbreakableShowInTooltip;
     }
 
-    public void setUnbreakableShowInTooltip(boolean unbreakableShowInTooltip) {
+    public void setUnbreakableShowInTooltip(Boolean unbreakableShowInTooltip) {
         this.unbreakableShowInTooltip = unbreakableShowInTooltip;
     }
 
     public boolean isFireResistant() {
         return fireResistant;
     }
 
-    public void setFireResistant(boolean fireResistant) {
+    public void setFireResistant(Boolean fireResistant) {
         this.fireResistant = fireResistant;
     }
 
     public boolean isHideTooltip() {
         return hideTooltip;
     }
 
-    public void setHideTooltip(boolean hideTooltip) {
+    public void setHideTooltip(Boolean hideTooltip) {
         this.hideTooltip = hideTooltip;
     }
 
     public boolean isHideAdditionalTooltip() {
         return hideAdditionalTooltip;
     }
 
-    public void setHideAdditionalTooltip(boolean hideAdditionalTooltip) {
+    public void setHideAdditionalTooltip(Boolean hideAdditionalTooltip) {
         this.hideAdditionalTooltip = hideAdditionalTooltip;
     }
 
@@ -945,15 +988,15 @@ public boolean isEnchantmentShowInTooltip() {
         return enchantmentShowInTooltip;
     }
 
-    public void setEnchantmentShowInTooltip(boolean enchantmentShowInTooltip) {
+    public void setEnchantmentShowInTooltip(Boolean enchantmentShowInTooltip) {
         this.enchantmentShowInTooltip = enchantmentShowInTooltip;
     }
 
     public boolean isAttributeShowInTooltip() {
         return attributeShowInTooltip;
     }
 
-    public void setAttributeShowInTooltip(boolean attributeShowInTooltip) {
+    public void setAttributeShowInTooltip(Boolean attributeShowInTooltip) {
         this.attributeShowInTooltip = attributeShowInTooltip;
     }
 

src/fr/maxlego08/menu/ZInventory.java

@@ -6,6 +6,7 @@
 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.CompatibilityUtil;
 import fr.maxlego08.menu.api.utils.OpenWithItem;
 import fr.maxlego08.menu.api.utils.Placeholders;
 import fr.maxlego08.menu.inventory.inventories.InventoryDefault;
@@ -34,7 +35,7 @@ public class ZInventory extends ZUtils implements Inventory {
     private final int size;
     private final List<Button> buttons;
     private Map<String, String> translatedNames = new HashMap<>();
-    private List<Pattern> patterns;
+    private List<Pattern> patterns = new ArrayList<>();
     private MenuItemStack fillItemStack;
     private int updateInterval;
     private File file;
@@ -158,7 +159,10 @@ public InventoryResult openInventory(Player player, InventoryDefault inventoryDe
 
     @Override
     public void postOpenInventory(Player player, InventoryDefault inventoryDefault) {
-        InventoryHolder holder = player.getOpenInventory().getTopInventory().getHolder();
+
+        org.bukkit.inventory.Inventory topInventory = CompatibilityUtil.getTopInventory(player);
+        InventoryHolder holder = topInventory.getHolder();
+
         if (holder != null) {
             if (holder instanceof InventoryDefault) {
                 InventoryDefault inventoryHolder = (InventoryDefault) holder;
@@ -179,7 +183,7 @@ public void postOpenInventory(Player player, InventoryDefault inventoryDefault)
     public void closeInventory(Player player, InventoryDefault inventoryDefault) {
         if (this.clearInventory) {
             MenuPlugin.getInstance().getScheduler().runTaskLater(player.getLocation(), 1, () -> {
-                InventoryHolder newHolder = player.getOpenInventory().getTopInventory().getHolder();
+                InventoryHolder newHolder = CompatibilityUtil.getTopInventory(player).getHolder();
                 if (newHolder != null && !(newHolder instanceof InventoryDefault)) {
                     InventoriesPlayer inventoriesPlayer = inventoryDefault.getPlugin().getInventoriesPlayer();
                     inventoriesPlayer.giveInventory(player);

src/fr/maxlego08/menu/ZInventoryManager.java

@@ -12,6 +12,7 @@
 import fr.maxlego08.menu.api.itemstack.ItemStackSimilar;
 import fr.maxlego08.menu.api.loader.MaterialLoader;
 import fr.maxlego08.menu.api.scheduler.ZScheduler;
+import fr.maxlego08.menu.api.utils.CompatibilityUtil;
 import fr.maxlego08.menu.api.utils.MetaUpdater;
 import fr.maxlego08.menu.api.utils.OpenWithItem;
 import fr.maxlego08.menu.button.buttons.ZNoneButton;
@@ -49,6 +50,7 @@
 import fr.maxlego08.menu.loader.actions.TitleLoader;
 import fr.maxlego08.menu.loader.actions.VaultDepositLoader;
 import fr.maxlego08.menu.loader.actions.VaultWithdrawLoader;
+import fr.maxlego08.menu.loader.deluxemenu.InventoryDeluxeMenuLoader;
 import fr.maxlego08.menu.loader.permissible.ItemPermissibleLoader;
 import fr.maxlego08.menu.loader.permissible.JobPermissibleLoader;
 import fr.maxlego08.menu.loader.permissible.LuckPermPermissibleLoader;
@@ -157,8 +159,10 @@ public Inventory loadInventory(Plugin plugin, String fileName, Class<? extends I
     @Override
     public Inventory loadInventory(Plugin plugin, File file, Class<? extends Inventory> classz) throws InventoryException {
 
-        Loader<Inventory> loader = new InventoryLoader(this.plugin);
         YamlConfiguration configuration = YamlConfiguration.loadConfiguration(file);
+        boolean isDeluxeMenu = configuration.contains("menu_title");
+
+        Loader<Inventory> loader = isDeluxeMenu ? new InventoryDeluxeMenuLoader(this.plugin) : new InventoryLoader(this.plugin);
         Inventory inventory = loader.load(configuration, "", file, classz, plugin);
 
         List<Inventory> inventories = this.inventories.getOrDefault(plugin.getName(), new ArrayList<>());
@@ -562,7 +566,7 @@ public void createNewInventory(CommandSender sender, String fileName, int invent
 
     @Override
     public void updateInventory(Player player) {
-        InventoryHolder holder = player.getOpenInventory().getTopInventory().getHolder();
+        InventoryHolder holder = CompatibilityUtil.getTopInventory(player).getHolder();
         if (holder instanceof InventoryDefault) {
             InventoryDefault inventoryDefault = (InventoryDefault) holder;
             this.openInventory(player, inventoryDefault.getMenuInventory(), inventoryDefault.getPage(), inventoryDefault.getOldInventories());
@@ -571,7 +575,7 @@ public void updateInventory(Player player) {
 
     @Override
     public void updateInventory(Player player, Plugin plugin) {
-        InventoryHolder holder = player.getOpenInventory().getTopInventory().getHolder();
+        InventoryHolder holder = CompatibilityUtil.getTopInventory(player).getHolder();
         if (holder instanceof InventoryDefault) {
             InventoryDefault inventoryDefault = (InventoryDefault) holder;
             if (inventoryDefault.getMenuInventory().getPlugin() == plugin) {

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

@@ -330,4 +330,6 @@ public interface Button extends PermissibleButton, PlaceholderButton, SlotButton
     RefreshRequirement getRefreshRequirement();
 
     boolean hasRefreshRequirement();
+
+    int getPriority();
 }