Add UI components and layout management for enhanced user interface

Author: mzcydev

src/main/java/gg/nextforge/plugin/NextForgePlugin.java

@@ -3,10 +3,12 @@
 import gg.nextforge.NextCorePlugin;
 import gg.nextforge.command.CommandManager;
 import gg.nextforge.config.ConfigManager;
+import gg.nextforge.database.DatabaseManager;
 import gg.nextforge.npc.NPCManager;
 import gg.nextforge.protocol.ProtocolManager;
 import gg.nextforge.scheduler.CoreScheduler;
 import gg.nextforge.text.TextManager;
+import gg.nextforge.ui.UIManager;
 import lombok.Getter;
 import org.bstats.bukkit.Metrics;
 import org.bukkit.plugin.Plugin;
@@ -26,6 +28,8 @@ public abstract class NextForgePlugin extends JavaPlugin {
     TextManager textManager;
     NPCManager npcManager;
     ProtocolManager protocolManager;
+    UIManager uiManager;
+    DatabaseManager databaseManager;
     Metrics metrics;
 
     public abstract int getMetricsId();
@@ -61,13 +65,22 @@ public void onEnable() {
         this.textManager = new TextManager(this);
         this.npcManager = new NPCManager(this);
         this.protocolManager = new ProtocolManager(this);
+        this.uiManager = new UIManager();
+
+        this.uiManager.init(this);
 
         boolean isReload = getServer().getPluginManager().isPluginEnabled("NextForge");
         enable(isReload);
     }
 
     @Override
     public void onDisable() {
+        if (instance != this) {
+            getLogger().warning("Plugin instance mismatch! This should not happen.");
+            return;
+        }
+        instance = null;
+        this.uiManager.shutdown();
         disable();
     }
 }

src/main/java/gg/nextforge/ui/UIManager.java

@@ -0,0 +1,28 @@
+package gg.nextforge.ui;
+
+import gg.nextforge.ui.context.UIContextManager;
+import gg.nextforge.ui.support.ChatPromptUI;
+import gg.nextforge.ui.support.HotbarUI;
+import org.bukkit.plugin.Plugin;
+
+/**
+ * Central UI bootstrapper and manager.
+ */
+public class UIManager {
+
+    private Plugin plugin;
+
+    public void init(Plugin pl) {
+        plugin = pl;
+
+        ChatPromptUI.registerListener(plugin);
+        HotbarUI.registerListener(plugin);
+
+        // Additional: Register Inventory click listeners etc.
+        // e.g. InventoryInteractionHandler.register(plugin);
+    }
+
+    public void shutdown() {
+        UIContextManager.clearAll();
+    }
+}

src/main/java/gg/nextforge/ui/action/ActionContext.java

@@ -0,0 +1,54 @@
+package gg.nextforge.ui.action;
+
+import org.bukkit.entity.Player;
+import org.bukkit.event.inventory.ClickType;
+
+/**
+ * Encapsulates relevant data for a UI action event.
+ */
+public class ActionContext {
+
+    private final Player player;
+    private final int slot;
+    private final ClickType clickType;
+
+    /**
+     * Constructs an ActionContext with the specified player, slot, and click type.
+     *
+     * @param player    The player who performed the action.
+     * @param slot      The inventory slot that was interacted with.
+     * @param clickType The type of click that triggered the action.
+     */
+    public ActionContext(Player player, int slot, ClickType clickType) {
+        this.player = player;
+        this.slot = slot;
+        this.clickType = clickType;
+    }
+
+    /**
+     * Gets the player who performed the action.
+     *
+     * @return The player associated with this action context.
+     */
+    public Player getPlayer() {
+        return player;
+    }
+
+    /**
+     * Gets the inventory slot that was interacted with.
+     *
+     * @return The slot number associated with this action context.
+     */
+    public int getSlot() {
+        return slot;
+    }
+
+    /**
+     * Gets the type of click that triggered the action.
+     *
+     * @return The ClickType associated with this action context.
+     */
+    public ClickType getClickType() {
+        return clickType;
+    }
+}

src/main/java/gg/nextforge/ui/action/ClickAction.java

@@ -0,0 +1,21 @@
+package gg.nextforge.ui.action;
+
+import org.bukkit.entity.Player;
+import org.bukkit.event.inventory.ClickType;
+
+/**
+ * Represents an action that can be executed when a player clicks on a UI element.
+ * This interface defines a single method to handle click events with the player and the type of click.
+ */
+@FunctionalInterface
+public interface ClickAction {
+
+    /**
+     * Executes the action when a player clicks on a UI element.
+     *
+     * @param player the player who clicked
+     * @param clickType the type of click (e.g., LEFT, RIGHT)
+     */
+    void execute(Player player, ClickType clickType);
+}
+

src/main/java/gg/nextforge/ui/action/HoverAction.java

@@ -0,0 +1,20 @@
+package gg.nextforge.ui.action;
+
+import org.bukkit.entity.Player;
+import org.bukkit.inventory.ItemStack;
+
+/**
+ * Optional interface for implementing item hover behavior,
+ * such as tooltip updates based on player state or localization.
+ */
+@FunctionalInterface
+public interface HoverAction {
+
+    /**
+     * Render the item stack for the given player.
+     * @param viewer the player viewing the item
+     * @return the ItemStack to be displayed
+     */
+    ItemStack render(Player viewer);
+}
+

src/main/java/gg/nextforge/ui/builder/InventoryBuilder.java

