Fixes, Features and Improvements

* Fixed some issues when you opened the UIs
* Added extension values to the ItemStack class
* Removed Test Data
* Added taskmodule depend
* Added new onBuild function
* Fixes to the UI Click system

Author: Francisco Solis

src/main/kotlin/xyz/theprogramsrc/uismodule/Main.kt

@@ -1,64 +1,5 @@
 package xyz.theprogramsrc.uismodule
 
-import com.cryptomorin.xseries.XMaterial
-import org.bukkit.Bukkit
-import org.bukkit.event.EventHandler
-import org.bukkit.event.Listener
-import org.bukkit.event.player.AsyncPlayerChatEvent
 import xyz.theprogramsrc.simplecoreapi.global.module.Module
-import xyz.theprogramsrc.simplecoreapi.spigot.SpigotLoader
-import xyz.theprogramsrc.tasksmodule.spigot.SpigotTasks
-import xyz.theprogramsrc.uismodule.objects.*
-import xyz.theprogramsrc.uismodule.simple.SimpleUi
-import xyz.theprogramsrc.uismodule.ui.Ui
 
-class Main: Module(), Listener {
-
-    // TODO: Test this :p
-
-    override fun onEnable() {
-        Bukkit.getPluginManager().registerEvents(this, SpigotLoader.instance)
-    }
-
-    private val item = XMaterial.DIAMOND_SWORD.itemStack()
-        .setName("&bDiamond Sword")
-        .lore(
-            "&7",
-            "&7&l&m-------------------",
-            "&7&l&m&oDescription",
-            "&7&l&m-------------------",
-            "&7&l&m&oThis is a test",
-            "&7&l&m&oof the Ui",
-            "&7"
-        )
-        .setGlowing()
-
-    @EventHandler fun onCmd(event: AsyncPlayerChatEvent){
-        SpigotTasks.instance.run {
-            if(event.message.lowercase().contains("simpleui")){
-                SimpleUi.Builder()
-                    .title("&a&lWelcome to the server! (MC)")
-                    .slots(9)
-                    .entries(mapOf(
-                        4 to UiEntry(item = item){
-                            it.player.inventory.addItem(item)
-                            it.closeUi()
-                        }
-                    ))
-                    .closeAfterClick(false)
-                    .build(event.player)
-            } else if (event.message.lowercase().contains("ui")){
-                Ui("&a&lWelcome to the server! (MC)", 9, event.player).apply {
-                    onBuild = {
-                        set(4, UiEntry(item = item){
-                            it.player.inventory.addItem(item)
-                            it.closeUi()
-                        })
-                    }
-                }
-            } else {
-
-            }
-        }
-    }
-}
+class Main: Module()

src/main/kotlin/xyz/theprogramsrc/uismodule/objects/SimpleItem.kt

@@ -29,6 +29,13 @@ fun String.bukkitColor(vararg args: Any): String = ChatColor.translateAlternateC
  */
 fun String.bukkitStripColor(): String = ChatColor.stripColor(this) ?: this
 
