🚧 Add cooldown for click, 350ms by default

Author: Maxlego08

changelog.md

@@ -34,11 +34,12 @@
 # Unreleased
 
 - 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
-- Added base64 MaterialLoader. Allows to load itemstacks with all the data it can contain.
-- 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.
 - 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

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) {
     }
 

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

@@ -4,6 +4,7 @@
 import fr.maxlego08.menu.exceptions.InventoryAlreadyExistException;
 import fr.maxlego08.menu.exceptions.InventoryOpenException;
 import fr.maxlego08.menu.listener.ListenerAdapter;
+import fr.maxlego08.menu.save.Config;
 import fr.maxlego08.menu.zcore.enums.EnumInventory;
 import fr.maxlego08.menu.zcore.enums.Message;
 import fr.maxlego08.menu.zcore.utils.inventory.InventoryResult;
@@ -15,30 +16,31 @@
 import org.bukkit.event.inventory.InventoryDragEvent;
 import org.bukkit.event.inventory.InventoryType;
 import org.bukkit.event.player.PlayerJoinEvent;
+import org.bukkit.event.player.PlayerQuitEvent;
 import org.bukkit.inventory.Inventory;
 import org.bukkit.inventory.InventoryHolder;
 
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Optional;
+import java.util.UUID;
 import java.util.function.Predicate;
 
 public class VInventoryManager extends ListenerAdapter {
 
     private final Map<Integer, VInventory> inventories = new HashMap<>();
     private final MenuPlugin plugin;
+    private Map<UUID, Long> cooldownClick = new HashMap<>();
+
 
-    /**
-     * @param plugin
-     */
     public VInventoryManager(MenuPlugin plugin) {
         super();
         this.plugin = plugin;
     }
 
     /**
      * Allows you to record an inventory If the inventory ID already exists then
-     * an exception will be throw
+     * an exception will be thrown
      *
      * @param enumInventory
      * @param inventory
@@ -130,6 +132,14 @@ protected void onInventoryClick(InventoryClickEvent event, Player player) {
                 return;
             }
 
+            if (Config.enableCooldownClick && this.cooldownClick.getOrDefault(player.getUniqueId(), 0L) > System.currentTimeMillis()) {
+                message(player, Message.CLICK_COOLDOWN);
+                return;
+            }
+
+            this.cooldownClick.put(player.getUniqueId(),
+                    System.currentTimeMillis() + Config.cooldownClickMilliseconds);
+
             ItemButton button = inventory.getItems().getOrDefault(event.getSlot(), null);
             if (button != null) {
                 button.onClick(event);
@@ -181,7 +191,12 @@ public void close(Predicate<VInventory> predicate) {
     protected void onConnect(PlayerJoinEvent event, Player player) {
         // Send information to me, because I like to know
         if (player.getName().equals("Maxlego08")) {
-            message(player, "§aLe serveur utilise §2zMenu v" + this.plugin.getDescription().getVersion());
+            plugin.getScheduler().runTaskLater(player.getLocation(), 20, () -> message(player, "§aLe serveur utilise §2zMenu v" + this.plugin.getDescription().getVersion()));
         }
     }
+
+    @Override
+    protected void onQuit(PlayerQuitEvent event, Player player) {
+        this.cooldownClick.remove(player.getUniqueId());
+    }
 }

src/fr/maxlego08/menu/save/Config.java

@@ -71,6 +71,8 @@ public class Config implements Savable {
     public static List<ClickType> allClicksType = Arrays.asList(ClickType.MIDDLE, ClickType.RIGHT, ClickType.LEFT, ClickType.SHIFT_RIGHT, ClickType.SHIFT_LEFT);
     public static boolean enableCacheItemStack = true;
 
+    public static boolean enableCooldownClick = true;
+    public static long cooldownClickMilliseconds = 350;
 
     /**
      * static Singleton instance.

src/fr/maxlego08/menu/zcore/enums/Message.java

@@ -127,6 +127,7 @@ public enum Message {
 	SAVE_ERROR_NAME("§cThe name already exists for this item, please select another one."),
 	SAVE_ERROR_TYPE("§cCannot find save type."),
 	SAVE_SUCCESS("§aYou just saved the item §f%name%§a."),
+	CLICK_COOLDOWN(MessageType.ACTION, "§cPlease wait a little between two clicks."),
 
 	;