GET_CONVAR

Can be used to get a console variable of type char, for example a string.

Hash0x6CCD2564

Runtime nameGetConvar

NamespaceCFX

SideClient + server

NameOfficial

Docs

Signature

char* GET_CONVAR(char* varName, char* default_);

Parameters

Name	Type	Description
`varName`	`char*`	The console variable to look up.
`default_`	`char*`	The default value to set if none is found.

Returns char* — Returns the convar value if it can be found, otherwise it returns the assigned `default`.

Description

Cfx.re native reference

Can be used to get a console variable of type char*, for example a string.

Usage

Lua

local retval = GetConvar(varName, default_)

-- always works, by hash
local retval = Citizen.InvokeNative(0x6ccd2564, varName, default_, Citizen.ResultAsString())

JavaScript and C#

JavaScript

const retval = GetConvar(varName, default_);

// by hash
const retval = Citizen.invokeNative('0x6ccd2564', varName, default_, Citizen.returnResultAnyway(), Citizen.resultAsString());

string retval = Function.Call<string>((Hash)0x6ccd2564, varName, default_);

Examples

LUA · Cfx.re native reference

if GetConvar('voice_useNativeAudio', 'false') == 'true' then
    Citizen.Trace('Native Audio is enabled.')
end

Sources

Cfx.re native reference

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