Package net.fabricmc.fabric.api.client.keybinding.v1

Class KeyBindingHelper

java.lang.Object

net.fabricmc.fabric.api.client.keybinding.v1.KeyBindingHelper

public final class KeyBindingHelper
extends Object

Helper for registering key bindings.

Helper class for KeyBinding for use by Fabric mods.

 KeyBinding left = KeyBindingHelper.registerKeyBinding(new KeyBinding("key.example.left", InputUtil.Type.KEYSYM, GLFW.GLFW_KEY_P, "key.category.example"));
 KeyBinding right = KeyBindingHelper.registerKeyBinding(new KeyBinding("key.example.right", InputUtil.Type.KEYSYM, GLFW.GLFW_KEY_U, "key.category.example"));
 

Method Summary

Modifier and Type	Method	Description
static InputUtil.Key	getBoundKeyOf(KeyBinding keyBinding)	Returns the configured KeyCode bound to the KeyBinding from the player's settings.
static KeyBinding	registerKeyBinding(KeyBinding keyBinding)	Registers the keybinding and add the keybinding category if required.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

registerKeyBinding

public static KeyBinding registerKeyBinding(KeyBinding keyBinding)

Registers the keybinding and add the keybinding category if required.

Parameters:

keyBinding - the keybinding

Returns:

the keybinding itself

getBoundKeyOf

public static InputUtil.Key getBoundKeyOf(KeyBinding keyBinding)

Returns the configured KeyCode bound to the KeyBinding from the player's settings.

Parameters:

keyBinding - the keybinding

Returns:

configured KeyCode