+/**
+ * Gets the name of this [ItemStack]
+ * @return the name of the item
+ */
+val ItemStack.name: String
+    get() = this.itemMeta?.displayName ?: this.type.name
+
 /**
  * Sets the name of this [ItemStack]
  * @param name the name of the item
@@ -40,6 +47,13 @@ fun ItemStack.setName(name: String): ItemStack = this.apply {
     }
 }
 
+/**
+ * Gets the lore of this [ItemStack]
+ * @return the lore of the item
+ */
+val ItemStack.lore: List<String>
+    get() = this.itemMeta?.lore ?: emptyList()
+
 /**
  * Sets the lore of this [ItemStack]
  * @param lore the lore of the item
@@ -93,6 +107,13 @@ fun ItemStack.amount(amount: Int): ItemStack = this.apply {
     this.amount = amount
 }
 
+/**
+ * Gets the flags of this [ItemStack]
+ * @return the flags of the item
+ */
+val ItemStack.flags: List<ItemFlag>
+    get() = this.itemMeta?.itemFlags?.toList() ?: emptyList()
+
 /**
  * Toggles the given flags on this [ItemStack]. If the flag is already set, it will be removed.
  * @param flags the flags to toggle
@@ -132,6 +153,13 @@ fun ItemStack.removeFlags(vararg flags: ItemFlag): ItemStack = this.apply {
     }
 }
 
+/**
+ * Gets the enchantments of this [ItemStack]
+ * @return the enchantments of the item
+ */
+val ItemStack.enchantments: Map<Enchantment, Int>
+    get() = this.itemMeta?.enchants ?: mapOf()
+
 /**
  * Toggles the given enchantments on this [ItemStack]. If the enchantment is already set, it will be removed.
  * @param enchantments the enchantments to toggle

src/main/kotlin/xyz/theprogramsrc/uismodule/simple/SimpleUi.kt

@@ -15,6 +15,7 @@ import org.bukkit.inventory.Inventory
 import org.bukkit.inventory.ItemStack
 import org.bukkit.inventory.PlayerInventory
 import xyz.theprogramsrc.simplecoreapi.spigot.SpigotLoader
+import xyz.theprogramsrc.tasksmodule.spigot.SpigotTasks
 import xyz.theprogramsrc.uismodule.objects.ClickType
 import xyz.theprogramsrc.uismodule.objects.UiAction
 import xyz.theprogramsrc.uismodule.objects.UiEntry
@@ -42,24 +43,23 @@ open class SimpleUi(private val title: String, private val slots: Int, private v
      */
     var closeAfterClick = true
 
