Menu API

Access and interact with right-click context menu.

menu:is_open() -> boolean

Check if right-click menu is open.

Returns:

• boolean - True if menu visible

---

menu:bounds() -> Rectangle?

Get menu boundaries.

Returns:

• Rectangle? - Menu bounds, or nil if not open

---

menu:item_count() -> number

Get number of menu items.

Returns:

• number - Number of options

---

menu:items() -> table

Get all menu items.

Returns:

• table - Array of MenuItem objects

---

menu:slot_bounds(slot: number) -> Rectangle?

Get bounds of a menu slot.

Parameters:

Parameter	Type	Required	Description
slot	number	Yes	Slot index

Returns:

• Rectangle? - Slot bounds

---

menu:slot_center(slot: number) -> Point?

Get center point of a menu slot.

Parameters:

Parameter	Type	Required	Description
slot	number	Yes	Slot index

Returns:

• Point? - Center coordinates

---

menu:find_item_index(filter: table) -> number

Find menu item index by filters.

Parameters:

Parameter	Type	Required	Description
filter	table	Yes	Filter options

Returns:

• number - Item index (0-based), or -1 if not found

---

menu:interact(slot: number) -> boolean

Interact with menu slot by index.

Parameters:

Parameter	Type	Required	Description
slot	number	Yes	Slot index

Returns:

• boolean - True if successful

---

menu:interact_with(filter: table) -> boolean

Interact using filters.

Parameters:

Parameter	Type	Required	Description
filter	table	Yes	Filter options

Returns:

• boolean - True if successful

Example:

menu:interact_with({action = "Attack"})
menu:interact_with({action_contains = "Talk"})
menu:interact_with({target = "Banker"})

---

local function select_menu_option(action_text)
    if not menu:is_open() then
        return false
    end

    return menu:interact_with({action_contains = action_text})
end

-- Use it
select_menu_option("Attack")

---

local function list_menu_options()
    if menu:is_open() then
        logger:info("=== Menu Options ===")
        local items = menu:items()
        for _, item in ipairs(items) do
            logger:info(item:index() .. ". " .. item:action() .. " -> " .. item:target())
        end
        logger:info("====================")
    end
end

---

local function safe_interact(action_text)
    if not menu:is_open() then
        logger:warn("Menu not open")
        return false
    end

    local index = menu:find_item_index({action_contains = action_text})

    if index == -1 then
        logger:warn("Option not found: " .. action_text)
        return false
    end

    local center = menu:slot_center(index)
    if center then
        mouse:left_click(center.x, center.y)
        return true
    end

    return false
end

---

• MenuItem type (see API Types) — per-option fields and helpers
• Mouse API — Mouse input