improve gui

RecursiveG · RecursiveG · commit 91d7ad87b7ac · 2017-09-09T19:48:21.000-05:00
diff --git a/src/main/java/cat/nyaa/HamsterEcoHelper/quest/QuestCommands.java b/src/main/java/cat/nyaa/HamsterEcoHelper/quest/QuestCommands.java
@@ -2,6 +2,8 @@
 
 import cat.nyaa.HamsterEcoHelper.HamsterEcoHelper;
 import cat.nyaa.HamsterEcoHelper.I18n;
+import cat.nyaa.HamsterEcoHelper.quest.gui.PaginatedListGui;
+import cat.nyaa.HamsterEcoHelper.quest.gui.PairList;
 import cat.nyaa.HamsterEcoHelper.utils.database.tables.quest.QuestStation;
 import cat.nyaa.nyaacore.CommandReceiver;
 import cat.nyaa.nyaacore.LanguageRepository;
@@ -10,6 +12,8 @@
 import org.bukkit.block.Sign;
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Player;
+import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.meta.ItemMeta;
 
 import java.util.Set;
 
@@ -37,6 +41,31 @@ public void postQuest(CommandSender sender, Arguments args) {
         new QuestWizard(station.id, asPlayer(sender), 30);
     }
 
+    public PaginatedListGui gui;
+    @SubCommand(value = "test", permission = "heh.quest.admin")
+    public void testCmd(CommandSender sender, Arguments args) {
+        gui = new PaginatedListGui("Dummy") {
+            @Override
+            protected PairList<String, ItemStack> getFullGuiContent() {
+                PairList<String, ItemStack> ret = new PairList<>();
+                for (int i = 0; i < 150;i++) {
+                    ItemStack n = new ItemStack(Material.BOOK);
+                    ItemMeta m = n.getItemMeta();
+                    m.setDisplayName("Book #" + Integer.toString(i));
+                    n.setItemMeta(m);
+                    ret.put(Integer.toString(i), n);
+                }
+                return ret;
+            }
+
+            @Override
+            protected void itemClicked(Player player, String itemKey) {
+                player.sendMessage("Clicked item #" + itemKey);
+            }
+        };
+        gui.openFor(asPlayer(sender));
+    }
+
     public Sign getSignLookat(CommandSender sender) {
         Player p = asPlayer(sender);
         Block b = p.getTargetBlock((Set<Material>) null, 5);// TODO use nms rayTrace
@@ -46,6 +75,4 @@ public Sign getSignLookat(CommandSender sender) {
         }
         return (Sign)b.getState();
     }
-
-
 }
diff --git a/src/main/java/cat/nyaa/HamsterEcoHelper/quest/QuestListener.java b/src/main/java/cat/nyaa/HamsterEcoHelper/quest/QuestListener.java
@@ -89,5 +89,8 @@ public void onInventoryClicked(InventoryClickEvent ev) {
         if (ev.getClickedInventory().getHolder() instanceof QuestStationGui) {
             ((QuestStationGui)ev.getClickedInventory().getHolder()).onInventoryClicked(ev);
         }
+        if (ev.getClickedInventory().getHolder() == plugin.commandHandler.questCommands.gui) {
+            plugin.commandHandler.questCommands.gui.onInventoryClicked(ev);
+        }
     }
 }
diff --git a/src/main/java/cat/nyaa/HamsterEcoHelper/quest/gui/PaginatedListGui.java b/src/main/java/cat/nyaa/HamsterEcoHelper/quest/gui/PaginatedListGui.java
@@ -1,15 +1,17 @@
 package cat.nyaa.HamsterEcoHelper.quest.gui;
 
+import cat.nyaa.HamsterEcoHelper.I18n;
 import org.bukkit.Bukkit;
+import org.bukkit.Material;
 import org.bukkit.entity.Player;
 import org.bukkit.event.inventory.InventoryClickEvent;
 import org.bukkit.inventory.Inventory;
 import org.bukkit.inventory.InventoryHolder;
 import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.meta.ItemMeta;
 
-import java.util.HashMap;
 import java.util.Map;
