🚧 Add toast action

Author: Maxlego08

API/src/main/java/fr/maxlego08/menu/api/MenuPlugin.java

@@ -11,6 +11,7 @@
 import fr.maxlego08.menu.api.players.inventory.InventoriesPlayer;
 import fr.maxlego08.menu.api.storage.StorageManager;
 import fr.maxlego08.menu.api.utils.MetaUpdater;
+import fr.maxlego08.menu.api.utils.toast.ToastHelper;
 import org.bukkit.OfflinePlayer;
 import org.bukkit.configuration.file.YamlConfiguration;
 import org.bukkit.entity.Player;
@@ -22,44 +23,194 @@
 
 public interface MenuPlugin extends Plugin {
 
+    /**
+     * Retrieves the scheduler associated with this plugin.
+     * This scheduler is responsible for running tasks asynchronously.
+     *
+     * @return the scheduler.
+     */
     PlatformScheduler getScheduler();
 
+    /**
+     * Retrieves the manager responsible for handling inventory-related operations.
+     * This manager provides methods for creating, managing and retrieving inventories.
+     *
+     * @return the inventory manager.
+     */
     InventoryManager getInventoryManager();
 
+    /**
+     * Retrieves the manager responsible for handling button-related operations.
+     * This manager provides methods for managing button states and interactions.
+     *
+     * @return the button manager.
+     */
     ButtonManager getButtonManager();
 
+    /**
+     * Returns the instance of the pattern manager.
+     *
+     * @return the pattern manager.
+     */
     PatternManager getPatternManager();
 
-    <T> T getProvider(Class<T> headManagerClass);
+    /**
+     * Retrieves a service provider of the specified class type.
+     *
+     * @param classPath the class type of the provider to retrieve.
+     * @param <T>       the type of the service provider.
+     */
+    <T> T getProvider(Class<T> classPath);
 
+    /**
+     * Replaces placeholders in the given string with actual values for the given player.
+     * Placeholders are specified in the format %placeholder% and are replaced with actual values.
+     * If the placeholder does not exist, the placeholder is kept as is.
+     *
+     * @param player the player to substitute placeholders for.
+     * @param string the string to replace placeholders in.
+     * @return a string with placeholders replaced.
+     */
     String parse(Player player, String string);
 
+    /**
+     * Replaces placeholders in the given string with actual values for the given offline player.
+     * Placeholders are specified in the format %placeholder% and are replaced with actual values.
+     * If the placeholder does not exist, the placeholder is kept as is.
+     *
+     * @param offlinePlayer the offline player to substitute placeholders for.
+     * @param string        the string to replace placeholders in.
+     * @return a string with placeholders replaced.
+     */
     String parse(OfflinePlayer offlinePlayer, String string);
 
+    /**
+     * Replaces placeholders in a list of strings with actual values for the given player.
+     * Placeholders are specified in the format %placeholder% and are replaced with actual values.
+     * If the placeholder does not exist, the placeholder is kept as is.
+     *
+     * @param player  the player to substitute placeholders for.
+     * @param strings the list of strings to replace placeholders in.
+     * @return a list of strings with placeholders replaced.
+     */
     List<String> parse(Player player, List<String> strings);
 
+    /**
+     * Replaces placeholders in a list of strings with actual values for the given offline player.
+     * Placeholders are specified in the format %placeholder% and are replaced with actual values.
+     * If the placeholder does not exist, the placeholder is kept as is.
+     *
+     * @param offlinePlayer the player to substitute placeholders for.
+     * @param strings       the list of strings to replace placeholders in.
+     * @return a list of strings with placeholders replaced.
+     */
     List<String> parse(OfflinePlayer offlinePlayer, List<String> strings);
 
+    /**
+     * Retrieves the manager responsible for player inventory related operations.
+     * This manager provides methods for managing player inventory state,
+     * such as saving, loading, and clearing inventories.
+     *
+     * @return The manager responsible for player inventory related operations.
+     */
     InventoriesPlayer getInventoriesPlayer();
 
+    /**
+     * Retrieves a map of global placeholders.
+     * This method returns a map where the keys are placeholder strings
+     * and the values are the corresponding objects.
+     * These placeholders are used for dynamic content replacement
+     * throughout the plugin.
+     *
+     * @return A map containing global placeholders and their values.
+     */
     Map<String, Object> getGlobalPlaceholders();
 
+    /**
+     * Retrieves the font image utility for managing custom fonts.
+     *
+     * @return An instance of {@link FontImage} for handling font images.
+     */
     FontImage getFontImage();
 
+    /**
+     * Returns the data manager.
+     * This method returns the data manager, which is used for managing data related to players.
+     * The data manager is used for managing data related to players.
+     *
+     * @return the data manager
+     */
     DataManager getDataManager();
 
+    /**
+     * Returns the dupe manager.
+     * This method returns the dupe manager, which is responsible for managing
+     * the duplication detection and protection logic within the plugin.
+     * The dupe manager can be used to check if items are duplicated and to
+     * apply protection against duplication exploits.
+     *
+     * @return the dupe manager
+     */
     DupeManager getDupeManager();
 
+    /**
+     * Returns the enchantments manager.
+     * This method returns the enchantments manager, which is used for managing custom enchantments.
+     * The enchantments manager is used for managing custom enchantments.
+     *
+     * @return the enchantments manager
+     */
     Enchantments getEnchantments();
 
+    /**
+     * Returns the meta updater.
+     * This method returns the meta updater, which is used for updating the item meta.
+     * The meta updater is used for updating the item meta.
+     *
+     * @return the meta updater
+     */
     MetaUpdater getMetaUpdater();
 
+    /**
+     * Returns the command manager.
+     * This method returns the command manager, which is used for registering and
+     * executing commands.
+     * The command manager is used for registering and executing commands.
+     *
+     * @return the command manager
+     */
     CommandManager getCommandManager();
 
+    /**
+     * Returns the storage manager.
+     * This method returns the storage manager, which is used for storing and retrieving data.
+     * The storage manager is used for storing and retrieving data from the database or other
+     * storage systems.
+     *
+     * @return the storage manager
+     */
     StorageManager getStorageManager();
 
+    /**
+     * Checks if the plugin is a Folia plugin.
+     * This method returns a boolean indicating whether the plugin is a Folia plugin.
+     * This method is useful for checking if the plugin is a Folia plugin before using any
+     * methods that require a Folia plugin.
+     *
+     * @return true if the plugin is a Folia plugin, false otherwise
+     */
     boolean isFolia();
 
+    /**
+     * Registers a placeholder that can be used globally in the plugin.
+     * This method allows you to register a placeholder that can be used in any menu item stack.
+     * The placeholder is specified by the given startWith string, and the biConsumer parameter
+     * is a function that takes an OfflinePlayer and returns a string. The return value of this
+     * function is the replacement string for the given placeholder.
+     *
+     * @param startWith  the startWith string for the placeholder.
+     * @param biConsumer the function that provides the replacement string for the placeholder.
+     */
     void registerPlaceholder(String startWith, ReturnBiConsumer<OfflinePlayer, String, String> biConsumer);
 
     /**
@@ -73,4 +224,12 @@ public interface MenuPlugin extends Plugin {
      * @return the loaded menu item stack.
      */
     MenuItemStack loadItemStack(YamlConfiguration configuration, String path, File file);
+
+    /**
+     * Returns the ToastHelper object for this plugin.
+     * The ToastHelper allows you to create and send toasts to players.
+     *
+     * @return the ToastHelper object.
+     */
+    ToastHelper getToastHelper();
 }