-    private val actions = mutableMapOf<Int, (UiAction) -> Unit>()
-
     /**
      * Opens the UI for the player
      * @return This [SimpleUi]
      */
     open fun open(): SimpleUi = this.apply {
-        if(player.openInventory == this.inventory) return@apply
         if(inventory == null){
             HandlerList.unregisterAll(this)
             Bukkit.getPluginManager().registerEvents(this, SpigotLoader.instance)
             this.inventory = Bukkit.createInventory(null, slots, title.bukkitColor())
             entries.forEach {
-                inventory?.setItem(it.key, it.value.item)
+                this.inventory?.setItem(it.key, it.value.item)
             }
         }
 
-        player.openInventory(inventory ?: throw IllegalStateException("An unknown error occurred while creating the inventory"))
+        SpigotTasks.instance.runTask {
+            player.openInventory(this.inventory ?: throw IllegalStateException("An unknown error occurred while creating the inventory"))
+        }
     }
 
     /**
@@ -68,16 +68,16 @@ open class SimpleUi(private val title: String, private val slots: Int, private v
      */
     open fun close(): SimpleUi = this.apply {
         HandlerList.unregisterAll(this)
-        this.player.closeInventory()
-        inventory = null
+        SpigotTasks.instance.runTask(this.player::closeInventory)
+        this.inventory = null
     }
 
     @EventHandler
     fun onClick(event: InventoryClickEvent){
         if(this.inventory == null || event.whoClicked != this.player) return
         event.isCancelled = true
         if(event.slotType == InventoryType.SlotType.OUTSIDE) return
-        if(event.clickedInventory !is PlayerInventory && this.actions.containsKey(event.slot)){
+        if(event.clickedInventory !is PlayerInventory && this.entries.containsKey(event.slot)){
             val action = object:UiAction(this.player, ClickType.fromEvent(event), event) {
 
                 override fun openUi() {
@@ -88,7 +88,9 @@ open class SimpleUi(private val title: String, private val slots: Int, private v
                     this@SimpleUi.close()
                 }
             }
-            this.actions[event.slot]?.invoke(action)
+            SpigotTasks.instance.runTask {
+                this.entries[event.slot]?.action?.invoke(action)
+            }
             if(this.closeAfterClick) this.close()
         }
     }

src/main/kotlin/xyz/theprogramsrc/uismodule/ui/Ui.kt

@@ -61,7 +61,7 @@ open class Ui(private val title: String, private val slots: Int, private val pla
 
     init {
         task = SpigotTasks.instance.runTaskTimer(0L, 1L){
-            if(!(this.inventory == null || this.player.openInventory.title.bukkitStripColor() != this.title.bukkitStripColor() || this.inventory?.size != this.slots)) {
+            if(!(this.inventory == null || this.player.openInventory.title.bukkitColor().bukkitStripColor() != this.title.bukkitColor().bukkitStripColor() || this.inventory?.size != this.slots)) {
                 if(preventOpening) {
                     task.stop()
                     HandlerList.unregisterAll(this)
@@ -74,14 +74,15 @@ open class Ui(private val title: String, private val slots: Int, private val pla
                 }
                 this.onBuild(model)
                 val entries = model.items
-                IntRange(0, this.slots).forEach { slot ->
+                IntRange(0, this.slots.dec()).forEach { slot ->
                     val entry = entries[slot]
-                    if(entry == null) {
-                        this.inventory?.setItem(slot, null)
-                        this.entries.remove(slot)
-                    } else {
-                        this.inventory?.setItem(slot, entry.item)
-                        this.entries[slot] = entry
+                    this.inventory?.apply {
+                        setItem(slot, entry?.item)
+                        if(entry == null){
+                            this@Ui.entries.remove(slot)
+                        } else {
+                            this@Ui.entries[slot] = entry
+                        }
                     }
                 }
                 this.player.updateInventory()
@@ -98,15 +99,15 @@ open class Ui(private val title: String, private val slots: Int, private val pla
      * @return This [Ui]
      */
     open fun open(): Ui = this.apply {
-        if(player.openInventory == this.inventory) return@apply
         this.preventOpening = false
+        this.task.stop()
         if(inventory == null){
             HandlerList.unregisterAll(this)
             Bukkit.getPluginManager().registerEvents(this, SpigotLoader.instance)
-            this.task.start()
         }
 
         this.inventory = Bukkit.createInventory(null, slots, title.bukkitColor())
+        this.task.start()
         SpigotTasks.instance.runTask {
             Bukkit.getPluginManager().callEvent(UiOpenEvent(this, this.player))
             player.openInventory(inventory ?: throw IllegalStateException("An unknown error occurred while creating the inventory"))
@@ -125,21 +126,34 @@ open class Ui(private val title: String, private val slots: Int, private val pla
         }
     }
 
+    /**
+     * Sets the onBuild variable
+     * @param onBuild executed to build the model
+     * @return This [Ui]
+     */
+    fun onBuild(onBuild: UiModel.() -> Unit): Ui {
+        this.onBuild = onBuild
+        return this
+    }
+
     @EventHandler
     fun onClick(event: InventoryClickEvent){
         if(this.inventory == null || event.whoClicked != this.player) return
         event.isCancelled = true
         if(event.slotType == InventoryType.SlotType.OUTSIDE || event.clickedInventory is PlayerInventory) return
+        println("${event.slot}: ${this.entries[event.slot]?.item?.name}")
         val entry = this.entries[event.slot] ?: return
-        entry.action.invoke(object:UiAction(this.player, ClickType.fromEvent(event), event) {
-            override fun openUi() {
-                this@Ui.open()
-            }
+        SpigotTasks.instance.runTask {
+            entry.action.invoke(object:UiAction(this.player, ClickType.fromEvent(event), event) {
+                override fun openUi() {
+                    this@Ui.open()
+                }
 
-            override fun closeUi() {
-                this@Ui.close()
-            }
-        })
+                override fun closeUi() {
+                    this@Ui.close()
+                }
+            })
+        }
         if(this.closeAfterClick) this.close()
         Bukkit.getPluginManager().callEvent(UiClickEvent(this, this.player, entry))
     }

src/main/resources/module.properties

@@ -4,3 +4,4 @@ description=@description@
 version=@version@
 author=TheProgramSrc
 repository-id=uismodule
+dependencies=tasksmodule