tutorial:keybinds
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
tutorial:keybinds [2019/06/17 16:22] – mapping fix draylar | tutorial:keybinds [2020/12/05 18:07] – formatting majavah | ||
---|---|---|---|
Line 4: | Line 4: | ||
Minecraft handles user input from peripherals such as the keyboard & mouse using key-binds. When you press W your character moves forward, and when you press E your inventory opens. Every keybind can also be configured with the settings menu, so you can make your player move with arrow keys instead of WASD if you so desire. | Minecraft handles user input from peripherals such as the keyboard & mouse using key-binds. When you press W your character moves forward, and when you press E your inventory opens. Every keybind can also be configured with the settings menu, so you can make your player move with arrow keys instead of WASD if you so desire. | ||
+ | |||
+ | This tutorial assumes you have the key bindings API, if not add '' | ||
Adding a key-bind is easy. You'll need to: | Adding a key-bind is easy. You'll need to: | ||
- | * create a FabricKeyBinding | + | * create a KeyBinding |
- | * register your key | + | |
* react to the key being pressed | * react to the key being pressed | ||
+ | |||
+ | See [[https:// | ||
==== Creating your Keybind ==== | ==== Creating your Keybind ==== | ||
- | Fabric API has a **FabricKeyBinding** object, which makes it easier to create your own **KeyBinding**. | + | Declare one of these in an area of your preference: |
<code java> | <code java> | ||
- | private static | + | private static |
</ | </ | ||
Line 22: | Line 25: | ||
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
- | keyBinding = FabricKeyBinding.Builder.create( | + | keyBinding = KeyBindingHelper.registerKeyBinding(new KeyBinding( |
- | | + | |
- | InputUtil.Type.KEYSYM, | + | InputUtil.Type.KEYSYM, |
- | GLFW.GLFW_KEY_R, | + | GLFW.GLFW_KEY_R, |
- | "Wiki Keybinds" | + | "category.examplemod.test" |
- | ).build(); | + | )); |
</ | </ | ||
- | | ||
- | GLFW.GLFW_KEY_R can be replaced with whatever key you want the binding to default to. The category is related to how the keybinding is grouped in the settings page. | ||
- | + | If you want a sticky key, add '' | |
- | ==== Registering your Keybind ==== | + | |
- | + | ||
- | To register your keybinding, use the **KeybindingRegistry**: | + | |
- | + | ||
- | <code java> | + | |
- | KeyBindingRegistry.INSTANCE.register(keyBinding); | + | |
- | </code> | + | |
| | ||
- | If you log in to your game now, you will see your key binding in the settings page. | + | '' |
==== Responding to your Keybind ==== | ==== Responding to your Keybind ==== | ||
- | + | The code here will print "Key 1 was pressed!" | |
- | Unfortunately, | + | |
<code java> | <code java> | ||
- | ClientTickCallback.EVENT.register(e -> | + | |
- | { | + | ClientTickEvents.END_CLIENT_TICK.register(client |
- | | + | |
+ | client.player.sendMessage(new LiteralText("Key 1 was pressed!" | ||
+ | } | ||
}); | }); | ||
</ | </ | ||
| | ||
Keep note that this is entirely client-side. To have the server respond to a keybind, you'll need to send a custom packet and have the server handle it separately. | Keep note that this is entirely client-side. To have the server respond to a keybind, you'll need to send a custom packet and have the server handle it separately. |
tutorial/keybinds.txt · Last modified: 2023/12/27 13:14 by 2601:188:cb7c:25a0:19fa:9122:4e5a:fad1