ui

Windows and widgets, built on Dear ImGui.

ui draws windows and widgets with Dear ImGui, the same toolkit as the plugins' own windows. It only works inside on_render. If you know ImGui, the names are the same in snake_case.

local enabled, range, mode = true, 600, 1

function on_render()
    ui.set_next_window_size(Vec2(320, 0), ui.Cond.FirstUseEver)
    local _, visible = ui.begin_window("My plugin")
    if visible then
        local changed
        changed, enabled = ui.checkbox("Enabled", enabled)
        changed, range = ui.slider_float("Range", range, 100, 1500, "%.0f")
        changed, mode = ui.combo("Mode", mode, { "Closest", "Weakest", "Strongest" })
        if ui.button("Reset") then range = 600 end
    end
    ui.end_window()
end

#Rules

• Widgets that hold a value take the current value and return changed, new_value. Store the new value; nothing is kept for you.
• Every begin_* and push_* needs its end_* or pop_*. begin_window and begin_child need their end always; the ones that return whether they're open (tree_node, begin_menu, begin_table, begin_tab_item, popups) only when they returned true.
• An end_* that doesn't match is a Lua error, and whatever is still open when on_render returns is closed for you, with a warning.
• A label is also the widget's id, so two widgets with the same label in one window clash. Add ## and something unique after the visible text ("Delete##3"), or wrap them in push_id/pop_id.
• Indices (combos, list boxes, table columns) start at 1.
• Flags are numbers from the tables in ui flags; combine several with |.

#Windows

#Text

#Buttons and choices

#Inputs, sliders and drags

format is a printf format such as "%.1f" or "%d ms".

#Images, bars and plots

#Layout

#Trees and headers

#Popups

#Menus

#Tabs

#Tables

if ui.begin_table("players", 2, ui.TableFlags.Borders | ui.TableFlags.RowBg) then
    ui.table_setup_column("Name")
    ui.table_setup_column("Health")
    ui.table_headers_row()
    for _, p in ipairs(agents.players()) do
        ui.table_next_row()
        ui.table_next_column(); ui.text(p:name() or "?")
        ui.table_next_column(); ui.text(string.format("%.0f%%", p:health().percent))
    end
    ui.end_table()
end

#Drag and drop

Payloads are strings, with a type name of up to 32 characters.

#Drawing in a window

ui.draw draws shapes into the current window, in screen coordinates. Start from ui.get_cursor_screen_pos().

#Items, keys and the mouse

Keys here are ui.Key values; mouse buttons are 0 (left), 1 (right) and 2 (middle).