Skip to main content

ui.find

Overview

  • Searches the visible UMG tree and returns matching widgets with their refs, so you can act on something without pulling down a whole tree first. text matches the displayed (localized) label as a case-insensitive substring; name matches the widget's FName the same way; role must match exactly. Filters combine with AND, and results are limited to interactive widgets and text so an unfiltered search does not dump the tree. Only interactive results carry a ref and a rect. Returns an empty array when there is no world.

Metadata

FieldValue
DisplayFind UI Widget
Categoryui
AccessPublic
ScopeB1Standalone
TagsExperimental
Aliases—

Parameters

NameTypeRequiredDefaultDescription
textstringno—Substring of the displayed label (case-insensitive).
rolestringno—Exact role to match.
namestringno—Substring of the widget FName (case-insensitive).
windowstringno—Restrict the search to one window (UIType name or window instance name).
limitintno20Maximum number of matches [1-200].

Usage

await inzoi.cli.execute('ui.find', {
text: '', // optional
role: '', // optional
name: '', // optional
window: '', // optional
limit: 20, // optional
});