UScreen: improved input handling (via optional interface) by Traben-0 · Pull Request #125 · SparkUniverse/UniversalCraft

Traben-0 · 2026-03-05T13:10:02Z

new implementation based on feedback from DJ's old PR

Old pr: #52

Internal issue reference: EM-1645

… match modern mc

- uSuperConsumableInputHandler() default instance should call super directly - separate uKeypress and uCharTyped Linear: EM-1645

Linear: EM-1645

…via-esc-on-119-puts-you-in-the-menu-rather' into feature/em-1645-closing-uscreen-via-esc-on-119-puts-you-in-the-menu-rather # Conflicts: # src/main/kotlin/gg/essential/universal/UScreen.kt

Linear: EM-1645

Johni0702

Looking at the integration in Elementa has given me two more ideas.

Linear: EM-1645

…via-esc-on-119-puts-you-in-the-menu-rather' into feature/em-1645-closing-uscreen-via-esc-on-119-puts-you-in-the-menu-rather

Linear: EM-1645

Johni0702

Looks good to me again, but let's wait with merging until we've got the whole stack (UC+Elementa+Essential) done, in case we find more stuff that should be changed along the way.

Linear: EM-1645

… modifiers Linear: EM-1645

Traben-0 · 2026-04-26T06:17:59Z

re: SparkUniverse/Elementa#177 (comment)

Linear: EM-1645

Traben-0 · 2026-04-26T10:32:46Z

+        // Must be called with consistently scaled scroll deltas on all mc/lwjgl versions.
+        // This is to ensure a consistent scrolling experience across all versions.
+        // See onMouseScrolled(Double) for further explanation.
+        fun uMouseScrolled(x: Double, y: Double, scrollX: Double, scrollY: Double): Boolean =


Thought: I know MC doesn't provide them for scrolling, but should we maybe supply modifiers here for consistency on our end?

elementa has atleast 3 calls to check modifier key presses via UKeyboard.is*KeyDown() in scroll events, so there is a precedent for needing them.

Granted there is currently no technical different between supplying UKeyboard.getKeyModifiers() here and using the UKeyboard.is*KeyDown() further within the events, other than the mentioned consistency between the mouse events.

Would also cover us if MC ever added them.

Good call. Yeah, I think that would make sense.
GLFW doesn't currently provide that info, but there's an issue for it, which suggests that it should be possible. That issue hasn't been closed yet, and I see no conceptual reason to pass the modifiers with scroll events (like there are in case of the charType events), so I can see no reason for us not to already include it in our API.

Johni0702 · 2026-04-27T15:52:22Z

+        else isControlKeyDown()
+
+    @JvmStatic
+    fun isCommandKeyDown(): Boolean = isKeyDown(KEY_LMETA) || isKeyDown(KEY_RMETA)


suggestion: Would call this isSuperKeyDown, for consistency with our Modifier.isSuper.

That, or isMetaKeyDown, since that's what we call our KEY_ constants. But I think staying consistent with the new stuff (and lwjgl3, which also calls them GLFW_KEY_LEFT/RIGHT_SUPER) is better here.

I don't think we're calling it Command anywhere else.

Johni0702 · 2026-04-27T16:00:04Z


    @JvmStatic
-    fun isKeyComboCtrlA(key: Int): Boolean = key == KEY_A && isCtrlKeyDown() && !isShiftKeyDown() && !isAltKeyDown()
+    fun getKeyModifiers(): Modifiers = Modifiers(isControlKeyDown(), isShiftKeyDown(), isAltKeyDown(), isCommandKeyDown())


thought: Not sure we should even provide this new variant of the getModifiers method.

You usually shouldn't be using getModifiers anyway because it depends on global state. You should be using the Modifiers instance that comes with your mouseClick/etc. call.

Johni0702 · 2026-04-27T16:02:58Z

-    data class Modifiers(val isCtrl: Boolean, val isShift: Boolean, val isAlt: Boolean)
+    data class Modifiers(
+        val isCtrl: Boolean,
+        val isShift: Boolean,
+        val isAlt: Boolean,
+        val isSuper: Boolean,
+    ) {


issue: Breaking change. Also need to supply a three-args copy method. See the red lines in the .api file diff.

Johni0702 · 2026-04-27T16:07:06Z

                it.uCharTyped(typedChar.code)
            }
-        } ?: @Suppress("DEPRECATION") onKeyPressed(keyCode, typedChar, UKeyboard.getModifiers())
+        } ?: @Suppress("DEPRECATION") onKeyPressed(keyCode, typedChar, UKeyboard.getKeyModifiers())


issue: Breaking change. We must only change the modifier we pass to the new methods, we must not change the ones we pass to the old methods because people might already be relying on that behavior.

