Skip to main content

Keyboard Hook API Reference

Aurora's keyboard hook system supports keyboard keys, mouse buttons (Button4-Button31), and modifiers.

Keybind Format​

"A"                    -- Simple key
"Shift+A"              -- Modifier + key
"Button4"              -- Mouse button 4
"Shift+Button5"        -- Modifier + mouse button
"MiddleButton"         -- Middle mouse button

Basic Usage​

-- Register a keybind
Aurora.KeyBindManager:RegisterKeybind("my_ability", function(isPressed)
    if isPressed then
        print("Ability activated!")
    end
end, "My Ability")

-- Set the keybind
Aurora.KeyBindManager:SetKeybind("my_ability", "Button4")

-- Check if pressed
local isPressed = Aurora.KeyBindManager:IsPressed("my_ability")

-- Get readable description
local desc = Aurora.KeyBindManager:GetKeybindDescription("Shift+Button4")
-- Returns: "Shift + Mouse 4"

Configuration Integration​

-- Save/load with config
local savedKeybind = Aurora.Config:Read("my_ability_hotkey") or "F1"
Aurora.KeyBindManager:RegisterKeybind("my_ability", callback, "Description")
Aurora.KeyBindManager:SetKeybind("my_ability", savedKeybind)