menu
menu - Menu / config#
Declares the script's settings card (sliders, toggles, keybinds, dropdowns, pixel shapes). Values persist and appear as script globals.
menu.group#
menu.group(name)
alias: config.group
Start a settings card (group). Params without an explicit card land on the last declared one. Max 8 cards per script.
| Parameter | Type | Default | Description |
|---|---|---|---|
name | string | (required) | Card title shown in the menu. |
menu.card#
menu.card(name)
alias: config.card
Alias of menu.group.
| Parameter | Type | Default | Description |
|---|---|---|---|
name | string | (required) | Card title. |
menu.slider#
menu.slider(key, label, min, max, default, [suffix], [card])
alias: config.slider
Numeric slider. The value persists and appears as a script global named key (read it with menu.get). Max 12 sliders per card; min/max clamp to +/-1000.
| Parameter | Type | Default | Description |
|---|---|---|---|
key | string | (required) | Global name the value is exposed under. |
label | string | (required) | Label shown in the menu. |
min | number | (required) | Minimum value. |
max | number | (required) | Maximum value. |
default | number | (required) | Default value (clamped into [min, max]). |
suffix | string | '' | Unit suffix shown after the value (e.g. 'px', '%'). |
card | string | current | Card to place it on (default: current card). |
menu.toggle#
menu.toggle(key, label, [default], [card])
alias: config.toggle
On/off toggle, exposed as a 0/1 number global (menu.get_bool normalizes). Max 8 toggles per card.
| Parameter | Type | Default | Description |
|---|---|---|---|
key | string | (required) | Global name. |
label | string | (required) | Menu label. |
default | boolean | number | false |
card | string | current | Card override. |
menu.keybind#
menu.keybind(key, label, [default], [card])
alias: config.keybind
Keybind picker, exposed as a string global ('Mouse1'..'Mouse5', key name, or 'None'). Test it with util.held. Max 4 keybinds per card.
| Parameter | Type | Default | Description |
|---|---|---|---|
key | string | (required) | Global name. |
label | string | (required) | Menu label. |
default | string | 'None' | Default binding. |
card | string | current | Card override. |
menu.dropdown#
menu.dropdown(key, label, options, [default], [card])
alias: config.dropdown
Choice list, exposed as the selected string global. Options are a Lua table ({'Head','Chest'}) or a pipe string ('Head|Chest'); default may be a string or a 0-based index. Max 4 dropdowns per card.
| Parameter | Type | Default | Description |
|---|---|---|---|
key | string | (required) | Global name. |
label | string | (required) | Menu label. |
options | table | string | (required) |
default | string | number | first option |
card | string | current | Card override. |
menu.pixels#
menu.pixels(key, label, [card])
alias: config.pixels
25x25 pixel-art shape edited through the canvas modal on the script card; the global is the hex string for draw.pixels ('' = classic cross). Max 2 per card.
| Parameter | Type | Default | Description |
|---|---|---|---|
key | string | (required) | Global name. |
label | string | (required) | Menu label. |
card | string | current | Card override. |
menu.get#
menu.get(key) → number | string | boolean
injected helper (prelude)
Read a config global with a 0 default for missing values. Prefer over bare globals.
| Parameter | Type | Default | Description |
|---|---|---|---|
key | string | (required) | Config key. |
menu.get_bool#
menu.get_bool(key) → boolean
injected helper (prelude)
Read a config global as a boolean (numbers > 0.5 count as true).
| Parameter | Type | Default | Description |
|---|---|---|---|
key | string | (required) | Config key. |
menu.get_str#
menu.get_str(key, [default]) → string
injected helper (prelude)
Read a config global as a string with a fallback for missing/empty values.
| Parameter | Type | Default | Description |
|---|---|---|---|
key | string | (required) | Config key. |
default | string | '' | Fallback. |
Last updated 2026-10-03