Johni0702 · 2026-04-27T16:10:54Z

    final override fun mouseClicked(mouseX: Int, mouseY: Int, mouseButton: Int) {
-        inputHandler?.uMouseClicked(mouseX.restoreFrac(UMouse.Scaled.x), mouseY.restoreFrac(UMouse.Scaled.y), mouseButton, UKeyboard.getModifiers())
+        inputHandler?.uMouseClicked(mouseX.restoreFrac(UMouse.Scaled.x), mouseY.restoreFrac(UMouse.Scaled.y), mouseButton, UKeyboard.getKeyModifiers())
            ?: @Suppress("DEPRECATION") onMouseClicked(mouseX.toDouble(), mouseY.toDouble(), mouseButton)
    }

    final override fun mouseReleased(mouseX: Int, mouseY: Int, state: Int) {
-        inputHandler?.uMouseReleased(mouseX.restoreFrac(UMouse.Scaled.x), mouseY.restoreFrac(UMouse.Scaled.y), state, UKeyboard.getModifiers())
+        inputHandler?.uMouseReleased(mouseX.restoreFrac(UMouse.Scaled.x), mouseY.restoreFrac(UMouse.Scaled.y), state, UKeyboard.getKeyModifiers())
            ?: @Suppress("DEPRECATION") onMouseReleased(mouseX.toDouble(), mouseY.toDouble(), state)
    }

    final override fun mouseClickMove(mouseX: Int, mouseY: Int, clickedMouseButton: Int, timeSinceLastClick: Long) {
-        inputHandler?.uMouseDragged(mouseX.restoreFrac(UMouse.Scaled.x), mouseY.restoreFrac(UMouse.Scaled.y), clickedMouseButton, UKeyboard.getModifiers())
+        inputHandler?.uMouseDragged(mouseX.restoreFrac(UMouse.Scaled.x), mouseY.restoreFrac(UMouse.Scaled.y), clickedMouseButton, UKeyboard.getKeyModifiers())
            ?: @Suppress("DEPRECATION") onMouseDragged(mouseX.toDouble(), mouseY.toDouble(), clickedMouseButton, timeSinceLastClick)
    }


issue: Each of these has a pre-processed version that needs to be updated as well.

Johni0702 · 2026-04-27T16:36:46Z

-        val isOSModifier = if (UMinecraft.isRunningOnMac) isSuper else isCtrl
+        fun isPlatformModifierActive() =
+            if (UMinecraft.isRunningOnMac) isSuper && !isShift && !isAlt && !isCtrl
+            else isCtrl && !isShift && !isAlt && !isSuper


question: What's the motivation for this rename?

I personally prefer OS over Platform.
Platform is usually what we call the underlying Minecraft version (or standalone UC framework).

I'm also not convinced we should have the ModifierActive suffix. It's inconsistent with all the other properties (though admittedly this one also works somewhat differently, although not that differently).
The Modifier is somewhat redundant because it's in the Modifiers class and will usually be called like modifiers.isPlatformModifierActive().
The Active assumes that this class is only used for the active modifiers. That's not strictly necessary though. This class could also be used for other purposes (e.g. storing the modifiers for a set of keybindings). I suppose one could still say that the modifier is active for that keybind then, but it just feels a bit off.

question: What's the motivation for this being a function rather than a property now?

question: What's the motivation for checking that other modifiers aren't pressed?

While I suppose this is a common thing one might want when checking for common shortcut combos, it does prevent one from easily recognizing shortcuts which use multiple modifiers.
So maybe should be provided as a separate option, in addition to the basic one.

Edit: Ah, third question is answered by the next commit.

Traben-0 added 5 commits March 5, 2026 22:39

UScreen: create ConsumableInputHandler interface

a3c342d

UScreen: add uSuperConsumableInputHandler() implementation

6e0b76a

UScreen: implement ConsumableInputHandler forwarding

139666a

UScreen: block ISO Control characters from super.charTyped()

951e5a6

API: update

d8b45ce

Traben-0 commented Mar 5, 2026

View reviewed changes

Comment thread src/main/kotlin/gg/essential/universal/UScreen.kt Outdated

Traben-0 commented Mar 5, 2026

View reviewed changes

Comment thread src/main/kotlin/gg/essential/universal/UScreen.kt Outdated

Traben-0 requested a review from Johni0702 March 5, 2026 13:27

Traben-0 added 8 commits March 6, 2026 14:30

UScreen: revert diff to old behaviour

838a66b

UScreen: prevent control code characters in older minecraft events to…

c20a4ba

… match modern mc

Review:

1cc2422

- uSuperConsumableInputHandler() default instance should call super directly - separate uKeypress and uCharTyped Linear: EM-1645

missed preprocessor block changes

73e8e28

Linear: EM-1645

api changes

7b3d183

Linear: EM-1645

Merge remote-tracking branch 'origin/feature/em-1645-closing-uscreen-…

1b0bfa6

