--  LUA  RegisterKeyMapping

0xD7664FD1

-- REGISTER_KEY_MAPPING
RegisterKeyMapping(
	commandString --[[ string ]], 
	description --[[ string ]], 
	defaultMapper --[[ string ]], 
	defaultParameter --[[ string ]]
)

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.

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')
 
 

Parameters:

header:

sentence.

header:

sentence.

header:

sentence.

Returns:

sentence.

Summary

sentence.

Example

---  
    


Additional natives used in this example, or natives commonly used with this native.

NATIVE, NATIVE

Common Errors or Problems

Problem: sentence.

Problem: sentence.

Problem: sentence.

Credits and Disclaimers

The base of this data was taken from the redm/cfx fivem/rdr docs, and vespura. We have been saving and making notes for two years now, and are now adding them to our site for everyone to use. We will be modifying the notes as needed, and building tutorials around the data so these pages will change as we work on it. This is a manual process, not an automated one, so updates will occur as we have time, the priority is releasing resources. Thanks for your patience.

Was the documentation useful?

Related Examples and Posts