Returns the value of a configuration variable in a format compatible with Lua conditional expressions. All configuration variables are stored as strings; many CVars represent the state of a binary flag and are stored as either "1" or "0". This function provides a convenient way to test the state of such variables without the extra syntax required to explicitly check for "1" or "0" values.


See also CVar functions.

Signature:

value = GetCVarBool("cvar")

Arguments:

  • cvar - Name of a CVar (string)

Returns:

  • value - 1 if the CVar's value should be treated as true; nil if it should be treated as false (1nil)