feat: Added a Bind button to all modules in GUI

The bind button works similarly to the char button for command prefix. This commit also introduces a `keyQueue`, just like charButton's `charQueue`.

Author: zeroeightysix

src/main/kotlin/me/zeroeightsix/kami/feature/FullFeature.kt

@@ -5,16 +5,16 @@ package me.zeroeightsix.kami.feature
 import io.github.fablabsmc.fablabs.api.fiber.v1.annotation.Listener
 import io.github.fablabsmc.fablabs.api.fiber.v1.annotation.Setting
 import io.github.fablabsmc.fablabs.api.fiber.v1.tree.ConfigBranch
+import java.lang.Boolean as JavaBoolean
 import me.zero.alpine.listener.EventHandler
 import me.zero.alpine.listener.EventHook
 import me.zero.alpine.listener.Listenable
+import me.zero.alpine.listener.Listener as AlpineListener
 import me.zeroeightsix.kami.KamiMod
 import me.zeroeightsix.kami.event.BindEvent
 import me.zeroeightsix.kami.setting.SettingVisibility
 import me.zeroeightsix.kami.then
 import me.zeroeightsix.kami.util.Bind
-import me.zero.alpine.listener.Listener as AlpineListener
-import java.lang.Boolean as JavaBoolean
 
 open class FullFeature(
     override var name: String = "No name",
@@ -48,7 +48,6 @@ open class FullFeature(
     }
 
     @Setting(name = "Bind")
-    @SettingVisibility.Constant(false)
     override var bind = Bind.none()
 
     @Setting
@@ -110,4 +109,4 @@ open class FullFeature(
 
     open fun onEnable() {}
     open fun onDisable() {}
-}
+}

src/main/kotlin/me/zeroeightsix/kami/gui/ImGuiScreen.kt

@@ -4,7 +4,9 @@ import imgui.ImGui
 import imgui.flag.ImGuiConfigFlags
 import me.zeroeightsix.kami.gui.ImguiDSL.without
 import me.zeroeightsix.kami.mc
+import me.zeroeightsix.kami.util.Bind
 import net.minecraft.client.gui.screen.Screen
+import net.minecraft.client.util.InputUtil
 import net.minecraft.text.Text
 import org.lwjgl.glfw.GLFW
 
@@ -28,6 +30,8 @@ abstract class ImGuiScreen(title: Text) : Screen(title) {
         val returned = super.keyPressed(keyCode, scanCode, modifiers)
         if (!returned) {
             KamiImgui.imguiGlfw.keyCallback(mc.window.handle, keyCode, scanCode, GLFW.GLFW_PRESS, modifiers)
+
+            KamiImgui.keyQueue.add(Bind.Code(InputUtil.fromKeyCode(keyCode, scanCode)))
         }
         return returned
     }

src/main/kotlin/me/zeroeightsix/kami/gui/KImGui.kt

@@ -4,52 +4,65 @@ import imgui.ImGui
 import imgui.flag.ImGuiCol
 import kotlin.reflect.KMutableProperty0
 import me.zeroeightsix.kami.gui.ImguiDSL.addFrame
+import me.zeroeightsix.kami.gui.ImguiDSL.calcTextSize
 import me.zeroeightsix.kami.gui.ImguiDSL.colour
 import me.zeroeightsix.kami.gui.ImguiDSL.cursorPosX
 import me.zeroeightsix.kami.gui.ImguiDSL.get
 import me.zeroeightsix.kami.gui.ImguiDSL.plus
+import me.zeroeightsix.kami.gui.windows.Settings
+import me.zeroeightsix.kami.util.Bind
 
