[1.15.2] Keybinding won't trigger in ChestScreen

[henne90gen]

Hello,

 

I have implemented keybindings for my mod like this:

public void clientSetup(final FMLClientSetupEvent event) {
	int keyCode = 297;
	String description = "description";
	keybinding = new KeyBinding(description, KeyConflictContext.UNIVERSAL, KeyModifier.NONE, InputMappings.Type.KEYSYM, keyCode, "category");
	ClientRegistry.registerKeyBinding(keybinding);
}

@SubscribeEvent
public void keyPressed(InputEvent.KeyInputEvent event) {
	if (keybinding.isPressed()) {
    	// do something
	}
}

 

I first register the keybinding in the FMLClientSetupEvent and then I use the isPressed method inside of a KeyInputEvent to find out whether the keybinding has been pressed.

This works great in most cases.

 

The only problem is, that it does not work in ChestScreens.

Does anybody know why that could be the case?

 

Henne

[DavidM]

IIRC key bindings are not fired when inside a Screen.

You have to subscribe to GuiScreenEvent.KeyboardKeyEvent or its subclasses to handle key presses inside a Screen.

[henne90gen]

I tried all the GuiScreenEvent.Keyboard* classes.

Nothing makes the keybinding.isPressed method return true.

They are definitely being called, but the keybinding is not being triggered.

The inventory screen for example worked right away, but as I said, the ChestScreen is giving me some trouble.

[DavidM]

25 minutes ago, henne90gen said:

I tried all the GuiScreenEvent.Keyboard* classes.

Nothing makes the keybinding.isPressed method return true.

They are definitely being called, but the keybinding is not being triggered.

The inventory screen for example worked right away, but as I said, the ChestScreen is giving me some trouble.

That is expected, as key binds are not triggered inside screens.

4 hours ago, DavidM said:

IIRC key bindings are not fired when inside a Screen.

 

You will need to check KeyboardKeyEvent#getKeyCode manually in the event.

Edited June 13, 2020 by DavidM

[henne90gen]

Ah ok.

I'll have to do it manually then.

Thanks for your help.

[romangraef]

Disclaimer: I am not an expierenced forge dev, this is just what i found after digging through a bunch of code (aka Minecraft internals).

Okay, this is just for future reference, if someone else finds this thread and tries implementing it themselves. For singular events (like an inventory sort) i think subscribing to a `GuiScreenEvent.KeyboardKeyEvent` or even just as `KeyInputEvent` and then checking for keycode and modifiers might be best, but for toggles (like holding a key to show a different UI screen) i found using InputMappings.isKeyDown better.

 

private boolean isKeyBindDown(KeyBinding keyBinding) {
    if (keyBinding.isKeyDown()) return true;
    InputMappings.Input key = keyBinding.getKey();
    int keyCode = key.getKeyCode();
    // GL window handle
    long handle = Minecraft.getInstance().getMainWindow().getHandle();
    return InputMappings.isKeyDown(handle, keyCode) && keyBinding.getKeyModifier().isActive(keyBinding.getKeyConflictContext());
}

 

`InputMappings` is internally used by `KeyModifier#isActive` as well, so im fairly confident that this is at least a somewhat intended path. This should only work with Keyboard Keybinds and not Mousebindings, but i haven't found a way for that yet, and honestly even finding this took way to long.

 

Short addendum after i already wrote most of this: `KeyModifier#isActive` doesn't actually check the passed `IKeyConflictContext` so one should maybe check that it is active, but i think, since this mostly concerns GUIs that should actually be already checked.