API/src/main/java/fr/maxlego08/menu/api/utils/toast/ToastHelper.java

@@ -0,0 +1,44 @@
+package fr.maxlego08.menu.api.utils.toast;
+
+import org.bukkit.entity.Player;
+
+import java.util.Collection;
+
+public interface ToastHelper {
+
+    /**
+     * Shows a toast to all the given players.
+     *
+     * @param players   the players to show the toast to
+     * @param icon      the icon
+     * @param message   the message
+     * @param style     the style
+     * @param modelData the model data
+     * @param glowing   whether the icon is glowing
+     */
+    void showToast(Collection<? extends Player> players, String icon, String message, ToastType style, Object modelData, boolean glowing);
+
+    /**
+     * Shows a toast to a varargs of players.
+     *
+     * @param icon      the icon
+     * @param message   the message
+     * @param style     the style
+     * @param modelData the model data
+     * @param glowing   whether the icon is glowing
+     * @param players   the players to show the toast to
+     */
+    void showToast(String icon, String message, ToastType style, Object modelData, boolean glowing, Player... players);
+
+    /**
+     * Shows a toast to all online players.
+     *
+     * @param icon      the icon
+     * @param message   the message
+     * @param style     the style
+     * @param modelData the model data
+     * @param glowing   whether the icon is glowing
+     */
+    void showToastToAll(String icon, String message, ToastType style, Object modelData, boolean glowing);
+
+}

API/src/main/java/fr/maxlego08/menu/api/utils/toast/ToastType.java