@@ -0,0 +1,56 @@
+package gg.nextforge.ui.builder;
+
+import gg.nextforge.ui.component.UIComponent;
+import org.bukkit.Bukkit;
+import org.bukkit.entity.Player;
+import org.bukkit.inventory.Inventory;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.function.Function;
+
+public class InventoryBuilder {
+
+    private final int size;
+    private String title = "Inventory";
+    private final Map<Integer, UIComponent> components = new HashMap<>();
+    private Function<Player, String> dynamicTitle = null;
+
+    public InventoryBuilder(int size) {
+        this.size = size;
+    }
+
+    public InventoryBuilder title(String title) {
+        this.title = title;
+        return this;
+    }
+
+    public InventoryBuilder title(Function<Player, String> titleFunction) {
+        this.dynamicTitle = titleFunction;
+        return this;
+    }
+
+    public InventoryBuilder set(int slot, UIComponent component) {
+        components.put(slot, component);
+        return this;
+    }
+
+    public Inventory build(Player player) {
+        String finalTitle = dynamicTitle != null ? dynamicTitle.apply(player) : title;
+        Inventory inventory = Bukkit.createInventory(null, size, finalTitle);
+
+        for (Map.Entry<Integer, UIComponent> entry : components.entrySet()) {
+            inventory.setItem(entry.getKey(), entry.getValue().render(player));
+        }
+
+        return inventory;
+    }
+
+    public void open(Player player) {
+        player.openInventory(build(player));
+    }
+
+    public Map<Integer, UIComponent> getComponents() {
+        return components;
+    }
+}

src/main/java/gg/nextforge/ui/component/UIButton.java

@@ -0,0 +1,31 @@
+package gg.nextforge.ui.component;
+
+import gg.nextforge.ui.action.ClickAction;
+import org.bukkit.entity.Player;
+import org.bukkit.event.inventory.ClickType;
+import org.bukkit.inventory.ItemStack;
+
+import java.util.function.Supplier;
+
+public class UIButton implements UIComponent {
+
+    private final Supplier<ItemStack> itemSupplier;
+    private final ClickAction clickAction;
+
+    public UIButton(Supplier<ItemStack> itemSupplier, ClickAction clickAction) {
+        this.itemSupplier = itemSupplier;
+        this.clickAction = clickAction;
+    }
+
+    @Override
+    public ItemStack render(Player player) {
+        return itemSupplier.get();
+    }
+
+    @Override
+    public void onClick(Player player, ClickType clickType) {
+        if (clickAction != null) {
+            clickAction.execute(player, clickType);
+        }
+    }
+}

src/main/java/gg/nextforge/ui/component/UIComponent.java

@@ -0,0 +1,13 @@
+package gg.nextforge.ui.component;
+
+import org.bukkit.entity.Player;
+import org.bukkit.event.inventory.ClickType;
+import org.bukkit.inventory.ItemStack;
+
+public interface UIComponent {
+
+    ItemStack render(Player viewer);
+
+    void onClick(Player viewer, ClickType click);
+
+}

src/main/java/gg/nextforge/ui/component/UIItemView.java

@@ -0,0 +1,33 @@
+package gg.nextforge.ui.component;
+
+import org.bukkit.entity.Player;
+import org.bukkit.event.inventory.ClickType;
+import org.bukkit.inventory.ItemStack;
+
+import java.util.function.Function;
+
+/**
+ * A non-interactive UI component used to display static or dynamic items.
+ */
+public class UIItemView implements UIComponent {
+
+    private final Function<Player, ItemStack> itemProvider;
+
+    public UIItemView(ItemStack item) {
+        this(p -> item);
+    }
+
+    public UIItemView(Function<Player, ItemStack> itemProvider) {
+        this.itemProvider = itemProvider;
+    }
+
+    @Override
+    public ItemStack render(Player viewer) {
+        return itemProvider.apply(viewer);
+    }
+
+    @Override
+    public void onClick(Player viewer, ClickType click) {
+        // Intentionally no-op (passive component)
+    }
+}

src/main/java/gg/nextforge/ui/component/UIPanel.java

@@ -0,0 +1,49 @@
+package gg.nextforge.ui.component;
+
+import org.bukkit.entity.Player;
+import org.bukkit.event.inventory.ClickType;
+import org.bukkit.inventory.ItemStack;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * A composite component that holds other components in specific slots.
+ */
+public class UIPanel implements UIComponent {
+
+    private final Map<Integer, UIComponent> children = new HashMap<>();
+
+    public void setComponent(int slot, UIComponent component) {
+        children.put(slot, component);
+    }
+
+    public UIComponent getComponent(int slot) {
+        return children.get(slot);
+    }
+
+    public Map<Integer, UIComponent> getChildren() {
+        return children;
+    }
+
+    @Override
+    public ItemStack render(Player viewer) {
+        return null; // Panels don't render to a single item
+    }
+
+    @Override
+    public void onClick(Player viewer, ClickType click) {
+        // Panels don't handle clicks directly
+    }
+
+    public void renderToInventory(org.bukkit.inventory.Inventory inventory, Player viewer) {
+        children.forEach((slot, component) -> {
+            inventory.setItem(slot, component.render(viewer));
+        });
+    }
+
+    public void handleClick(Player player, int slot, ClickType clickType) {
+        UIComponent comp = children.get(slot);
+        if (comp != null) comp.onClick(player, clickType);
+    }
+}