…via-esc-on-119-puts-you-in-the-menu-rather' into feature/em-1645-closing-uscreen-via-esc-on-119-puts-you-in-the-menu-rather # Conflicts: # src/main/kotlin/gg/essential/universal/UScreen.kt

Review: protect field

705f710

Linear: EM-1645

api change

b235141

Linear: EM-1645

Johni0702 requested changes Mar 10, 2026

View reviewed changes

Johni0702 reviewed Mar 10, 2026

View reviewed changes

Comment thread src/main/kotlin/gg/essential/universal/UScreen.kt Outdated

Traben-0 added 12 commits March 18, 2026 20:33

Review: drop consumable prefix

2097acf

Linear: EM-1645

Review: pass scancode

db1fdc3

Linear: EM-1645

Review: use codepoint

eafc88b

Linear: EM-1645

missed comment renames

716576d

Linear: EM-1645

Review: pass modifiers

970674e

Linear: EM-1645

Review: revert original functions

b89c0f6

Linear: EM-1645

Review: remove timeSinceLastClick and add x/y offsets in modern function

cea00b8

Linear: EM-1645

Review: only pass valid keycodes and chars

b3ab8f0

Linear: EM-1645

Review: remove catches

56ea5e7

Linear: EM-1645

Review: remove pre caught conditions

c0cdcb0

Linear: EM-1645

Review: remove nullable modifiers

accfa3c

Linear: EM-1645

Review: parameter name nits

77134dc

Linear: EM-1645

Traben-0 added 4 commits March 24, 2026 18:16

Review: 1.21.9 case too

5402cf7

Linear: EM-1645

implement in standalone UScreen

0c4c400

Linear: EM-1645

missing closing bracket

27212ed

Linear: EM-1645

missing preprocessor block

d9a1f6b

Linear: EM-1645

Traben-0 requested a review from Johni0702 March 24, 2026 09:09

Johni0702 requested changes Mar 25, 2026

View reviewed changes

Comment thread src/main/kotlin/gg/essential/universal/UScreen.kt Outdated

Comment thread standalone/src/main/kotlin/gg/essential/universal/UScreen.kt Outdated

Comment thread standalone/src/main/kotlin/gg/essential/universal/standalone/UCWindow.kt Outdated

Traben-0 added 2 commits March 27, 2026 08:57

Review: fix indent

6669e89

Linear: EM-1645

Review: use an internal property

dd0bf25

Linear: EM-1645

Traben-0 requested a review from Johni0702 March 26, 2026 23:02

Traben-0 mentioned this pull request Mar 29, 2026

WindowScreen & UIComponent: Improve key input handling SparkUniverse/Elementa#177

Draft

Johni0702 requested changes Mar 31, 2026

View reviewed changes

Comment thread src/main/kotlin/gg/essential/universal/UScreen.kt Outdated

Comment thread src/main/kotlin/gg/essential/universal/UScreen.kt Outdated

Review: pass fractional mouse pos in older mc

0fa2810

Linear: EM-1645

Traben-0 requested a review from Johni0702 April 5, 2026 23:50

Johni0702 requested changes Apr 8, 2026

View reviewed changes

Comment thread src/main/kotlin/gg/essential/universal/UScreen.kt

Traben-0 added 3 commits April 9, 2026 11:53

Review: block PUA characters

e3f9a1f

Linear: EM-1645

Merge remote-tracking branch 'origin/feature/em-1645-closing-uscreen-…

077b0f5

…via-esc-on-119-puts-you-in-the-menu-rather' into feature/em-1645-closing-uscreen-via-esc-on-119-puts-you-in-the-menu-rather

Review: restore fractional mouse without overriding the input positions

ba5403e

Linear: EM-1645

Traben-0 requested a review from Johni0702 April 9, 2026 02:13

Johni0702 previously approved these changes Apr 9, 2026

View reviewed changes

Traben-0 added 2 commits April 26, 2026 16:11

Review from elementa: add super key to modifiers

a9da605

Linear: EM-1645

Review from elementa: deprecation directing users to use provided key…

0e948fd

… modifiers Linear: EM-1645

Traben-0 dismissed Johni0702’s stale review via 0e948fd April 26, 2026 06:17

Traben-0 added 4 commits April 26, 2026 16:53

fix non-final property name in preprocessed block

522acc4

Linear: EM-1645

api changes

f3f15af

Linear: EM-1645

change check and naming

0a05061

Linear: EM-1645

further modifier options

c0a5cc5

Linear: EM-1645

Traben-0 commented Apr 26, 2026

View reviewed changes

Traben-0 requested a review from Johni0702 April 27, 2026 03:45

Johni0702 requested changes Apr 27, 2026

View reviewed changes

Uh oh!

Conversation

Traben-0 commented Mar 5, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Johni0702 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Johni0702 left a comment

Choose a reason for hiding this comment

Uh oh!

Traben-0 commented Apr 26, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Traben-0 Apr 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Traben-0 Apr 26, 2026 •

edited

Loading