feat(menu): improve closing middleware

Author: StillLutto

common/src/main/kotlin/com/undefined/cassini/internal/listener/PacketHandler.kt

@@ -4,7 +4,7 @@ import com.undefined.cassini.internal.info.PacketClickInformation
 import com.undefined.cassini.internal.info.PacketCloseInformation
 
 /**
- * Handles any Cassini menu related server bound packets and custom events (such as dialog click).
+ * Handles any Cassini menu related serverbound packets and custom events (such as dialog click).
  * This is overridden by the implementation of the core module.
  */
 interface PacketHandler {

core/src/main/kotlin/com/undefined/cassini/listener/PacketHandlerImpl.kt

@@ -42,9 +42,13 @@ object PacketHandlerImpl : PacketHandler, Listener {
     }
 
     override fun onClose(closeInformation: PacketCloseInformation) {
-        val menu = NMSManager.openMenus[closeInformation.player.uniqueId] as? ItemMenu<*> ?: return
+        val menu = NMSManager.openMenus[closeInformation.player.uniqueId] ?: return
+        menu.close(closeInformation.player)
         NMSManager.openMenus.remove(closeInformation.player.uniqueId)
-        for (closeAction in menu.closeActions) closeAction(closeInformation.player)
+
+        if (menu is ItemMenu<*>) {
+            for (closeAction in menu.closeActions) closeAction(closeInformation.player)
+        }
     }
 
     @Suppress("UnstableApiUsage")

core/src/main/kotlin/com/undefined/cassini/menu/Menu.kt

@@ -33,9 +33,8 @@ abstract class Menu<T : Menu<T, *>, C : MenuSettings>(
             viewers.add(player.uniqueId)
             if (initialize) initialize(player)
         }
-        val previousMenu = NMSManager.openMenus[player.uniqueId]
-        previousMenu?.viewers?.remove(player.uniqueId)
 
+        NMSManager.openMenus[player.uniqueId]?.close(player) // previous menu
         NMSManager.openMenus[player.uniqueId] = this
     }
 
@@ -50,6 +49,11 @@ abstract class Menu<T : Menu<T, *>, C : MenuSettings>(
         throw UnsupportedOperationException("Update method not available for ${this::class.simpleName}.")
     }
 
+    fun close(player: Player) {
+        viewers.remove(player.uniqueId)
+        onClose(player)
+    }
+
     /**
      * Apply a [MenuPattern] to this menu.
      */
@@ -65,4 +69,7 @@ abstract class Menu<T : Menu<T, *>, C : MenuSettings>(
     @ApiStatus.OverrideOnly
     open fun initialize(player: Player) {}
 
+    @ApiStatus.OverrideOnly
+    open fun onClose(player: Player) {}
+
 }

server/src/main/kotlin/TestMenu.kt

@@ -23,6 +23,13 @@ class TestMenu(parent: Menu<*, *>? = null) : PaginatedChestMenu(!"Change Lore",
         setElement(26, StaticItemElement(Material.PAPER) {
             next()
         })
+
+        onClose { player ->
+            player.sendMessage("Closed action")
+        }
     }
 
+    override fun onClose(player: Player) {
+        player.sendMessage("onClose!")
+    }
 }