Skip to main content

ui.list_windows

Overview

  • Lists the top-level UMG windows currently on screen, without any of their contents. This is the cheapest UI query and the intended first step: pick a window here, then call ui.get_tree --window= to see inside it. Windows are ordered top-most first (by UI layer z-order). Each entry carries 'counts' (nodes / interactive / scrollables) so you can tell how big the window's tree is before asking for it, and 'occluded' which is true when a modal above it means clicks cannot reach it. Only windows under the UI manager's root widget are reported; Cohtml-based UI and world-space widget components are not UMG and never appear. Returns an empty list when there is no world. This command never creates a widget, so it is safe to poll. Widgets that were opened this very frame have not been painted yet and show up one poll later.

Metadata

FieldValue
DisplayList UI Windows
Categoryui
AccessPublic
ScopeB1Standalone
TagsExperimental
Aliases—

Parameters

  • This command takes no parameters.

Usage

await inzoi.cli.execute('ui.list_windows');