Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
api.bind: read keybinds the user has set on UI elements.
api.bind.list(): { BindInfo }
api.bind.getActive(): { BindInfo }
api.bind.get(id: number): BindInfo?
nil if it doesn’t exist.
api.bind.getInputLabel(input: Enum.KeyCode | Enum.UserInputType | string): string
"LShift", "E", or "LMB". Accepts a KeyCode, UserInputType, or a string like "KeyCode.E".
api.bind.isAnyBindActive(): boolean
:Connect(callback). Every callback receives a BindInfo for the affected keybind.
| Signal | When your callback runs |
|---|---|
onCreated | User added a new keybind (via right-click on a control) |
onRemoved | A keybind was deleted |
onActivated | A keybind just turned on (pressed or toggled) |
onDeactivated | A keybind just turned off |
onChanged | The user changed which keys are bound, or the mode |
{
id = 12, -- unique id
name = "elb_12", -- internal name
label = "Aim Assist", -- what the user sees in the menu
inputs = { "KeyCode.E" }, -- the bound keys
inputLabels = { "E" }, -- friendly names
mode = "onHold", -- "toggle", "onHold", or "offHold"
active = true,
targetValue = nil, -- nil = invert boolean
}
local tab = api.ui.tab("Binds", "keybinds")
local section = tab:AddSection("Active", 1)
local entries = {} -- id -> button handle
local function add(info)
if entries[info.id] then return end
entries[info.id] = section:AddButton(
string.format("%s [%s]", info.label, table.concat(info.inputLabels, "+"))
)
end
local function remove(info)
local h = entries[info.id]
if h then h:Destroy() entries[info.id] = nil end
end
for _, info in ipairs(api.bind.list()) do add(info) end
api.bind.onCreated:Connect(add)
api.bind.onRemoved:Connect(remove)
api.bind.onChanged:Connect(function(info)
local h = entries[info.id]
if h then
h:SetText(string.format("%s [%s]", info.label, table.concat(info.inputLabels, "+")))
end
end)