@@ -0,0 +1,12 @@
+package fr.maxlego08.menu.api.utils.toast;
+
+public enum ToastType {
+    TASK,
+    GOAL,
+    CHALLENGE;
+
+    @Override
+    public String toString() {
+        return super.toString().toLowerCase();
+    }
+}

src/main/java/fr/maxlego08/menu/ZInventoryManager.java

@@ -327,6 +327,7 @@ public void loadButtons() {
         if (this.plugin.isEnable(Plugins.LUCKPERMS)) {
             buttonManager.registerAction(new LuckPermissionSetLoader());
         }
+        buttonManager.registerAction(new ToastLoader(this.plugin));
 
         // Loading ButtonLoader
         // The first step will be to load the buttons in the plugin, so each

src/main/java/fr/maxlego08/menu/ZMenuPlugin.java

@@ -17,6 +17,7 @@
 import fr.maxlego08.menu.api.players.inventory.InventoriesPlayer;
 import fr.maxlego08.menu.api.storage.StorageManager;
 import fr.maxlego08.menu.api.utils.MetaUpdater;
+import fr.maxlego08.menu.api.utils.toast.ToastHelper;
 import fr.maxlego08.menu.api.website.WebsiteManager;
 import fr.maxlego08.menu.command.VCommandManager;
 import fr.maxlego08.menu.command.commands.CommandMenu;
@@ -56,6 +57,7 @@
 import fr.maxlego08.menu.zcore.utils.plugins.Metrics;
 import fr.maxlego08.menu.zcore.utils.plugins.Plugins;
 import fr.maxlego08.menu.zcore.utils.plugins.VersionChecker;
+import fr.maxlego08.menu.zcore.utils.toast.ToastManager;
 import org.bukkit.Bukkit;
 import org.bukkit.OfflinePlayer;
 import org.bukkit.configuration.file.YamlConfiguration;
@@ -93,6 +95,7 @@ public class ZMenuPlugin extends ZPlugin implements MenuPlugin {
     private final PatternManager patternManager = new ZPatternManager(this);
     private final Enchantments enchantments = new ZEnchantments();
     private final Map<String, Object> globalPlaceholders = new HashMap<>();
+    private final ToastHelper toastHelper = new ToastManager(this);
     private CommandMenu commandMenu;
     private PlatformScheduler scheduler;
     private DupeManager dupeManager;
@@ -439,10 +442,10 @@ public void loadGlobalPlaceholders() {
     }
 
     @Override
-    public <T> T getProvider(Class<T> classz) {
-        RegisteredServiceProvider<T> provider = getServer().getServicesManager().getRegistration(classz);
+    public <T> T getProvider(Class<T> classPath) {
+        RegisteredServiceProvider<T> provider = getServer().getServicesManager().getRegistration(classPath);
         if (provider == null) {
-            getLogger().info("Unable to retrieve the provider " + classz);
+            getLogger().info("Unable to retrieve the provider " + classPath);
             return null;
         }
         return provider.getProvider();
@@ -483,4 +486,9 @@ private void loadMeta() {
             }
         }
     }
+
+    @Override
+    public ToastHelper getToastHelper() {
+        return this.toastHelper;
+    }
 }

src/main/java/fr/maxlego08/menu/loader/actions/ToastLoader.java

@@ -0,0 +1,32 @@
+package fr.maxlego08.menu.loader.actions;
+
+import fr.maxlego08.menu.api.MenuPlugin;
+import fr.maxlego08.menu.api.loader.ActionLoader;
+import fr.maxlego08.menu.api.requirement.Action;
+import fr.maxlego08.menu.api.utils.TypedMapAccessor;
+import fr.maxlego08.menu.api.utils.toast.ToastType;
+import fr.maxlego08.menu.requirement.actions.ToastAction;
+
+import java.io.File;
+
+public class ToastLoader extends ActionLoader {
+
+    private final MenuPlugin plugin;
+
+    public ToastLoader(MenuPlugin plugin) {
+        super("toast", "send toast");
+        this.plugin = plugin;
+    }
+
+    @Override
+    public Action load(String path, TypedMapAccessor accessor, File file) {
+
+        String message = accessor.getString("message", "Default message");
+        String material = accessor.getString("material", "PAPER");
+        String modelId = accessor.getString("model-id", "0");
+        ToastType toastType = ToastType.valueOf(accessor.getString("toast-type", ToastType.CHALLENGE.toString()).toUpperCase());
+        boolean glowing = accessor.getBoolean("glowing", false);
+
+        return new ToastAction(this.plugin, material, message, toastType, modelId, glowing);
+    }
+}