Register Key Mapping

Translate

• Click here to translate this page.

• How do I change language?

If you want to change the default key bind for all players, you MUST change it in the configs/config.lua BEFORE starting the resource on your main server.

Info

We have started using the FiveM native called RegisterKeyMapping FiveM Documentation. This removes the need for while loops checking every frame for keypresses, therefore allowing the resource to be more optimised. This FiveM native works by triggering the chat command it has been registered with when the keybind is pressed. This new method also allows each client to change their own key binds in-game. Example Open Gta5 settings > Key Bindings > FiveM.

How to Unbind Keys

Once you have started the resource on your server for the first time, even if you change the key in the config.lua, it will not change for the players who have already joined. Although it will change for the players who join after you have changed it.

Option 1:

• To unbind keys for your client only you can type unbind keyboardinput_parameter in F8.

Option 2:

• Go to C:\Users[USERNAME]\AppData\Roaming\CitizenFX

• Open fivem.cfg

• Remove the lines with this resource name.

• Restart Fivem. Keybinds will be set back to default values set in the config.

How to Disable KeyMapping

• Firstly unbind the keys using the method above, disable the key in the config.lua and then you can rewrite the code to use the regular method of while loops checking for key presses IsControlJustReleased or other methods to trigger the events we provide to you in our docs.

Notes

• There is no way to mass unbind keys for all of your server's players.

• The full list of available keys can be found here.