Skip to content

Settings

Read and override Nyx settings.

-- Read a setting by its config key. Booleans read as 0 or 1.
local box = ui.get("ESP.Box")


-- Change it while the script runs
ui.override("ESP.Box", true)


-- Give it back to the user
ui.clear_override("ESP.Box")
  • An override is never saved. Unloading the script undoes it.
  • ui.get returns nil for a key that doesn't exist. A change made in the menu reads back once the menu closes.
  • Keys under Script., Bind., Tab., Chat., Menu., HudPos. and Skin. can't be read or overridden. Trying is an error.
  • Overriding a key the current config doesn't have is an error. That includes a per-weapon key for a weapon with no settings of its own.
  • A value Nyx won't accept is refused, with a line in the script's console.

The script's tab lists what it overrides right now, under Overriding.