Lua · Variables · Settings

config

Read every program setting, and change them with permission.

Settings are named by dotted paths: section, then key, then deeper keys or 1-based array indexes. aim.rcs, esp.visibleColor.4. Every key is listed on Settings keys.

Changes apply at once but are not written to the config file; the user saves the config as usual. Each change is logged after the value stays put for 0.6 s.

Function	What it does
`config.sections()`	The section names.
`config.list(path)`	Key names inside a section or object, in alphabetical order. Empty for arrays and plain values.
`config.get(path)`	The current value. Arrays and colours come back as tables (colours are `{r, g, b, a}` from 0 to 1).
`config.set(path, value)` settings	Changes a setting.

#config.sections

config.sections()

The section names.

Returns

string[]

aim, esp, misc, perf, damage, world, deathfx, skin.

#config.list

config.list(path)

Key names inside a section or object, in alphabetical order. Empty for arrays and plain values.

Arguments

pathstring

For example esp.

Returns

string[]

Example

for _, k in ipairs(config.list("misc")) do print(k) end

#config.get

config.get(path)

The current value. Arrays and colours come back as tables (colours are {r, g, b, a} from 0 to 1).

Arguments

pathstring

Returns

any | nil

nil when the path does not exist.

Example

local fov = config.get("aim.fov")
local box_alpha = config.get("esp.visibleColor.4")

#config.set

config.set(path, value)

Changes a setting.

Changing a value needs the settings permission (Change settings). Without it the call returns the current value and logs needs permission: settings once. How permissions work

Arguments

pathstring

Must already exist.

valueany

Same type and shape as the current value. Whole-number settings stay whole (2.6 becomes 3).

Returns

boolean

true when applied (or already equal).

64 changes per frame across all scripts.
misc.menuToggleKey and misc.obsBypass are locked.
Errors are logged: unknown section, unknown setting, wrong type, locked.

Example

config.set("aim.rcs", true)
config.set("esp.visibleColor", { 1, 0.3, 0.3, 1 })