Convars

import Convars from "@native/convars";

The Convars module reads console variable (cvar) values from the engine.

Methods

Convars.get(name: string): boolean | number | string | Color | Vector

Returns the convar value with its natural type.

string

required

Console variable name.

const sens = Convars.get("sensitivity");    // number
const cheats = Convars.get("sv_cheats");    // boolean

Convars.getFloat(name: string): number

Returns the convar value as a float.

string

required

Console variable name.

const sens = Convars.getFloat("sensitivity"); // 2.5
const vol = Convars.getFloat("volume");       // 0.8

Convars.getInt(name: string): number

Returns the convar value as an integer.

string

required

Console variable name.

const alpha = Convars.getInt("cl_crosshairalpha"); // 200
const team = Convars.getInt("mp_autoteambalance"); // 1

Convars.getBool(name: string): boolean

Returns the convar value as a boolean.

string

required

Console variable name.

if (Convars.getBool("sv_cheats")) {
    console.log("Cheats enabled");
}

Convars.getString(name: string): string

Returns the convar value as a string.

string

required

Console variable name.

const mapGroup = Convars.getString("game_type");
const hostname = Convars.getString("hostname");