The input mapper is used with RegisterKeyMapping to create custom keybinds that
players can rebind in their FiveM settings. This is the recommended way to handle
custom key inputs.
-- Register a custom key mapping
RegisterKeyMapping("my_command", "My Custom Action", "keyboard", "F5")
-- Register the associated command
RegisterCommand("my_command", function()
print("F5 pressed! (or whatever the player rebound it to)")
end, false)
-- Gamepad mapping
RegisterKeyMapping("my_command", "My Custom Action", "PAD_DIGITALBUTTONANY", "LSHOULDER")// JavaScript equivalent
RegisterKeyMapping("my_command", "My Custom Action", "keyboard", "F5");
RegisterCommand("my_command", () => {
console.log("F5 pressed!");
});| Input Name | Description | Default Mapping |
|---|---|---|
| keyboard | Standard keyboard device | LSHIFT, LCONTROL, etc. |
| PAD_ANALOGBUTTON | Gamepad analog button | LTHUMB_DOWN, RTHUMB_UP |
| PAD_DIGITALBUTTONANY | Any gamepad digital button | A, B, X, Y, etc. |
| MOUSE_BUTTON | Mouse button input | LEFT_BUTTON, RIGHT_BUTTON, MIDDLE_BUTTON |
| MOUSE_BUTTONANY | Any mouse button | LEFT_BUTTON |
| MOUSE_WHEEL | Mouse scroll wheel | SCROLLWHEEL_UP, SCROLLWHEEL_DOWN |
| MKB_AXIS | Mouse/keyboard axis | MOUSE_X, MOUSE_Y |
| A | A key | keyboard A |
| B | B key | keyboard B |
| C | C key | keyboard C |
| D | D key | keyboard D |
| E | E key | keyboard E |
| F | F key | keyboard F |
| G | G key | keyboard G |
| H | H key | keyboard H |
| I | I key | keyboard I |
| J | J key | keyboard J |
| K | K key | keyboard K |
| L | L key | keyboard L |
| M | M key | keyboard M |
| N | N key | keyboard N |
| O | O key | keyboard O |
| P | P key | keyboard P |
| Q | Q key | keyboard Q |
| R | R key | keyboard R |
| S | S key | keyboard S |
| T | T key | keyboard T |
| U | U key | keyboard U |
| V | V key | keyboard V |
| W | W key | keyboard W |
| X | X key | keyboard X |
| Y | Y key | keyboard Y |
| Z | Z key | keyboard Z |
| 0 | 0 key | keyboard 0 |
| 1 | 1 key | keyboard 1 |
| 2 | 2 key | keyboard 2 |
| 3 | 3 key | keyboard 3 |
| 4 | 4 key | keyboard 4 |
| 5 | 5 key | keyboard 5 |
| 6 | 6 key | keyboard 6 |
| 7 | 7 key | keyboard 7 |
| 8 | 8 key | keyboard 8 |
| 9 | 9 key | keyboard 9 |
| NUMPAD0 | Numpad 0 | keyboard NUMPAD0 |
| NUMPAD1 | Numpad 1 | keyboard NUMPAD1 |
| NUMPAD2 | Numpad 2 | keyboard NUMPAD2 |
| NUMPAD3 | Numpad 3 | keyboard NUMPAD3 |
| NUMPAD4 | Numpad 4 | keyboard NUMPAD4 |
| NUMPAD5 | Numpad 5 | keyboard NUMPAD5 |
| NUMPAD6 | Numpad 6 | keyboard NUMPAD6 |