Add option to block held movement key input

Author: NotRyken

changelog.md

@@ -7,6 +7,7 @@
 - Added an option to disable saving when exiting using the 'Escape' key.
 - Added a 'Revert' GUI button.
 - Added an option to conditionally prevent opening the sign editor.
+- Added an option to block movement key input until key release when opening the sign editor.
 
 ## 1.2.0
 

common/src/main/java/dev/terminalmc/signedit/SignEdit.java

@@ -24,7 +24,10 @@
 import net.minecraft.network.chat.Component;
 import org.apache.logging.log4j.Logger;
 
+import java.util.ArrayList;
+import java.util.HashSet;
 import java.util.List;
+import java.util.Set;
 
 public class SignEdit {
 
@@ -38,6 +41,9 @@ public class SignEdit {
             .withStyle(ChatFormatting.GRAY);
     public static final List<KeyMapping> KEYBINDS = List.of();
 
+    public static final List<KeyMapping> checkKeys = new ArrayList<>();
+    public static final Set<KeyMapping> downKeys = new HashSet<>();
+
     public static boolean enhancedEditing;
 
     public static String[] copiedLines;

common/src/main/java/dev/terminalmc/signedit/config/Config.java

@@ -79,6 +79,9 @@ public static class Options {
 
         public static final EditCondition editConditionDefault = EditCondition.ALWAYS;
         public EditCondition editCondition = editConditionDefault;
+
+        public static final boolean blockMovementKeysDefault = true;
+        public boolean blockMovementKeys = blockMovementKeysDefault;
     }
 
     // Instance management

common/src/main/java/dev/terminalmc/signedit/gui/screen/ClothScreenProvider.java

@@ -17,6 +17,7 @@
 package dev.terminalmc.signedit.gui.screen;
 
 import dev.terminalmc.signedit.config.Config;
+import dev.terminalmc.signedit.config.Config.Options;
 import me.shedaniel.clothconfig2.api.ConfigBuilder;
 import me.shedaniel.clothconfig2.api.ConfigCategory;
 import me.shedaniel.clothconfig2.api.ConfigEntryBuilder;
@@ -109,6 +110,15 @@ static Screen getConfigScreen(Screen parent) {
                 .setSaveConsumer(val -> options.saveOnEscape = val)
                 .build());
 
+        general.addEntry(eb.startBooleanToggle(
+                        localized("option", "general.blockMovementKeys"),
+                        options.blockMovementKeys
+                )
+                .setTooltip(localized("option", "general.blockMovementKeys.tooltip"))
+                .setDefaultValue(Options.blockMovementKeysDefault)
+                .setSaveConsumer(val -> options.blockMovementKeys = val)
+                .build());
+
         general.addEntry(eb.startEnumSelector(
                         localized("option", "general.editCondition"),
                         Config.EditCondition.class,

common/src/main/java/dev/terminalmc/signedit/mixin/edit/AbstractSignEditScreenMixin.java

@@ -22,11 +22,15 @@
 import dev.terminalmc.signedit.SignEdit;
 import dev.terminalmc.signedit.helper.FieldHelper;
 import dev.terminalmc.signedit.helper.ScreenHelper;
+import dev.terminalmc.signedit.mixin.input.ContainerEventHandlerMixin;
+import dev.terminalmc.signedit.mixin.input.LocalPlayerMixin;
+import net.minecraft.client.KeyMapping;
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.gui.GuiGraphicsExtractor;
 import net.minecraft.client.gui.font.TextFieldHelper;
 import net.minecraft.client.gui.screens.Screen;
 import net.minecraft.client.gui.screens.inventory.AbstractSignEditScreen;
+import net.minecraft.client.input.CharacterEvent;
 import net.minecraft.client.input.KeyEvent;
 import net.minecraft.network.chat.Component;
 import net.minecraft.world.level.block.entity.SignBlockEntity;
@@ -44,6 +48,7 @@
 
 @Debug(export = true)
 @Mixin(AbstractSignEditScreen.class)
+@SuppressWarnings("JavadocReference")
 public abstract class AbstractSignEditScreenMixin extends Screen {
 
     protected AbstractSignEditScreenMixin(Component title) {
@@ -75,6 +80,12 @@ protected AbstractSignEditScreenMixin(Component title) {
     @Final
     private boolean isFrontText;
 
+    @Unique
+    private static boolean signEdit$cancelKeyPressed;
+
+    @Unique
+    private static long signEdit$cancelKeyPressedTime;
+
     /**
      * Replaces the existing {@link TextFieldHelper} with a new {@link FieldHelper}.
      */
@@ -122,10 +133,24 @@ instance, new FieldHelper(
     }
 
     /**
-     * Diverts key-presses to {@link ScreenHelper#keyPressed}.
+     * Blocks key-presses if required, otherwise redirects to {@link ScreenHelper#keyPressed}.
+     *
+     * @see LocalPlayerMixin#onOpenTextEdit
+     * @see ContainerEventHandlerMixin#wrapKeyReleased
+     * @see #wrapCharTyped
      */
     @WrapMethod(method = "keyPressed")
     private boolean wrapKeyPressed(KeyEvent event, Operation<Boolean> original) {
+        if (options().blockMovementKeys) {
+            for (KeyMapping keyMapping : SignEdit.downKeys) {
+                if (keyMapping.matches(event)) {
+                    signEdit$cancelKeyPressed = true;
+                    signEdit$cancelKeyPressedTime = System.nanoTime();
+                    return false;
+                }
+            }
+        }
+
         if (!SignEdit.enhancedEditing)
             return original.call(event);
 
@@ -141,6 +166,24 @@ private boolean wrapKeyPressed(KeyEvent event, Operation<Boolean> original) {
         return false;
     }
 
+    /**
+     * Blocks the {@link AbstractSignEditScreen#charTyped} event associated with a blocked key
+     * press.
+     *
+     * @see #wrapKeyPressed
+     */
+    @WrapMethod(method = "charTyped")
+    private boolean wrapCharTyped(CharacterEvent event, Operation<Boolean> original) {
+        if (signEdit$cancelKeyPressed) {
+            signEdit$cancelKeyPressed = false;
+            // Cancel only if the most recent canceled press
+            // was less than 5 milliseconds ago
+            if (System.nanoTime() - signEdit$cancelKeyPressedTime < 5_000_000)
+                return false;
+        }
+        return original.call(event);
+    }
+
     /**
      * At the start of the render pass, sets the active line to the line that the cursor is
      * currently on.

common/src/main/java/dev/terminalmc/signedit/mixin/input/ContainerEventHandlerMixin.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2026 TerminalMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package dev.terminalmc.signedit.mixin.input;
+
+import com.llamalad7.mixinextras.injector.wrapmethod.WrapMethod;
+import com.llamalad7.mixinextras.injector.wrapoperation.Operation;
+import dev.terminalmc.signedit.SignEdit;
+import net.minecraft.client.gui.components.events.ContainerEventHandler;
+import net.minecraft.client.input.KeyEvent;
+import org.spongepowered.asm.mixin.Mixin;
+
+import static dev.terminalmc.signedit.config.Config.options;
+
+@Mixin(ContainerEventHandler.class)
+@SuppressWarnings("JavadocReference")
+public interface ContainerEventHandlerMixin {
+
+    /**
+     * Removes released keys from the 'down' list.
+     *
+     * @see LocalPlayerMixin#onOpenTextEdit
+     * @see dev.terminalmc.signedit.mixin.edit.AbstractSignEditScreenMixin#wrapKeyPressed
+     */
+    @WrapMethod(method = "keyReleased")
+    default boolean wrapKeyReleased(KeyEvent event, Operation<Boolean> original) {
+        if (options().blockMovementKeys) {
+            SignEdit.downKeys.removeIf(keyMapping -> keyMapping.matches(event));
+        }
+        return original.call(event);
+    }
+}

common/src/main/java/dev/terminalmc/signedit/mixin/input/LocalPlayerMixin.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2026 TerminalMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package dev.terminalmc.signedit.mixin.input;
+
+import com.mojang.blaze3d.platform.Window;
+import dev.terminalmc.signedit.SignEdit;
+import net.minecraft.client.KeyMapping;
+import net.minecraft.client.Minecraft;
+import net.minecraft.client.Options;
+import net.minecraft.client.player.LocalPlayer;
+import net.minecraft.world.level.block.entity.SignBlockEntity;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+
+import static dev.terminalmc.signedit.config.Config.options;
+
+@Mixin(LocalPlayer.class)
+@SuppressWarnings("JavadocReference")
+public abstract class LocalPlayerMixin {
+
+    /**
+     * Records the keys that are pressed on opening the sign editor, to allow subsequent blocking.
+     *
+     * @see ContainerEventHandlerMixin#wrapKeyReleased
+     * @see dev.terminalmc.signedit.mixin.edit.AbstractSignEditScreenMixin#wrapKeyPressed
+     */
+    @Inject(
+            method = "openTextEdit",
+            at = @At("HEAD")
+    )
+    private void onOpenTextEdit(SignBlockEntity sign, boolean isFrontText, CallbackInfo ci) {
+        Window window = Minecraft.getInstance().getWindow();
+        SignEdit.downKeys.clear();
+        if (options().blockMovementKeys) {
+
+            if (SignEdit.checkKeys.isEmpty()) {
+                Options options = Minecraft.getInstance().options;
+                SignEdit.checkKeys.add(options.keyUp);
+                SignEdit.checkKeys.add(options.keyLeft);
+                SignEdit.checkKeys.add(options.keyDown);
+                SignEdit.checkKeys.add(options.keyRight);
+                SignEdit.checkKeys.add(options.keyJump);
+                SignEdit.checkKeys.add(options.keyShift);
+                SignEdit.checkKeys.add(options.keySprint);
+                SignEdit.checkKeys.add(options.keyUse);
+            }
+
+            for (KeyMapping keyMapping : SignEdit.checkKeys) {
+                if (keyMapping.isDown()) {
+                    SignEdit.downKeys.add(keyMapping);
+                }
+            }
+        }
+    }
+}

common/src/main/java/dev/terminalmc/signedit/mixin/interact/ClientPacketListenerMixin.java

@@ -28,7 +28,7 @@
 import static dev.terminalmc.signedit.config.Config.options;
 
 @Mixin(ClientPacketListener.class)
-public class ClientPacketListenerMixin {
+public abstract class ClientPacketListenerMixin {
 
     /**
      * Alters the {@link ClientboundOpenSignEditorPacket} handler to optionally prevent opening the

common/src/main/resources/assets/signedit/lang/en_us.json

@@ -26,8 +26,10 @@
   "option.signedit.general.showLineBreakIndicator.tooltip": "Whether to show a symbol where a line is broken manually rather than automatically.",
   "option.signedit.general.saveOnEscape": "Save On Escape",
   "option.signedit.general.saveOnEscape.tooltip": "Whether to save the sign content when exiting by pressing the '%s' key rather than clicking the '%s' button.",
+  "option.signedit.general.blockMovementKeys": "Block Movement Keys",
+  "option.signedit.general.blockMovementKeys.tooltip": "Whether to block input from movement keys that are held down when opening the sign editor, until the keys are released.",
   "option.signedit.general.editCondition": "Edit Condition",
-  "option.signedit.general.editCondition.tooltip": "Additional condition to open the sign editor screen when right-clicking.",
+  "option.signedit.general.editCondition.tooltip": "Additional condition to open the sign editor when right-clicking.",
   "option.signedit.general.editCondition.ALWAYS": "No Condition",
   "option.signedit.general.editCondition.SNEAKING": "Only if Sneaking",
   "option.signedit.general.editCondition.NOT_SNEAKING": "Only if not Sneaking",

common/src/main/resources/signedit.mixins.json

@@ -14,6 +14,8 @@
     "edit.AbstractSignEditScreenMixin",
     "gui.AbstractSignEditScreenMixin",
     "gui.ScreenMixin",
+    "input.ContainerEventHandlerMixin",
+    "input.LocalPlayerMixin",
     "interact.ClientPacketListenerMixin"
   ],
   "server": [