
Shared properties
Every element accepts these on top of its own.string
The label.
string
Hint text under the label.
string | number
An icon shown beside the label.
Value handles
Every value element (toggle, slider, dropdown, input, keybind, color picker) follows the same shape.- Read the current value from
.value. - Write it with
Set(value). This fires the callback, so the change actually takes effect. - Pass
Set(value, true)to skip the callback when you only want to move the UI. - Keybind is the exception:
SetfiresonChanged, never the press callback. - Dropdown’s
.valueis always a table, even in single mode — see Dropdown.
Flags
Value elements save on their own under a key derived from their name. Pass an explicitflag when the name is localized, might be renamed, or could collide with another element. Set forgetState = true to skip saving entirely.
window.Flags, window:Get, and window:Set. See Saving.
Reordering
Every element handle can move within its tab.The elements
Button
Run a function on click.
Toggle
Switch a boolean on and off.
Slider
Pick a number in a range.
Dropdown
Choose one option or several.
Input
A text field.
Keybind
A rebindable key.
Color picker
Pick a colour and alpha.
Stat
A read-only number that rolls on change.