Skip to main content

List Text Elements (ui_element.list_text_elements)

This function is available in versions after 20260507

Declaration​

elements, err = ui_element.list_text_elements([ pid_or_options ])

Parameters​

  • pid_or_options Optional, integer or table. Integer means target app process identifier; table options are described in Common options.

Returns​

  • elements Table. UI element array. nil on failure.
  • err String. Failure reason.

Description​

Get text elements from the current target app. Coordinate fields in returned elements use physical pixels. This API is kept for old scripts and uses conservative defaults. For new targeting logic, prefer find or snapshot.

Example​

local ui_element = require("ui_element")

local list, err = ui_element.list_text_elements({
    max_level = 1,
    include_hit_state = true,
})

if list then
    for _, item in ipairs(list) do
        if item.text then
            nLog(item.text)
        end
    end
else
    sys.toast(err)
end

Note: Uses non-chapter APIs nLog and sys.toast.