RegisterKeyMapping - FiveM Natives @ Cfx.re Docs

FiveM Docs / Native Reference

Namespace: CFXAPI set: clientGame: gta5editImprove

REGISTER_KEY_MAPPING

0xD7664FD1

// RegisterKeyMapping
void REGISTER_KEY_MAPPING(char* commandString, char* description, char* defaultMapper, char* defaultParameter);

Parameters:

commandString:
The command to execute, and the identifier of the binding.
description:
A description for in the settings menu.
defaultMapper:
The mapper ID to use for the default binding, e.g. keyboard.
defaultParameter:
The IO parameter ID to use for the default binding, e.g. f3.

Registers a key mapping for the current resource.

See the related cookbook post for more information.

Below you can find some examples on how to create these keybindings as well as the alternate keybinding syntax, which is preceded by ~! to indicate that it's an alternate key.

Examples:

Lua

local handsUp = false
CreateThread(function()
    while true do
        Wait(0)
        if handsUp then
            TaskHandsUp(PlayerPedId(), 250, PlayerPedId(), -1, true)
        end
    end
end)
RegisterCommand('+handsup', function()
    handsUp = true
end, false)
RegisterCommand('-handsup', function()
    handsUp = false
end, false)

RegisterKeyMapping('+handsup', 'Hands Up', 'keyboard', 'i')

-- Alternate keybinding syntax
RegisterKeyMapping('~!+handsup', 'Hands Up - Alternate Key', 'keyboard', 'o')

MUMBLE_SET_VOICE_TARGET(int targetId)

MUMBLE_SET_VOLUME_OVERRIDE(Player player, float volume)

MUMBLE_SET_VOLUME_OVERRIDE_BY_SERVER_ID(int serverId, float volume)

NETWORK_GET_ENTITY_FROM_NETWORK_ID(int netId)

NETWORK_GET_ENTITY_OWNER(Entity entity)

NETWORK_GET_FIRST_ENTITY_OWNER(Entity entity)

NETWORK_GET_NETWORK_ID_FROM_ENTITY(Entity entity)

NETWORK_GET_VOICE_PROXIMITY_OVERRIDE_FOR_PLAYER(char* playerSrc)

OVERRIDE_PEDS_CAN_STAND_ON_TOP_FLAG(BOOL flag)

OVERRIDE_PEDS_USE_DEFAULT_DRIVE_BY_CLIPSET(BOOL flag)

OVERRIDE_POP_GROUPS(char* path)

OVERRIDE_VEHICLE_PEDS_CAN_STAND_ON_TOP_FLAG(Vehicle vehicle, BOOL can)

PERFORM_HTTP_REQUEST_INTERNAL(char* requestData, int requestDataLength)

PERFORM_HTTP_REQUEST_INTERNAL_EX(object requestData)

PRINT_STRUCTURED_TRACE(char* jsonString)

PROFILER_ENTER_SCOPE(char* scopeName)

PROFILER_EXIT_SCOPE

PROFILER_IS_RECORDING

REGISTER_ARCHETYPES(func factory)

REGISTER_COMMAND(char* commandName, func handler, BOOL restricted)

REGISTER_CONSOLE_LISTENER(func listener)

REGISTER_ENTITIES(func factory)

REGISTER_FONT_FILE(char* fileName)

REGISTER_FONT_ID(char* fontName)

REGISTER_KEY_MAPPING(char* commandString, char* description, char* defaultMapper, char* defaultParameter)

REGISTER_NUI_CALLBACK(char* callbackType, func callback)

REGISTER_NUI_CALLBACK_TYPE(char* callbackType)

REGISTER_RAW_NUI_CALLBACK(char* callbackType, func callback)

REGISTER_RESOURCE_AS_EVENT_HANDLER(char* eventName)

REGISTER_RESOURCE_ASSET(char* resourceName, char* fileName)

REGISTER_RESOURCE_BUILD_TASK_FACTORY(char* factoryId, func factoryFn)

REGISTER_STREAMING_FILE_FROM_CACHE(char* resourceName, char* fileName, char* cacheString)

REGISTER_STREAMING_FILE_FROM_KVS(char* kvsKey)

REGISTER_STREAMING_FILE_FROM_URL(char* registerAs, char* url)

REMOVE_ALL_PED_WEAPONS(Ped ped, BOOL p1)