-import java.util.SortedMap;
+import java.util.TreeMap;
 import java.util.UUID;
 
 /**
@@ -19,29 +21,81 @@
  * otherwise synchronization issues will occur
  */
 public abstract class PaginatedListGui implements InventoryHolder {
-
-    protected final Map<UUID, Inventory> openedUI = new HashMap<>();
-    protected final Map<UUID, Integer> openedUiPages = new HashMap<>();
+    protected final Map<UUID, Inventory> openedUI = new TreeMap<>();
+    protected final Map<UUID, Integer> openedUiPages = new TreeMap<>(); // pages count from 0
     protected final String basicTitle;
 
-    private PairList<String, ItemStack> currentItems;
+    /* the following three variables are updated (and should only be update)
+     * in {@link #contentChanged()}
+     */
+    private boolean guiFrozen = false;
+    private PairList<String, ItemStack> fullContentCache = null;
+    private int maxPage; // how may pages this gui has. pageIdx in range [0, maxPage)
 
     protected PaginatedListGui(String title) {
         basicTitle = title;
+        contentChanged();
     }
 
     /**
      * Show the player this GUI
      */
     public void openFor(Player player) {
-        openedUiPages.put(player.getUniqueId(), 1);
-        Inventory inv = Bukkit.createInventory(this, 54, basicTitle + " - Page 1");
-        currentItems = getFullGuiContent();
-        ItemStack[] t = currentItems.getValues(0,45).toArray(new ItemStack[0]);
-        inv.setContents(t);
-        openedUI.put(player.getUniqueId(), inv);
-        player.openInventory(inv);
-        // TODO
+        showPlayerPage(player, 0);
+    }
+
+    /**
+     * Show page to player.
+     * If page not in range, close gui & clear player record.
+     * @param p
+     * @param page
+     */
+    private void showPlayerPage(Player p, int page) {
+        UUID id = p.getUniqueId();
+        if (page >=0 && page < maxPage) {
+            Inventory inv = Bukkit.createInventory(this, 54, basicTitle + I18n.format("user.quest.title_page", page + 1));
+            ItemStack[] tmp = fullContentCache.getValues(page*45, (page+1)*45).toArray(new ItemStack[0]);
+            inv.setContents(tmp);
+
+            // set prev/next page buttons
+            if (page == 0) {
+                inv.setItem(45, getNamedItem(Material.BARRIER, I18n.format("user.quest.first_page")));
+            } else {
+                inv.setItem(45, getNamedItem(Material.ARROW, I18n.format("user.quest.prev_page")));
+            }
+            if (page == maxPage - 1) {
+                inv.setItem(53, getNamedItem(Material.BARRIER, I18n.format("user.quest.last_page")));
+            } else {
+                inv.setItem(53, getNamedItem(Material.ARROW, I18n.format("user.quest.next_page")));
+            }
+
+            openedUiPages.put(id, page);
+            openedUI.put(id, inv);
+            p.openInventory(inv);
+        } else {
+            openedUiPages.remove(id);
+            openedUI.remove(id);
+            if (isCurrentGui(p)) p.closeInventory();
+        }
+    }
+
+    public ItemStack getNamedItem(Material material, String title) {
+        ItemStack stack = new ItemStack(material);
+        ItemMeta m = stack.getItemMeta();
+        m.setDisplayName(title);
+        stack.setItemMeta(m);
+        return stack;
+    }
+
+    /**
+     * Check if the inventory opened by the player
+     * is managed by this GUI object
+     * i.e. inventoryHolder == this
+     */
+    public boolean isCurrentGui(Player p) {
+        return p.getOpenInventory() != null &&
+                p.getOpenInventory().getTopInventory() != null &&
+                p.getOpenInventory().getTopInventory().getHolder() == this;
     }
 
     /**
@@ -63,34 +117,105 @@ public final Inventory getInventory() {
      * @param ev
      */
     public void onInventoryClicked(InventoryClickEvent ev) {
-        // TODO
+        // TODO change all System.err
         ev.setCancelled(true);
+        if (guiFrozen) return;
         if (ev.getClickedInventory() == null) return;
         if (!(ev.getWhoClicked() instanceof Player)) {
             System.err.print("inventory not clicked by player?");
             return;
         }
-        if (ev.getClickedInventory() != openedUI.get(ev.getWhoClicked().getUniqueId())) {
-            System.err.print("user clicked an unknown inventory.");
-            System.err.print("clicked:"+ev.getInventory());
-            System.err.print("expected:"+openedUI.get(ev.getWhoClicked().getUniqueId()));
-            //return;
-            // TODO it seems bukkit does some magic when opening an inventory
-            //       so we need another way to track inventories (not by "==")
+        Player p = (Player)ev.getWhoClicked();
+        if (!openedUI.containsKey(p.getUniqueId()) || !openedUiPages.containsKey(p.getUniqueId())) {
+            System.err.print("user not registered in gui");
+            return;
         }
-        Integer page = openedUiPages.get(ev.getWhoClicked().getUniqueId());
-        if (page == null) {
-            System.err.print("user clicked an unknown inventory page no.");
+        Inventory inv = ev.getClickedInventory();
+        if (!inv.equals(openedUI.get(p.getUniqueId()))) {
+            System.err.print("user clicked on unknown inventory");
             return;
         }
-
-        itemClicked((Player)ev.getWhoClicked(), currentItems.getKey((page-1)*45+ev.getSlot()));
+        Integer page = openedUiPages.get(ev.getWhoClicked().getUniqueId());
+        Integer slot = ev.getSlot();
+        if (slot >= 0 && slot < 45) { //clicked on item
+            String key = fullContentCache.getKey(page * 45 + slot);
+            if (key != null) {
+                itemClicked(p, key);
+            } else {
+                // TODO user clicked on an empty slot. Need better handling
+                //System.err.print("user clicked slot out of range");
+            }
+        } else if (slot == 45) { // previous page
+            if (page - 1 >= 0) showPlayerPage(p, page - 1);
+        } else if (slot == 53) { // next page
+            if (page + 1 < maxPage) showPlayerPage(p, page + 1);
+        } else if (slot > 45 && slot < 53) { // custom buttons
+            // TODO not implemented
+        } else { // unknown buttons
+            System.err.print("user clicked on unknown slot");
+        }
     }
 
     /**
      * Should be implemented by subclasses.
+     * PaginatedListGui will cache the returned List.
+     * When the content is changed, subclass should call {@link #contentChanged}
+     *
      * @return An ordered map of items to be shown in this GUI
      */
     protected abstract PairList<String, ItemStack> getFullGuiContent();
+
+    /**
+     * This method will be called when a player clicked on an item.
+     * TODO: subclasses may need another cache to store the itemKeys, maybe we can avoid this?
+     * @param itemKey the key returned by {@link #getFullGuiContent()}
+     */
     protected abstract void itemClicked(Player player, String itemKey);
+
+    /**
+     * Invoked when all inventories of this gui are closed by players.
+     * Subclasses may or may not implement this.
+     * TODO not implemented, inventory close event
+     */
+    protected void guiCompletelyClosed() {
+
+    }
+
+    /**
+     * Subclasses should call this method when there's any change
+     * on the contents.
+     * When invoked, PaginatedListGui will invalid the cache immediately
+     * call {@link #getFullGuiContent()} again, and refresh all opened inventories.
+     * TODO: players may unintentionally click on the wrong item if there are many players competing.
+     * TODO: adding a short cooldown time may be a good idea?
+     */
+    protected void contentChanged() {
+        guiFrozen = true; // TODO gui may not need to be frozen, further investigation needed.
+
+        // update cache
+        fullContentCache = getFullGuiContent();
+        maxPage = fullContentCache.size() <= 0? 1 :(fullContentCache.size()-1)/45+1;
+
+        // update opened inventories
+        if (!openedUI.isEmpty() || !openedUiPages.isEmpty()) {
+            Map<Player, Integer> newPages = new TreeMap<>();
+
+            for (UUID id : openedUI.keySet()) {
+                Player p = Bukkit.getPlayer(id);
+                if (p == null) continue;
+                Integer page = openedUiPages.get(id);
+                if (page == null) continue;
+                if (page < 0) continue;
+                if (page >= maxPage) page = maxPage - 1;
+                newPages.put(p, page);
+            }
+            openedUI.clear();
+            openedUiPages.clear();
+            for (Map.Entry<Player, Integer> e : newPages.entrySet()) {
+                showPlayerPage(e.getKey(), e.getValue());
+            }
+        }
+
+        guiFrozen = false;
+    }
 }
diff --git a/src/main/java/cat/nyaa/HamsterEcoHelper/quest/gui/PairList.java b/src/main/java/cat/nyaa/HamsterEcoHelper/quest/gui/PairList.java
@@ -38,6 +38,10 @@ public K getKey(int index) {
         return index>=l.size()? null:l.get(index).key;
     }
 
+    public int size() {
+        return l.size();
+    }
+
     @Override
     public Iterator<Pair> iterator() {
         return new Iterator<Pair>() {
diff --git a/src/main/resources/lang/en_US.yml b/src/main/resources/lang/en_US.yml
@@ -220,6 +220,11 @@ user:
     cannot_break: "You cannot break this station"
     has_ongoing_quest: "There are quests in progress."
     not_station: "Please look at a quest station sign."
+    title_page: " - Page %d"
+    first_page: "This is the first page"
+    last_page: "This is the last page"
+    prev_page: "Previous page"
+    next_page: "Next page"
 
 
     wizard:

Original file line number	Diff line number	Diff line change
`@@ -89,5 +89,8 @@ public void onInventoryClicked(InventoryClickEvent ev) {`
`89`	`89`	`if (ev.getClickedInventory().getHolder() instanceof QuestStationGui) {`
`90`	`90`	`((QuestStationGui)ev.getClickedInventory().getHolder()).onInventoryClicked(ev);`
`91`	`91`	`}`
	`92`	`+ if (ev.getClickedInventory().getHolder() == plugin.commandHandler.questCommands.gui) {`
	`93`	`+ plugin.commandHandler.questCommands.gui.onInventoryClicked(ev);`
	`94`	`+ }`
`92`	`95`	`}`
`93`	`96`	`}`