IS_RAW_KEY_DOWN

Gets if the specified rawKeyIndex is pressed down on the keyboard.

Hash0xD95A7387

Runtime nameIsRawKeyDown

NamespaceCFX

SideClient

NameOfficial

Docs

Signature

BOOL IS_RAW_KEY_DOWN(int rawKeyIndex);

Parameters

Name	Type	Description
`rawKeyIndex`	`int`	Index of raw key from keyboard.

Returns BOOL — Returns bool value of down state.

Description

Cfx.re native reference

Gets if the specified rawKeyIndex is pressed down on the keyboard.

This will not be triggered if the key is disabled with DISABLE_RAW_KEY_THIS_FRAME

Virtual key codes can be found here

Usage

Lua

local retval = IsRawKeyDown(rawKeyIndex)

-- always works, by hash
local retval = Citizen.InvokeNative(0xd95a7387, rawKeyIndex, Citizen.ReturnResultAnyway())

JavaScript and C#

JavaScript

const retval = IsRawKeyDown(rawKeyIndex);

// by hash
const retval = Citizen.invokeNative('0xd95a7387', rawKeyIndex, Citizen.returnResultAnyway());

bool retval = Function.Call<bool>((Hash)0xd95a7387, rawKeyIndex);

Examples

LUA · Cfx.re native reference

if IsRawKeyDown(32) then -- KEY_SPACE
    print("Spacebar is down")
end

Sources

Cfx.re native reference

Something wrong or missing? Contribute a verified note — corrections ship through pull requests.