-/**
- * A button for entry of a single character. It will breathe while active to indicate that the button is consuming inputs.
- *
- * @return `true` if `char` was updated
- */
-fun charButton(strId: String, char: KMutableProperty0<Char>, pressText: String? = "Press a key") {
-    var value by char
+private fun <T, R> inputButton(text: String, value: T, hoverText: String?, width: Float? = null, onHover: () -> R): R? {
     val frameHeight = ImGui.getFrameHeight()
     val framePaddingY = ImGui.getStyle().framePaddingY
     val drawList = ImGui.getWindowDrawList()
+    @Suppress("NAME_SHADOWING") val width = width ?: frameHeight
 
-    ImguiDSL.withId(strId) {
-        val cursorPos = ImguiDSL.cursorPos
-        val (x, y) = ImguiDSL.windowPos + cursorPos
-        cursorPosX += (frameHeight - ImguiDSL.calcTextSize(value.toString()).x) / 2f
-        ImGui.text(value.toString())
-        var hovered = ImGui.isItemHovered()
-        ImguiDSL.cursorPos = cursorPos
-
-        ImguiDSL.invisibleButton(value.toString(), frameHeight, frameHeight) {}
-
-        hovered = hovered || ImGui.isItemHovered()
-        drawList.addFrame(
-            x,
-            y,
-            x + frameHeight,
-            y + frameHeight,
-            (if (hovered) ImGui.getStyle()[ImGuiCol.FrameBgHovered] else ImGui.getStyle()[ImGuiCol.FrameBg]).colour
-        )
+    val cursorPos = ImguiDSL.cursorPos
+    val (x, y) = ImguiDSL.windowPos + cursorPos
+    cursorPosX += (width - calcTextSize(value.toString()).x) / 2f
+    ImGui.text(value.toString())
+    var hovered = ImGui.isItemHovered()
+    ImguiDSL.cursorPos = cursorPos
+
+    ImguiDSL.invisibleButton(value.toString(), width, frameHeight) {}
+
+    hovered = hovered || ImGui.isItemHovered()
+    drawList.addFrame(
+        x,
+        y,
+        x + width,
+        y + frameHeight,
+        (if (hovered) ImGui.getStyle()[ImGuiCol.FrameBgHovered] else ImGui.getStyle()[ImGuiCol.FrameBg]).colour
+    )
 
-        ImGui.sameLine(0f, ImGui.getStyle().itemInnerSpacingX)
-        ImguiDSL.cursorPosY += (framePaddingY / 2f)
-        ImGui.text(if (hovered) pressText else strId)
-        ImguiDSL.cursorPosY -= (framePaddingY / 2f)
+    ImGui.sameLine(0f, ImGui.getStyle().itemInnerSpacingX)
+    ImguiDSL.cursorPosY += (framePaddingY / 2f)
+    ImGui.text(if (hovered) hoverText else text)
+    ImguiDSL.cursorPosY -= (framePaddingY / 2f)
 
-        if (hovered) {
-            ImGui.captureKeyboardFromApp()
+    return if (hovered) onHover() else null
+}
 
-            val c = KamiImgui.charQueue.removeFirstOrNull() ?: return@withId
+fun charButton(text: String, char: KMutableProperty0<Char>, pressText: String? = "Type a character") {
+    inputButton(text, char.get(), pressText) {
+        ImGui.captureKeyboardFromApp()
 
-            value = c.first
-        }
+        char.set((KamiImgui.charQueue.removeFirstOrNull() ?: return@inputButton).first)
+    }
+}
+
+fun bindButton(text: String, bind: Bind, pressText: String? = "Press a key"): Bind? {
+    val width = calcTextSize(bind.toString()).x.coerceAtLeast(20f)
+    return inputButton(text, bind, pressText, width + ImGui.getStyle().framePaddingX * 2f) {
+        ImGui.captureKeyboardFromApp()
+        val c = KamiImgui.keyQueue.removeFirstOrNull() ?: return@inputButton null
+        val modifiers = Settings.modifiersEnabled
+        return@inputButton Bind(
+            ImGui.getIO().keyCtrl && modifiers,
+            ImGui.getIO().keyAlt && modifiers,
+            ImGui.getIO().keyShift && modifiers,
+            c
+        )
     }
 }

src/main/kotlin/me/zeroeightsix/kami/gui/KamiImgui.kt

@@ -14,6 +14,7 @@ import me.zeroeightsix.kami.KamiMod
 import me.zeroeightsix.kami.gui.windows.Settings
 import me.zeroeightsix.kami.mc
 import me.zeroeightsix.kami.tryOrNull
+import me.zeroeightsix.kami.util.Bind
 import net.minecraft.client.util.math.MatrixStack
 import org.lwjgl.opengl.GL
 
@@ -23,6 +24,7 @@ object KamiImgui {
     // Anything pasted in by the clipboard will not appear in this queue.
     // It is cleared after each `frame` call.
     val charQueue = mutableListOf<Pair<Char, Int/*keycode*/>>()
+    val keyQueue = mutableListOf<Bind.Code>()
     val imguiGlfw: ImGuiImplGlfw = ImGuiImplGlfw()
     private val imguiGl: ImGuiImplGl3 = ImGuiImplGl3()
     private val postDrawStack: Stack<(MatrixStack) -> Unit> = Stack()
@@ -119,6 +121,7 @@ object KamiImgui {
                 }
             }
             charQueue.clear()
+            keyQueue.clear()
         }
     }
 

src/main/kotlin/me/zeroeightsix/kami/setting/KamiConfig.kt

@@ -4,7 +4,6 @@ import com.mojang.authlib.GameProfile
 import imgui.ImGui.colorEdit4
 import imgui.ImGui.dragScalar
 import imgui.ImGui.inputText
-import imgui.ImGui.sameLine
 import imgui.ImGui.text
 import imgui.flag.ImGuiColorEditFlags
 import imgui.flag.ImGuiDataType
@@ -74,11 +73,11 @@ import me.zeroeightsix.kami.feature.FindSettings
 import me.zeroeightsix.kami.feature.FullFeature
 import me.zeroeightsix.kami.feature.HasConfig
 import me.zeroeightsix.kami.feature.module.Module
-import me.zeroeightsix.kami.gui.ImguiDSL.button
 import me.zeroeightsix.kami.gui.ImguiDSL.checkbox
 import me.zeroeightsix.kami.gui.ImguiDSL.combo
 import me.zeroeightsix.kami.gui.ImguiDSL.imgui
 import me.zeroeightsix.kami.gui.ImguiDSL.wrapImFloat
+import me.zeroeightsix.kami.gui.bindButton
 import me.zeroeightsix.kami.gui.text.CompiledText
 import me.zeroeightsix.kami.gui.text.VarMap
 import me.zeroeightsix.kami.gui.widgets.PinnableWidget
@@ -536,13 +535,8 @@ object KamiConfig {
             }
         )
         .extend(
-            { _, bind ->
-                text("Bound to $bind") // TODO: Highlight bind in another color?
-                sameLine(0f, -1f)
-                button("Bind") { // TODO: Bind popup?
-                    // Maybe just display "Press a key" instead of the normal "Bound to ...", and wait for a key press.
-                }
-                null
+            { name, bind ->
+                return@extend bindButton(name, bind)
             },
             { _, b ->
                 val range = 0..b.remaining.lastIndexOf('+')