--  LUA  GetConvarInt

0x935C0AB2

-- GET_CONVAR_INT
local retval --[[ integer ]] =
	GetConvarInt(
		varName --[[ string ]], 
		default_ --[[ integer ]]
	)

Parameters:

    varName:

    The console variable to look up.
    default_:

    The default value to set if none is found (variable not set using SET_CONVAR, or not accessible).

Returns:

Returns the convar value if it can be found, otherwise it returns the assigned default.

Can be used to get a console variable casted back to int (an integer value).

Examples:

    Lua

if GetConvarInt('remainingRounds', 0) < 900 then

    Citizen.Trace("Less than 900 rounds remaining...")

end
 
 

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