RegisterRawKeymap
DocsRegisterRawKeymap(keymapName, onKeyDown, onKeyUp, rawKeyIndex, canBeDisabled)Description
Registers a keymap that will be triggered whenever rawKeyIndex is pressed or released.
onKeyUp and onKeyDown will not provide any arguments.
function onStateChange();Parameters
| Name | Type | Description |
|---|---|---|
keymapName | char* | A **unique** name that the keymap will be bound to, duplicates will result in the keymap not being registered. |
onKeyDown | func | The function to run when the key is being pressed, or `nil`. |
onKeyUp | func | The function to run when the key is no longer being pressed, or `nil`. |
rawKeyIndex | int | The virtual key to bind this keymap to, see a list [here](https://learn.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes) |
canBeDisabled | BOOL | If calls to [DISABLE_RAW_KEY_THIS_FRAME](#\_0x8BCF0014) will disable this keymap, if a keymap was disabled when the key was pressed down it will still call `onKeyUp` on release. |
Returns
voidThis native does not return a value.
Examples
Official
function on_key_up()
print("key no longer pressed")
end
function on_key_down()
print("key is pressed")
end
local KEY_E = 69
local canBeDisabled = false
RegisterRawKeymap("our_keymap", on_key_up, on_key_down, KEY_E, canBeDisabled)