Refactor menu management and functionality implementation

This update includes a comprehensive restructuring and enhancement of menu management within the application. It introduces improved handling of button interactions, customization of menu sizes, and finer controls for actions within menus. The changes also address potential issues such as button overwrites and maintaining items within menu boundaries. In addition, a standard .gitignore file is introduced for project hygiene.

Author: TheRedMagic

.idea/vcs.xml

@@ -0,0 +1,22 @@
+package com.redmagic.undefinedapi
+
+import kotlin.random.Random
+
+fun Random.weightedRandom(map: Map<Any, Double>): Any{
+    val totalWeight = getTotalWeight(map)
+    var idx = 0;
+    var r = this.nextDouble() * totalWeight
+    while (idx < map.keys.size - 1){
+        val  s = map.keys.elementAt(idx)
+        r -= map[s] ?: 0.0
+        if (r <= 0) break
+        ++idx
+    }
+    return map.keys.elementAt(idx)
+}
+
+private fun getTotalWeight(map: Map<Any, Double>): Double {
+    var total = 0.0
+    map.forEach{total += it.value}
+    return total
+}

src/main/java/com/redmagic/undefinedapi/RandomUtil.kt

@@ -1,9 +1,17 @@
 package com.redmagic.undefinedapi.builders
 
+import com.redmagic.undefinedapi.string.asItemStack
 import net.kyori.adventure.text.Component
+import net.kyori.adventure.text.minimessage.MiniMessage
+import org.bukkit.Bukkit
 import org.bukkit.Material
+import org.bukkit.enchantments.Enchantment
+import org.bukkit.entity.Item
 import org.bukkit.inventory.ItemStack
 import org.bukkit.inventory.meta.ItemMeta
+import org.bukkit.inventory.meta.SkullMeta
+import java.util.*
+import kotlin.collections.HashMap
 
 /**
  * Represents a builder for creating ItemStack objects.
@@ -13,17 +21,28 @@ import org.bukkit.inventory.meta.ItemMeta
  */
 class ItemBuilder(private var itemStack: ItemStack) {
 
+    var name: Component? = null
+    var lore: MutableList<Component> = mutableListOf()
+    var amount: Int = 1
+    var customModelData: Int = 0
+    var localizedName: String = ""
+    var enchants: HashMap<Enchantment, Int> = HashMap()
+    var unbreakable: Boolean = false
+    var skullowner: UUID? = null
+
     constructor(material: Material): this(ItemStack(material))
 
+    constructor(base64String: String): this(base64String.asItemStack())
+
 
     /**
      * Sets the display name of the item.
      *
      * @param name The name to set as the display name of the item. This should be a Component object.
      * @return This ItemBuilder instance.
      */
-    fun setName(name:Component):ItemBuilder{
-        itemStack.itemMeta = itemStack.itemMeta.apply { displayName(name) }
+    fun setName(name: Component):ItemBuilder{
+        this.name = name
         return this
     }
     /**
@@ -32,8 +51,53 @@ class ItemBuilder(private var itemStack: ItemStack) {
      * @param name the name to set for the ItemStack
      * @return the ItemBuilder instance
      */
-    fun setName(name:String):ItemBuilder{
-        itemStack.itemMeta = itemStack.itemMeta.apply { setDisplayName(name) }
+    fun setName(name: String):ItemBuilder{
+        this.name = Component.text(name)
+        return this
+    }
+
+    /**
+     * Adds an enchantment to the item.
+     *
+     * @param enchantment The enchantment to add.
+     * @param level The level of the enchantment.
+     * @return The updated item builder instance.
+     */
+    fun addEnchant(enchantment: Enchantment, level: Int):ItemBuilder{
+        this.enchants.set(enchantment, level)
+        return this
+    }
+
+    /**
+     * Setter method to set the enchantments of an ItemBuilder object.
+     *
+     * @param enchantment A HashMap containing the Enchantment objects as keys and the level of the enchantments as values.
+     * @return The current ItemBuilder object after setting the enchantments.
+     */
+    fun setEnchants(enchantment: HashMap<Enchantment, Int>):ItemBuilder{
+        this.enchants = enchantment
+        return this
+    }
+
+    /**
+     * Sets the unbreakable state of the item.
+     *
+     * @param boolean true if the item should be unbreakable, false otherwise
+     * @return the ItemBuilder instance
+     */
+    fun setUnbreakable(boolean: Boolean): ItemBuilder{
+        unbreakable = boolean
+        return this
+    }
+
+    /**
+     * Sets the owner of the skull.
+     *
+     * @param uuid The UUID of the skull owner.
+     * @return The updated ItemBuilder instance.
+     */
+    fun setSkullOwner(uuid: UUID):ItemBuilder{
+        this.skullowner = uuid
         return this
     }
 
@@ -43,8 +107,13 @@ class ItemBuilder(private var itemStack: ItemStack) {
      * @param lore The list of components representing the lore of the item.
      * @return The ItemBuilder instance.
      */
-    fun setLore(lore:MutableList<Component>):ItemBuilder{
-        itemStack.itemMeta = itemStack.itemMeta.apply { lore(lore) }
+    fun setLore(lore: MutableList<Component>):ItemBuilder{
+        this.lore = lore
+        return this
+    }
+
+    fun addLine(line: Component): ItemBuilder{
+        this.lore.add(line)
         return this
     }
 
@@ -55,7 +124,7 @@ class ItemBuilder(private var itemStack: ItemStack) {
      * @return the ItemBuilder object for method chaining
      */
     fun setAmount(amount: Int): ItemBuilder {
-        itemStack.amount = amount
+        this.amount = amount
         return this
     }
 
@@ -65,8 +134,8 @@ class ItemBuilder(private var itemStack: ItemStack) {
      * @param customModelData The custom model data value to set.
      * @return The ItemBuilder object.
      */
-    fun setCustomModelData(customModelData:Int):ItemBuilder{
-        itemStack.itemMeta = itemStack.itemMeta.apply { setCustomModelData(customModelData) }
+    fun setCustomModelData(customModelData: Int):ItemBuilder{
+        this.customModelData = customModelData
         return this
     }
 
@@ -76,8 +145,8 @@ class ItemBuilder(private var itemStack: ItemStack) {
      * @param name The localized name to set.
      * @return The ItemBuilder instance.
      */
-    fun setLocalizedName(name:String):ItemBuilder{
-        itemStack.itemMeta = itemStack.itemMeta.apply { setLocalizedName(name) }
+    fun setLocalizedName(name: String):ItemBuilder{
+        this.localizedName = name
         return this
     }
 
@@ -87,6 +156,30 @@ class ItemBuilder(private var itemStack: ItemStack) {
      * @return The constructed ItemStack object.
      */
     fun build(): ItemStack {
+        itemStack.amount = amount
+        var itemMeta = itemStack.itemMeta
+
+        if (name != null) itemMeta.displayName(name)
+
+        itemMeta.lore(lore)
+        itemMeta.setCustomModelData(customModelData)
+        itemMeta.setLocalizedName(localizedName)
+
+        if (enchants.isNotEmpty()) enchants.forEach{
+            itemMeta.addEnchant(it.key, it.value, true)
+        }
+
+        itemMeta.isUnbreakable = unbreakable
+
+        if (skullowner != null)
+            if (itemStack.type == Material.PLAYER_HEAD){
+                val meta = itemMeta as SkullMeta
+                meta.setOwningPlayer(Bukkit.getOfflinePlayer(skullowner!!))
+                itemMeta = meta
+            }
+
+        itemStack.itemMeta = itemMeta
+
         return itemStack
     }
 

src/main/java/com/redmagic/undefinedapi/UndefinedAPI.kt

@@ -64,7 +64,7 @@ abstract class UndefinedCommand
         }
 
         return if (isCorrectType) {
-            execute(sender, args)
+            execute(sender, args!!)
             true
         } else false
     }
@@ -89,7 +89,7 @@ abstract class UndefinedCommand
      * @param sender the command sender
      * @param args the command arguments
      */
-    abstract fun execute(sender: CommandSender, args: Array<out String>?)
+    abstract fun execute(sender: CommandSender, args: Array<out String>)
 
     /**
      * This method is used to generate a list of tab completions for a command.
@@ -98,7 +98,7 @@ abstract class UndefinedCommand
      * @param args the arguments provided by the sender for the command
      * @return a CommandTabUtil object containing a list of tab completions and the index of the argument currently being completed
      */
-    abstract fun tabComplete(sender: CommandSender, args: Array<out String>?): CommandTabUtil
+    abstract fun tabComplete(sender: CommandSender, args: Array<out String>): CommandTabUtil
 
 }
 

src/main/java/com/redmagic/undefinedapi/builders/ItemBuilder.kt

@@ -4,8 +4,9 @@ import org.bukkit.entity.Player
 import org.bukkit.event.inventory.ClickType
 import org.bukkit.event.inventory.InventoryAction
 import org.bukkit.event.inventory.InventoryClickEvent
+import org.bukkit.inventory.Inventory
 import org.bukkit.inventory.ItemStack
 
-class Button(val slot:Int, val consumer: (ClickData) -> Unit)
+class Button(val slot: Int, val consumer: ClickData.() -> Unit)
 
-class ClickData(val slot: Int, val player: Player?, val item:ItemStack?, val click:ClickType, val action:InventoryAction)
+class ClickData(val slot: Int, val player: Player?, val item:ItemStack?, val click:ClickType, val action:InventoryAction, val inventory: Inventory?)

src/main/java/com/redmagic/undefinedapi/command/UndefinedCommand.kt

@@ -4,55 +4,52 @@ import org.bukkit.Bukkit
 import org.bukkit.inventory.Inventory
 import org.bukkit.inventory.ItemStack
 
-open class Menu(private val title: String, private val size: Int) {
+abstract class Menu(private val title: String, private val size: Int) {
 
-
-    val inventory:Inventory;
+    var inventory: Inventory? = null
 
     val buttons: MutableList<Button> = mutableListOf()
 
     val movables: MutableList<Int> = mutableListOf()
 
 
-    constructor(title: String, menuSize: MenuSize = MenuSize.LARGE):this(title, menuSize.size)
-
-    init {
-        this.inventory = Bukkit.createInventory(null, size, title)
-    }
-
-
-    fun addButton(button: Button){
 
-        if (isAllReadyButton(button.slot)){
 
-            Bukkit.getLogger().warning("Menu : $title button overwrite. Slot : ${button.slot}")
-
-            buttons.filter { it.slot == button.slot }.forEach { dupeButton: Button ->
-                run {
-                    buttons.remove(dupeButton)
-                }
-            }
-        }
-
-        buttons.add(button)
-    }
+    constructor(title: String, menuSize: MenuSize = MenuSize.LARGE):this(title, menuSize.size)
 
-    fun setItem(slot: Int, itemStack:ItemStack, movable:Boolean = true){
+    fun Inventory.setItem(slot: Int, itemStack:ItemStack, movable: Boolean = false){
         if (slot > size){
             Bukkit.getLogger().warning("Menu : $title item outside of menu. Slot : $slot")
             return
         }
 
         movables.remove(slot)
 
-        inventory.setItem(slot, itemStack)
+        this.setItem(slot, itemStack)
 
-        if (movable)
+        if (!movable)
             movables.add(slot)
 
     }
 
-    fun isSlotMoveAble(slot: Int) = movables.any {it == slot}
-    private fun isAllReadyButton(slot: Int) = buttons.any { it.slot == slot }
+    fun Inventory.addButton(button: Button){
+        buttons.add(button)
+    }
+
+    fun Inventory.fillEmpty(itemStack: ItemStack, movable: Boolean = true){
+        while (firstEmpty() != -1){
+            setItem(firstEmpty(), itemStack, movable)
+        }
+    }
+
+
+    fun createInventory(display: Inventory.() -> Unit) : Inventory {
+        buttons.clear()
+        movables.clear()
+        val inventory = Bukkit.createInventory(null, size, title).apply(display)
+        return inventory
+    }
+
+    abstract fun generateInventory(): Inventory
 
 }