umg kit

252 tools. Generated from the plugin source; do not edit by hand.

Guide

Full authoring of UMG: widget blueprint assets, the widget tree and its slots, typed and reflective property setters, widget animations, property/event bindings, Slate styles and fonts, Common UI, MVVM, PIE-time widget instances, editor-time PNG rendering and folder-wide batch edits.

Every tool takes widgetBlueprint (the widget blueprint: object path /Game/UI/WBP_Menu.WBP_Menu, package path /Game/UI/WBP_Menu, or a unique bare name WBP_Menu) and, where relevant, widget (a widget name inside the tree — unique per blueprint). The kit is split over several classes but every tool lives in the umg. namespace.

Prefix map

Prefix	Area
umg.create, umg.get, umg.list, umg.compile, umg.export_tree, ...	widget blueprint assets
umg.get_tree, umg.add_widget, umg.move_widget, umg.set_slot, umg.set_canvas_slot, ...	widget tree and slots
umg.set_property, umg.set_text, umg.set_image, umg.set_button, ...	widget properties
umg.anim_*	widget animations (tracks, keys, presets)
umg.list_bindings, umg.add_property_binding, umg.bind_event, umg.add_override, umg.add_dispatcher	bindings and events
umg.create_style_asset, umg.create_font, umg.create_rich_text_style_table, umg.apply_theme	styles, fonts, theming
umg.cui_*	Common UI (plugin CommonUI, 5.0+)
umg.mvvm_*	Model View ViewModel (plugin ModelViewViewModel, 5.1+ / 5.5+ for the view API)
umg.render_to_png, umg.create_instance, umg.click_button, umg.play_animation, ...	rendering and PIE runtime
umg.audit, umg.batch_*, umg.find_*, umg.export_all_trees	batch operations

Start here

1. umg.create {folder:"/Game/UI", name:"WBP_Menu", rootWidget:"CanvasPanel"}
2. umg.get_tree {widgetBlueprint:"WBP_Menu"} — always read the tree before editing it.
3. umg.add_widgets to add several widgets in one transaction.
4. umg.set_canvas_slot / umg.set_box_slot for layout, umg.set_text / umg.set_image for content.
5. umg.compile (most mutating tools compile by default; pass compile:false to batch first).

Recipe: fade a panel in

1. umg.anim_create {widgetBlueprint:"WBP_Menu", name:"Anim_Intro", length:0.5}
2. umg.anim_fade {widgetBlueprint:"WBP_Menu", animation:"Anim_Intro", widget:"Brd_Panel", from:"0", to:"1", duration:0.4} — one call: it creates the binding, the RenderOpacity track, the section and both keys.
3. umg.anim_get {widgetBlueprint:"WBP_Menu", animation:"Anim_Intro"} to check the range and the key count.
4. At runtime: umg.create_instance then umg.play_animation {id:"Menu", animation:"Anim_Intro"}.

The other presets are umg.anim_slide (RenderTransform.Translation), umg.anim_scale (RenderTransform.Scale, one number drives both axes), umg.anim_pulse (loopable A→B→A) and umg.anim_color (picks the widget's own colour property automatically).

For anything the presets do not cover, use the explicit chain: umg.anim_add_binding → umg.anim_add_track → umg.anim_add_keys. umg.anim_list_properties {widgetBlueprint, widget} lists exactly which property paths that widget accepts (including Slot.* paths when the widget has a slot). The track type is chosen from the property type:

property type	track	channels
float / int	float track	1
FVector2D	float-vector track (UMovieSceneFloatVectorTrack on 5.x, UMovieSceneVectorTrack on 4.27)	2 (x, y)
FLinearColor / FSlateColor	colour track	4 (r, g, b, a)
bool	bool track	1
ESlateVisibility	visibility track	1 (true = visible)
FMargin	margin track	4 (left, top, right, bottom)
FWidgetTransform	2D transform track	7 (translation x/y, angle, scale x/y, shear x/y)

Key values accept JSON ({"r":1,"g":0,"b":0,"a":1}) or a plain comma list in channel order ("1,0,0,1"). The comma form is the easiest to send and is what the self-test uses.

Recipe: a health bar bound to a variable

1. umg.add_variable {widgetBlueprint:"WBP_HUD", name:"Health", type:"float", defaultValue:"1.0"}
2. umg.add_property_binding {widgetBlueprint:"WBP_HUD", widget:"Bar_Health", property:"Percent", variable:"Health"} — binds the widget property straight to the blueprint variable.
3. Without variable, the same call creates a pure function Get_<Widget>_<Property> with the right return type and binds to it; fill its graph with the bp kit.
4. umg.list_bindings reports every binding and flags the broken ones.

Only properties that expose a <Property>Delegate can be bound; umg.list_widget_delegates {widgetBlueprint, widget} lists both the assignable event delegates and the bindable property delegates of a widget.

Recipe: wire a button

1. umg.bind_event {widgetBlueprint:"WBP_Menu", widget:"Btn_Play", event:"OnClicked"} — exposes the widget as a variable (compiling once if needed) and creates the bound event node.
2. umg.add_dispatcher {widgetBlueprint:"WBP_Menu", name:"OnPlayPressed"}
3. umg.call_dispatcher_on_event {widgetBlueprint:"WBP_Menu", widget:"Btn_Play", event:"OnClicked", dispatcher:"OnPlayPressed"} does steps 1 and 2's wiring in one call.
4. umg.add_override {widgetBlueprint:"WBP_Menu", function:"PreConstruct"} for construct/tick/input overrides.

Recipe: styles and theming

1. umg.list_style_classes → umg.create_style_asset {folder:"/Game/UI", name:"Style_Button", styleClass:"Button"}
2. umg.set_style_asset_property {style:"Style_Button", properties:[{key:"NormalPadding", value:"8"}]} (a single number fills all four margin sides).
3. umg.apply_style_asset {widgetBlueprint:"WBP_Menu", widget:"Btn_Play", style:"Style_Button"} copies the Slate struct into the widget's WidgetStyle.
4. umg.apply_theme {widgetBlueprint:"WBP_Menu", primary:"0.1,0.4,0.9,1", text:"1,1,1,1"} recolours buttons, progress bars, borders, images and texts in one pass; umg.set_text_style_everywhere does fonts.
5. Fonts: umg.create_font {folder, name, fromFont:"/Engine/EngineFonts/Roboto"} (or umg.import_font_face with a .ttf on disk, then umg.create_font with fontFace).

Recipe: a Common UI screen (5.0+, plugin CommonUI)

1. umg.cui_create_button_style and umg.cui_create_text_style (they create blueprints of UCommonButtonStyle / UCommonTextStyle; umg.cui_set_style_property edits their class defaults).
2. umg.cui_create_activatable_widget {folder, name:"WBP_Settings", properties:[{key:"bAutoActivate", value:"true"}]}
3. umg.cui_add_button {widgetBlueprint:"WBP_Settings", name:"Btn_Apply", style:"CBS_Main"} — UCommonButtonBase is abstract, so the tool generates a concrete WBP_<Host>_<Name> blueprint for it and reports it in generatedClass (pass widgetClass to use your own).
4. umg.cui_add_stack / umg.cui_add_switcher / umg.cui_add_tab_list for navigation containers.
5. umg.cui_create_input_action_table + umg.cui_add_input_action for the action data table.
6. umg.cui_validate flags buttons without a style and activatable screens without a back handler.

Recipe: MVVM health binding (5.1+ / 5.5+, plugin ModelViewViewModel)

1. umg.mvvm_create_viewmodel {folder, name:"VM_Player", properties:[{name:"Health", type:"float", fieldNotify:true}]}
2. umg.mvvm_add_viewmodel {widgetBlueprint:"WBP_HUD", viewModelClass:"VM_Player", name:"PlayerVM", creationType:"createInstance"}
3. umg.mvvm_add_binding {widgetBlueprint:"WBP_HUD", viewModel:"PlayerVM", viewModelProperty:"Health", widget:"Bar_Health", widgetProperty:"Percent", mode:"oneWayToDestination"}
4. umg.mvvm_list_bindings / umg.mvvm_validate to check the result.

The view-model asset tools (mvvm_create_viewmodel, mvvm_add_viewmodel_property, mvvm_get_viewmodel, mvvm_list_available_viewmodels, mvvm_list_conversion_functions) work from 5.1. The view tools (contexts and bindings) need 5.5, where UMVVMEditorSubsystem stabilised.

Recipe: test a widget in PIE

1. Start PIE (edit.play in the edit kit), then umg.create_instance {widgetBlueprint:"WBP_Menu", name:"Menu", addToViewport:true} — name becomes the id every other runtime tool takes.
2. umg.get_instance_tree {id:"Menu"} to see the live widget names.
3. umg.click_button {id:"Menu", widget:"Btn_Play"}, umg.set_text_input, umg.set_check, umg.set_slider_value, umg.select_option, umg.set_switcher.
4. umg.get_widget_geometry {id:"Menu", widget:"Btn_Play"} for the absolute screen rect (only after one frame has been rendered).
5. umg.set_input_mode {mode:"uiOnly", id:"Menu"} before sending umg.simulate_key.
6. umg.remove_instance / umg.remove_all_widgets when done.

Outside PIE, umg.render_to_png {widgetBlueprint, file:"Saved/Shots/menu.png", width:800, height:600} renders the widget with FWidgetRenderer into a PNG (project-relative path) and umg.get_desired_size returns the laid-out size.

Gotchas

• Compile after tree edits. Most mutating tools compile by default and return compileErrors[]. When chaining many edits, pass compile:false and finish with umg.compile.
• The widget must be a variable for umg.bind_event to work; the tool sets bIsVariable and compiles once so the generated class has the property. That extra compile is expected.
• Animations live inside the widget blueprint, not as separate assets. umg.anim_create names both the object and the designer label; umg.anim_list shows both.
• New animations default to 20 fps on 4.27 (hardcoded by the UMG editor) and to UMGEditorProjectSettings::DefaultWidgetAnimationFrameRate on 5.x (also 20 by default). Pass displayRate to be explicit.
• Colours, margins and vectors accept {r,g,b,a} / {left,top,right,bottom} / {x,y} objects, the engine's own text form, or a comma list. A single number fills all four margin sides.
• Slot properties belong to the parent panel: animate them as Slot.Offsets, Slot.Padding, ... and pass slot:true to umg.anim_add_binding (the track tools do it for you).
• Plugin gating. umg.cui_* needs CommonUI enabled and 5.0+; umg.mvvm_* needs ModelViewViewModel. Tools of a missing plugin are hidden from tools/list and refused by tools/call with the plugin name, they never fail silently.
• 4.27 differences: no Common UI, no MVVM, no UStackBox/UDynamicEntryBox, no Field Notify. umg.set_field_notify and umg.list_field_notify carry MinEngine 5.1.
• Config writers (umg.set_ui_settings, umg.cui_set_input_settings) write DefaultEngine.ini and are Risk 4: they need _confirm unless MaxAutoRisk allows them.
• umg.batch_* tools honour dryRun — always do a dry run first on a real project; they walk every widget blueprint under a folder.
• umg.anim_import takes the JSON produced by umg.anim_export; there is no self-test for it because a JSON document cannot be embedded in the tool metadata.
• The PIE self-test has no sandbox (edit.self_test skips {sandbox} arguments while PIE runs), so the widget-tree-dependent runtime tools (umg.click_button, umg.set_text_input, umg.set_check, umg.set_slider_value, umg.select_option, umg.set_switcher, umg.get_widget_geometry, umg.set_instance_property, umg.get_instance_property, umg.play_animation, umg.is_animation_playing) are SmokeSkip. Drive them by hand: create a widget blueprint, start PIE, umg.create_instance, then call them. umg.create_instance also accepts a plain UserWidget class name, which is what the self-test uses.

Tools

Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above MaxAutoRisk need "_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours the dryRun argument. smoke = covered by edit.self_test.

umg.add_dispatcher (risk 2, mutates, smoke)

Adds an event dispatcher (multicast delegate) to the widget blueprint, for menu -> game communication.

Argument	Type	Description
widgetBlueprint	string	required.
name	string	required.
params	array of UeaUmgDispatcherParam
compile	boolean	Default true.

Returns: widgetBlueprint, variables, message.

umg.add_override (risk 2, mutates, smoke)

Adds a UserWidget override event node (PreConstruct, Construct, Tick, Destruct, OnKeyDown...).

Argument	Type	Description
widgetBlueprint	string	required.
function	string	required. PreConstruct, Construct, Tick, Destruct, OnMouseButtonDown, OnKeyDown, OnDrop, OnDragDetected...
graph	string	Event graph name. Empty = the main EventGraph.
x	integer	Default 0.
y	integer	Default 0.
compile	boolean	Default true.

Returns: widgetBlueprint, node, existing, boundEvents, compileErrors, message.

umg.add_property_binding (risk 2, mutates, smoke)

Binds a widget property to a blueprint variable, or to a pure function created with the right return type.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
property	string	required. Bindable property: Text, Percent, Visibility, ColorAndOpacity, IsEnabled, ToolTipText, Brush...
variable	string	Blueprint variable to read the value from. Takes precedence over functionName.
functionName	string	Name of the pure function to create or reuse. Default "Get__".
compile	boolean	Compile the blueprint afterwards. Default true. Default true.

Returns: widgetBlueprint, bindings, compileErrors, message.

umg.add_rich_image (risk 2, mutates, smoke)

Adds or replaces an image row in a rich image table.

Argument	Type	Description
table	string	required. Data table asset.
row	string	required. Row name (the style name used in text</> markup).
properties	array of UeaKeyValue	Field paths of the row struct and their JSON values ("TextStyle.Font.Size" -> "18").

Returns: table, rowStruct, rows, warnings, message.

umg.add_rich_text_style (risk 2, mutates, smoke)

Adds or replaces a style row in a rich text style table.

Argument	Type	Description
table	string	required. Data table asset.
row	string	required. Row name (the style name used in text</> markup).
properties	array of UeaKeyValue	Field paths of the row struct and their JSON values ("TextStyle.Font.Size" -> "18").

Returns: table, rowStruct, rows, warnings, message.

umg.add_typeface (risk 2, mutates)

Adds a typeface entry (name + font face) to a runtime font. SmokeSkip: needs an imported font face.

Argument	Type	Description
font	string	required.
name	string	required.
fontFace	string	required. Font face asset for this typeface entry.

Returns: font, typefaces, message.

umg.add_user_widget (risk 2, mutates, smoke)

Instances another widget blueprint inside the tree (a user widget child).

Argument	Type	Description
widgetBlueprint	string	required.
userWidget	string	required. Widget blueprint to instance inside the tree (path or unique name).
name	string	Name of the new widget.
parent	string	Parent widget name; empty = the root widget.
index	integer	Insertion index, -1 appends. Default -1.
compile	boolean	Compile after the change (default true). Default true.

Returns: widget.

umg.add_variable (risk 2, mutates, smoke)

Adds a variable to a widget blueprint (optionally Field Notify for MVVM).

Argument	Type	Description
widgetBlueprint	string	required.
name	string	required.
type	string	required. bool, int, float, string, name, text, vector, rotator, transform, linearcolor, a struct/class name, "Actor*", "Texture2D*"...
defaultValue	string	Default value as text (ImportText form).
category	string
instanceEditable	boolean	Default false.
exposeOnSpawn	boolean	Default false.
fieldNotify	boolean	Mark as Field Notify (MVVM), 5.1+. Default false.
compile	boolean	Default true.

Returns: widgetBlueprint, variables, message.

umg.add_widget (risk 2, mutates, smoke)

Adds a widget of Class under Parent (empty parent = the root widget) with optional initial slot settings and properties. Returns the created widget.

Argument	Type	Description
widgetBlueprint	string	required.
class	string	required. Widget class: short name ("TextBlock"), C++ name ("UTextBlock") or another widget blueprint path.
name	string	Name of the new widget (a unique suffix is added when taken; default: the class name).
parent	string	Parent widget name; empty = the root widget (or the new widget becomes the root when the tree is empty).
index	integer	Insertion index inside the parent, -1 (default) appends. Default -1.
isVariable	boolean	Expose the widget as a Blueprint variable (default true, like the designer). Default true.
slot	array of UeaKeyValue	Initial slot settings ("Padding" -> "8", "LayoutData.Anchors" -> "center", ...).
properties	array of UeaKeyValue	Initial widget properties ("Text" -> "Play", "ColorAndOpacity" -> "{'r':1,'g':0,'b':0}").
compile	boolean	Compile the blueprint after the change (default true). Default true.

Returns: widget.

umg.add_widgets (risk 2, mutates, smoke)

Adds several widgets in one transaction; an entry may parent to a widget created earlier in the same list. Compiles once at the end.

Argument	Type	Description
widgetBlueprint	string	required.
widgets	array of UeaUmgWidgetSpec	required. Widgets to create, in order; each may parent to one created earlier in the list.
compile	boolean	Compile once at the end (default true). Default true.

Returns: widgets, count.

umg.anim_add_binding (risk 2, mutates, smoke)

Binds a widget (or its slot) to the animation, creating the possessable the tracks hang from.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required.
widget	string	required.
slot	boolean	Bind the widget's slot (for Slot.* properties) instead of the widget itself. Default false.

Returns: widgetBlueprint, animation, bindings, tracks, compileErrors, message.

umg.anim_add_key (risk 2, mutates, smoke)

Adds or replaces a key at Time, creating the binding, track and section on demand.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required.
widget	string	required.
property	string	required.
time	number	required. Time in seconds.
value	string	required. Value as JSON: a number, {x,y}, {r,g,b,a}, {left,top,right,bottom}, true/false or a visibility name.
interp	string	"cubic" (default), "linear" or "constant". Default TEXT("cubic").

Returns: animation, widget, property, kind, keys, message.

umg.anim_add_keys (risk 2, mutates, smoke)

Adds several keys to one track in a single call.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required.
widget	string	required.
property	string	required.
keys	array of UeaUmgAnimKeyEntry	required.

Returns: animation, widget, property, kind, keys, message.

umg.anim_add_track (risk 2, mutates, smoke)

Adds a property track (track type chosen from the property type) and its section.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required.
widget	string	required.
property	string	required. Property path: "RenderOpacity", "ColorAndOpacity", "Visibility", "RenderTransform", "Slot.Offsets"...

Returns: animation, tracks, message.

umg.anim_clear_keys (risk 3, mutates, destructive, smoke)

Removes every key of a track, keeping the track and its section.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required.
widget	string	required.
property	string	required. Property path: "RenderOpacity", "ColorAndOpacity", "Visibility", "RenderTransform", "Slot.Offsets"...

Returns: animation, widget, property, kind, keys, message.

umg.anim_color (risk 2, mutates, smoke)

Colour animation between two {r,g,b,a} values on the widget's colour property.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required. Widget to animate.
animation	string	required. Animation to create or extend.
from	string	Start value: opacity (fade/pulse), scale (scale) or {x,y} (slide).
to	string	End value.
duration	number	Duration in seconds. Default 0.3. Default 0.3.
startTime	number	Start time in seconds. Default 0. Default 0.0.
interp	string	"cubic" (default), "linear" or "constant". Default TEXT("cubic").

Returns: widgetBlueprint, animation, bindings, tracks, compileErrors, message.

umg.anim_create (risk 2, mutates, smoke)

Creates a widget animation (movie scene + playback range) on the blueprint. Length is in seconds.

Argument	Type	Description
widgetBlueprint	string	required.
name	string	required.
length	number	Length in seconds. Default 5. Default 5.0.
displayRate	number	Editor display rate in fps. 0 = the engine default (20 on 4.27, project setting on 5.x). Default 0.0.

Returns: widgetBlueprint, animation, bindings, tracks, compileErrors, message.

umg.anim_duplicate (risk 2, mutates, smoke)

Duplicates an animation with all its bindings, tracks and keys.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required.
newName	string	Name of the copy. Empty appends "_Copy".

Returns: widgetBlueprint, animation, bindings, tracks, compileErrors, message.

umg.anim_export (risk 0, smoke)

Exports an animation (bindings, tracks and keys) as JSON.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required. Animation object name or display label. Empty picks the only animation of the blueprint.

Returns: animation, json.

umg.anim_fade (risk 2, mutates, smoke)

Opacity animation from From to To over Duration seconds (RenderOpacity track).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required. Widget to animate.
animation	string	required. Animation to create or extend.
from	string	Start value: opacity (fade/pulse), scale (scale) or {x,y} (slide).
to	string	End value.
duration	number	Duration in seconds. Default 0.3. Default 0.3.
startTime	number	Start time in seconds. Default 0. Default 0.0.
interp	string	"cubic" (default), "linear" or "constant". Default TEXT("cubic").

Returns: widgetBlueprint, animation, bindings, tracks, compileErrors, message.

umg.anim_get (risk 0, smoke)

Full description of one animation: range, display rate, bindings and every track with its key count.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required. Animation object name or display label. Empty picks the only animation of the blueprint.

Returns: widgetBlueprint, animation, bindings, tracks, compileErrors, message.

umg.anim_get_keys (risk 0, smoke)

Keys of a track: time, channel, value and interpolation.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required.
widget	string	required.
property	string	required. Property path: "RenderOpacity", "ColorAndOpacity", "Visibility", "RenderTransform", "Slot.Offsets"...

Returns: animation, widget, property, kind, keys, message.

umg.anim_import (risk 2, mutates)

Recreates an animation from umg.anim_export JSON (creating it when missing). SmokeSkip: a JSON document cannot be embedded in UHT metadata; use umg.anim_export output.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required. Animation name to create or overwrite.
json	string	required. JSON from umg.anim_export.
replace	boolean	Remove the existing tracks of the animation first. Default true. Default true.

Returns: widgetBlueprint, animation, bindings, tracks, compileErrors, message.

umg.anim_list (risk 0, smoke)

Animations of a widget blueprint with their range, display rate, binding and track counts.

Argument	Type	Description
widgetBlueprint	string	required. Widget blueprint: object path, package path or unique asset name.

Returns: widgetBlueprint, animations.

umg.anim_list_properties (risk 0, smoke)

Property paths of a widget (and its slot) that can be animated.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.

Returns: widget, class, properties.

umg.anim_list_tracks (risk 0, smoke)

Tracks of an animation with their widget, property, kind, channel and key counts.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required. Animation object name or display label. Empty picks the only animation of the blueprint.

Returns: animation, tracks, message.

umg.anim_pulse (risk 2, mutates, smoke)

Opacity pulse (From -> To -> From) meant to be played looping.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required. Widget to animate.
animation	string	required. Animation to create or extend.
from	string	Start value: opacity (fade/pulse), scale (scale) or {x,y} (slide).
to	string	End value.
duration	number	Duration in seconds. Default 0.3. Default 0.3.
startTime	number	Start time in seconds. Default 0. Default 0.0.
interp	string	"cubic" (default), "linear" or "constant". Default TEXT("cubic").

Returns: widgetBlueprint, animation, bindings, tracks, compileErrors, message.

umg.anim_remove (risk 3, mutates, destructive, smoke)

Removes an animation from the widget blueprint.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required. Animation object name or display label. Empty picks the only animation of the blueprint.

Returns: widgetBlueprint, animations.

umg.anim_remove_binding (risk 3, mutates, destructive, smoke)

Removes a widget binding and every track attached to it.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required.
widget	string	required.
slot	boolean	Bind the widget's slot (for Slot.* properties) instead of the widget itself. Default false.

Returns: widgetBlueprint, animation, bindings, tracks, compileErrors, message.

umg.anim_remove_key (risk 2, mutates, smoke)

Removes the key at Time (on one channel or on all of them).

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required.
widget	string	required.
property	string	required.
time	number	required. Time in seconds of the key to remove (matched with a small tolerance).
channel	integer	Channel to clear. -1 (default) removes the key on every channel. Default -1.

Returns: animation, widget, property, kind, keys, message.

umg.anim_remove_track (risk 3, mutates, destructive, smoke)

Removes a property track from an animation.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required.
widget	string	required.
property	string	required. Property path: "RenderOpacity", "ColorAndOpacity", "Visibility", "RenderTransform", "Slot.Offsets"...

Returns: animation, tracks, message.

umg.anim_rename (risk 2, mutates, smoke)

Renames an animation (object name and designer display label).

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required.
newName	string	required.

Returns: widgetBlueprint, animation, bindings, tracks, compileErrors, message.

umg.anim_scale (risk 2, mutates, smoke)

Uniform scale animation between two factors (RenderTransform.Scale track).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required. Widget to animate.
animation	string	required. Animation to create or extend.
from	string	Start value: opacity (fade/pulse), scale (scale) or {x,y} (slide).
to	string	End value.
duration	number	Duration in seconds. Default 0.3. Default 0.3.
startTime	number	Start time in seconds. Default 0. Default 0.0.
interp	string	"cubic" (default), "linear" or "constant". Default TEXT("cubic").

Returns: widgetBlueprint, animation, bindings, tracks, compileErrors, message.

umg.anim_set_display_rate (risk 2, mutates, smoke)

Sets the editor display rate (fps) of an animation.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required.
displayRate	number	required. Frames per second shown in the Sequencer timeline.

Returns: widgetBlueprint, animation, bindings, tracks, compileErrors, message.

umg.anim_set_key (risk 2, mutates, smoke)

Replaces the value (and interpolation) of the key at Time. Fails when there is no key there.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required.
widget	string	required.
property	string	required.
time	number	required. Time in seconds.
value	string	required. Value as JSON: a number, {x,y}, {r,g,b,a}, {left,top,right,bottom}, true/false or a visibility name.
interp	string	"cubic" (default), "linear" or "constant". Default TEXT("cubic").

Returns: animation, widget, property, kind, keys, message.

umg.anim_set_range (risk 2, mutates, smoke)

Sets the playback range of an animation in seconds.

Argument	Type	Description
widgetBlueprint	string	required.
animation	string	required.
start	number	Start in seconds. Default 0.0.
end	number	required. End in seconds.

Returns: widgetBlueprint, animation, bindings, tracks, compileErrors, message.

umg.anim_slide (risk 2, mutates, smoke)

Translation animation between two {x,y} offsets (RenderTransform.Translation track).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required. Widget to animate.
animation	string	required. Animation to create or extend.
from	string	Start value: opacity (fade/pulse), scale (scale) or {x,y} (slide).
to	string	End value.
duration	number	Duration in seconds. Default 0.3. Default 0.3.
startTime	number	Start time in seconds. Default 0. Default 0.0.
interp	string	"cubic" (default), "linear" or "constant". Default TEXT("cubic").

Returns: widgetBlueprint, animation, bindings, tracks, compileErrors, message.

umg.apply_style_asset (risk 2, mutates, smoke)

Copies a style asset's struct into a widget's style property (WidgetStyle by default).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
style	string	required.
property	string	Style property of the widget. Empty = WidgetStyle.
compile	boolean	Default true.

Returns: widgetBlueprint, applied, warnings, compileErrors, message.

umg.apply_theme (risk 2, mutates, smoke)

Applies a colour theme (buttons, progress bars, borders, texts) to a whole widget blueprint.

Argument	Type	Description
widgetBlueprint	string	required.
primary	string	Main colour for buttons and progress bars ({r,g,b,a} or "r,g,b,a").
secondary	string	Secondary colour for borders and backgrounds.
text	string	Text colour.
font	string	Font asset applied to every text block.
fontSize	integer	Font size applied to every text block. 0 keeps it. Default 0.
compile	boolean	Default true.

Returns: widgetBlueprint, applied, warnings, compileErrors, message.

umg.audit (risk 0, smoke)

Audits every widget blueprint of a folder: widget count, depth, animations, bindings, compile status, missing references.

Argument	Type	Description
folder	string	Content folder to walk (recursive). Empty = /Game.
nameContains	string	Only widget blueprints whose name contains this text.
limit	integer	Default 200.

Returns: folder, blueprints, count, totalWidgets, totalIssues, message.

umg.batch_compile (risk 2, mutates, smoke)

Compiles every widget blueprint of a folder and reports the errors per asset.

Argument	Type	Description
folder	string	Content folder to walk (recursive). Empty = /Game.
nameContains	string	Only widget blueprints whose name contains this text.
limit	integer	Default 200.

Returns: folder, results, blueprintsTouched, totalChanges, warnings, dryRun, message.

umg.batch_rename_widgets (risk 2, mutates, dryRun, smoke)

Renames widgets whose name contains a pattern, across every widget blueprint of a folder.

Argument	Type	Description
folder	string
pattern	string	required. Substring to look for in widget names.
replace	string	required. Replacement text.
dryRun	boolean	Default false.
compile	boolean	Default true.

Returns: folder, results, blueprintsTouched, totalChanges, warnings, dryRun, message.

umg.batch_replace_class (risk 3, mutates, dryRun, smoke)

Replaces every widget of one class with another class, keeping names, slots and shared properties.

Argument	Type	Description
folder	string
fromClass	string	required. Widget class to replace ("TextBlock").
toClass	string	required. Replacement widget class ("RichTextBlock").
copyProperties	boolean	Copy the properties both classes share. Default true. Default true.
dryRun	boolean	Default false.
compile	boolean	Default true.

Returns: folder, results, blueprintsTouched, totalChanges, warnings, dryRun, message.

umg.batch_replace_texture (risk 2, mutates, dryRun, smoke)

Replaces every reference to an asset (texture, material, font) with another one across a folder.

Argument	Type	Description
folder	string
from	string	required. Asset currently referenced (texture, material, font...).
to	string	required. Replacement asset.
dryRun	boolean	Default false.
compile	boolean	Default true.

Returns: folder, results, blueprintsTouched, totalChanges, warnings, dryRun, message.

umg.batch_set_font (risk 2, mutates, dryRun, smoke)

Applies one font (asset, size and typeface) to every matching text widget of a folder.

Argument	Type	Description
folder	string
nameContains	string
font	string	Font asset applied to every matching text widget. Empty keeps the font object.
size	integer	Font size. 0 keeps it. Default 0.
typeface	string	Typeface name. Empty keeps it.
classFilter	string	Widget class filter. Default TextBlock. Default TEXT("TextBlock").
dryRun	boolean	Default false.
compile	boolean	Default true.

Returns: folder, results, blueprintsTouched, totalChanges, warnings, dryRun, message.

umg.batch_set_properties (risk 2, mutates, smoke)

Writes properties on several widgets of the same blueprint in one transaction.

Argument	Type	Description
widgetBlueprint	string	required.
items	array of UeaUmgBatchItem	required. One entry per widget.
compile	boolean	Compile once at the end (default false). Default false.

Returns: widgets, count.

umg.batch_set_property (risk 2, mutates, dryRun, smoke)

Writes one property on every widget of a class across a folder.

Argument	Type	Description
folder	string
classFilter	string	required. Widget class the property is written on.
property	string	required.
value	string	required. JSON value (see the umg conventions).
dryRun	boolean	Default false.
compile	boolean	Default true.

Returns: folder, results, blueprintsTouched, totalChanges, warnings, dryRun, message.

umg.bind_event (risk 2, mutates, smoke)

Creates the bound event node for a widget delegate in the event graph (exposes the widget as a variable).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
event	string	required. Delegate name: OnClicked, OnHovered, OnValueChanged, OnTextCommitted, OnCheckStateChanged...
compile	boolean	Default true.

Returns: widgetBlueprint, node, existing, boundEvents, compileErrors, message.

umg.call_dispatcher_on_event (risk 2, mutates, smoke)

Binds a widget delegate and wires a Call node to it in one call.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
event	string	required. Widget delegate to bind (OnClicked...).
dispatcher	string	required. Event dispatcher of the widget blueprint to call.
compile	boolean	Default true.

Returns: widgetBlueprint, node, existing, boundEvents, compileErrors, message.

umg.clear_tree (risk 5, mutates, destructive, smoke)

Deletes every widget of the tree, optionally creating a fresh root panel.

Argument	Type	Description
widgetBlueprint	string	required.
rootWidget	string	Class of a fresh root panel to create after clearing (empty = leave the tree empty).
compile	boolean	Compile after the change (default true). Default true.

Returns: widgetBlueprint, compileErrors, applied, warnings.

umg.click_button (risk 0, requires PIE)

Clicks a button of a live instance (broadcasts OnClicked, like a real press+release). SmokeSkip: needs a widget tree fixture in the PIE session.

Argument	Type	Description
id	string	required.
widget	string	required. Sub-widget inside the instance.

Returns: id, widget, class, value, message.

umg.compile (risk 2, mutates, smoke)

Compiles the widget blueprint and returns errors, warnings and the resulting status.

Argument	Type	Description
widgetBlueprint	string	required.
save	boolean	Save the asset after a successful compile (default false). Default false.

Returns: compileWarnings, status.

umg.copy_properties (risk 2, mutates, smoke)

Copies properties from one widget to others (empty list = every editable property they share).

Argument	Type	Description
widgetBlueprint	string	required.
from	string	required. Source widget.
to	array of string	required. Destination widgets.
properties	array of string	Property names to copy; empty copies every editable property the classes share.

Returns: widgets, count.

umg.create (risk 2, mutates, smoke)

Creates a widget blueprint under Folder with a root panel (CanvasPanel by default, "none" for an empty tree) and optional starter widgets. Returns the asset, root widget and compile errors.

Argument	Type	Description
folder	string	required. Destination content folder ("/Game/UI").
name	string	required. Asset name without path or extension ("WBP_Menu").
parentClass	string	Parent class, must derive from UserWidget (default "UserWidget").
rootWidget	string	Root panel class: "CanvasPanel" (default), "VerticalBox", "Overlay", ... or "none" for an empty tree.
designWidth	integer	Designer preview width in pixels (0 = engine default). Default 0.
designHeight	integer	Designer preview height in pixels (0 = engine default). Default 0.
widgets	array of string	Widget classes to create under the root right away, each with its default name (use umg.add_widgets for named widgets).

Returns: name, parentClass, rootWidget, rootWidgetClass, widgetCount, createdWidgets.

umg.create_font (risk 2, mutates, smoke)

Creates a runtime UFont, copying an existing font's composite font or using a font face asset.

Argument	Type	Description
folder	string	required.
name	string	required.
fromFont	string	Existing UFont to copy the composite font from, e.g. "/Engine/EngineFonts/Roboto".
fontFace	string	Font face asset to use as the default typeface (alternative to fromFont).
typeface	string	Name of the default typeface entry. Default "Default". Default TEXT("Default").
size	integer	Legacy font size stored on the asset. Default 24. Default 24.

Returns: font, typefaces, message.

umg.create_from_template (risk 2, mutates, smoke)

Creates a widget blueprint pre-filled with a starter layout (hud, mainMenu, pauseMenu, dialog, inventoryGrid, healthBar, loadingScreen, settingsList). Returns the widget names it created.

Argument	Type	Description
folder	string	required. Destination content folder.
name	string	required. Asset name.
template	string	required. One of: hud, mainMenu, pauseMenu, dialog, inventoryGrid, healthBar, loadingScreen, settingsList.
parentClass	string	Parent class (default "UserWidget").

Returns: widgets, template.

umg.create_instance (risk 0, requires PIE)

Creates a user widget in the PIE world and (by default) adds it to the viewport. SmokeSkip: needs a widget blueprint asset; UUserWidget itself is UCLASS(Abstract) on both engines and the self-test sandbox is deleted before the PIE run.

Argument	Type	Description
widgetBlueprint	string	required. Widget blueprint to instance, or a concrete UserWidget class name.
name	string	Label the other runtime tools use to find the instance. Default: the blueprint name.
playerIndex	integer	Default 0.
addToViewport	boolean	Add it to the player viewport. Default true. Default true.
zOrder	integer	Default 0.

Returns: instance, message.

umg.create_rich_image_table (risk 2, mutates, smoke)

Creates a data table of FRichImageRow for a Rich Text Block image decorator.

Argument	Type	Description
folder	string	required.
name	string	required.

Returns: table, rowStruct, rows, warnings, message.

umg.create_rich_text_style_table (risk 2, mutates, smoke)

Creates a data table of FRichTextStyleRow for a Rich Text Block's style set.

Argument	Type	Description
folder	string	required.
name	string	required.

Returns: table, rowStruct, rows, warnings, message.

umg.create_style_asset (risk 2, mutates, smoke)

Creates a Slate widget style asset (USlateWidgetStyleAsset + its style container).

Argument	Type	Description
folder	string	required. Destination content folder, e.g. "/Game/UI/Styles".
name	string	required.
styleClass	string	required. Button, TextBlock, CheckBox, ComboBox, ComboButton, EditableText, EditableTextBox, Progress, ScrollBar, ScrollBox, SpinBox (umg.list_style_classes lists them all).
properties	array of UeaKeyValue	Initial values of the contained style struct ("Normal.TintColor" -> "{r:1,g:0,b:0,a:1}").

Returns: style, properties, warnings, message.

umg.cui_add_button (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Adds a Common UI button to a widget tree (generating a CommonButtonBase blueprint when no class is given).

Argument	Type	Description
widgetBlueprint	string	required.
name	string	required.
parent	string	Parent widget in the tree. Empty = the root panel.
widgetClass	string	Concrete widget class to instance. Empty = the tool's default (a generated blueprint for abstract bases).
style	string	Common UI style blueprint applied to the new widget.
text	string	Text of the button label / text block.
properties	array of UeaKeyValue	Extra property values written on the new widget.
compile	boolean	Default true.

Returns: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.

umg.cui_add_input_action (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Adds or replaces a row in a Common UI input action table.

Argument	Type	Description
table	string	required.
row	string	required.
properties	array of UeaKeyValue	Row fields ("DisplayName", "KeyboardInputTypeInfo.Key", "bActionRequiresHold"...).

Returns: table, rowStruct, rows, warnings, message.

umg.cui_add_stack (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Adds a CommonActivatableWidgetStack (push/pop screen container) to a widget tree.

Argument	Type	Description
widgetBlueprint	string	required.
name	string	required.
parent	string	Parent widget in the tree. Empty = the root panel.
widgetClass	string	Concrete widget class to instance. Empty = the tool's default (a generated blueprint for abstract bases).
style	string	Common UI style blueprint applied to the new widget.
text	string	Text of the button label / text block.
properties	array of UeaKeyValue	Extra property values written on the new widget.
compile	boolean	Default true.

Returns: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.

umg.cui_add_switcher (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Adds a CommonActivatableWidgetSwitcher to a widget tree.

Argument	Type	Description
widgetBlueprint	string	required.
name	string	required.
parent	string	Parent widget in the tree. Empty = the root panel.
widgetClass	string	Concrete widget class to instance. Empty = the tool's default (a generated blueprint for abstract bases).
style	string	Common UI style blueprint applied to the new widget.
text	string	Text of the button label / text block.
properties	array of UeaKeyValue	Extra property values written on the new widget.
compile	boolean	Default true.

Returns: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.

umg.cui_add_tab_list (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Adds a Common UI tab list (generating a CommonTabListWidgetBase blueprint when no class is given).

Argument	Type	Description
widgetBlueprint	string	required.
name	string	required.
parent	string	Parent widget in the tree. Empty = the root panel.
widgetClass	string	Concrete widget class to instance. Empty = the tool's default (a generated blueprint for abstract bases).
style	string	Common UI style blueprint applied to the new widget.
text	string	Text of the button label / text block.
properties	array of UeaKeyValue	Extra property values written on the new widget.
compile	boolean	Default true.

Returns: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.

umg.cui_add_text (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Adds a CommonTextBlock to a widget tree, optionally with a Common UI text style.

Argument	Type	Description
widgetBlueprint	string	required.
name	string	required.
parent	string	Parent widget in the tree. Empty = the root panel.
widgetClass	string	Concrete widget class to instance. Empty = the tool's default (a generated blueprint for abstract bases).
style	string	Common UI style blueprint applied to the new widget.
text	string	Text of the button label / text block.
properties	array of UeaKeyValue	Extra property values written on the new widget.
compile	boolean	Default true.

Returns: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.

umg.cui_create_activatable_widget (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Creates a widget blueprint deriving from CommonActivatableWidget (menus, screens, layers).

Argument	Type	Description
folder	string	required.
name	string	required.
parentClass	string	Parent class. Empty = CommonActivatableWidget.
rootWidget	string	Root panel class of the new widget tree. Empty = CanvasPanel.
properties	array of UeaKeyValue	Class defaults to write (bAutoActivate, bIsBackHandler, bSupportsActivationFocus...).

Returns: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.

umg.cui_create_border_style (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Creates a CommonBorderStyle blueprint (background brush and tint).

Argument	Type	Description
folder	string	required.
name	string	required.
properties	array of UeaKeyValue	Initial values of the style class defaults ("NormalBase.TintColor", "MinWidth"...).
parentClass	string	Parent class override (a CommonButtonStyle/CommonTextStyle/CommonBorderStyle subclass).

Returns: style, path, parentClass, properties, warnings, compileErrors, message.

umg.cui_create_button_style (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Creates a CommonButtonStyle blueprint (brushes per state, paddings, min size, text styles).

Argument	Type	Description
folder	string	required.
name	string	required.
properties	array of UeaKeyValue	Initial values of the style class defaults ("NormalBase.TintColor", "MinWidth"...).
parentClass	string	Parent class override (a CommonButtonStyle/CommonTextStyle/CommonBorderStyle subclass).

Returns: style, path, parentClass, properties, warnings, compileErrors, message.

umg.cui_create_input_action_table (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Creates a data table of Common UI input action rows.

Argument	Type	Description
folder	string	required.
name	string	required.

Returns: table, rowStruct, rows, warnings, message.

umg.cui_create_text_style (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Creates a CommonTextStyle blueprint (font, colour, shadow).

Argument	Type	Description
folder	string	required.
name	string	required.
properties	array of UeaKeyValue	Initial values of the style class defaults ("NormalBase.TintColor", "MinWidth"...).
parentClass	string	Parent class override (a CommonButtonStyle/CommonTextStyle/CommonBorderStyle subclass).

Returns: style, path, parentClass, properties, warnings, compileErrors, message.

umg.cui_get_input_settings (risk 0, UE 5.0+, requires plugin CommonUI, smoke)

Common UI input settings of the project (input data class, platform settings).

Argument	Type	Description
nameContains	string
placeableOnly	boolean	Only classes that can be placed in a widget tree (skips abstract ones). Default false.
limit	integer	Default 200.

Returns: settingsClass, values, message.

umg.cui_get_style (risk 0, UE 5.0+, requires plugin CommonUI, smoke)

Class defaults of a Common UI style blueprint.

Argument	Type	Description
style	string	required. Style blueprint created by umg.cui_create_*_style.

Returns: style, path, parentClass, properties, warnings, compileErrors, message.

umg.cui_list_input_actions (risk 0, UE 5.0+, requires plugin CommonUI, smoke)

Rows of a Common UI input action table.

Argument	Type	Description
table	string	required.

Returns: table, rowStruct, rows, warnings, message.

umg.cui_list_widget_classes (risk 0, UE 5.0+, requires plugin CommonUI, smoke)

Common UI widget and style classes available in the project.

Argument	Type	Description
nameContains	string
placeableOnly	boolean	Only classes that can be placed in a widget tree (skips abstract ones). Default false.
limit	integer	Default 200.

Returns: classes, count, message.

umg.cui_set_activatable (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Writes the activatable settings of a CommonActivatableWidget blueprint (class defaults).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name; empty targets the widget blueprint's class defaults.
style	string	Common UI style blueprint to apply (buttons and text blocks).
properties	array of UeaKeyValue
compile	boolean	Default true.

Returns: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.

umg.cui_set_button (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Writes Common UI button settings (style, selectable, toggleable, min size, input action...).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name; empty targets the widget blueprint's class defaults.
style	string	Common UI style blueprint to apply (buttons and text blocks).
properties	array of UeaKeyValue
compile	boolean	Default true.

Returns: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.

umg.cui_set_input_settings (risk 4, mutates, UE 5.0+, requires plugin CommonUI)

Writes the Common UI input settings. SmokeSkip: writes project config.

Argument	Type	Description
properties	array of UeaKeyValue	required. Properties of the Common UI input settings to write.
saveConfig	boolean	Default true.

Returns: settingsClass, values, message.

umg.cui_set_style_property (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Writes class defaults on a Common UI style blueprint.

Argument	Type	Description
style	string	required.
properties	array of UeaKeyValue	required.
compile	boolean	Default true.

Returns: style, path, parentClass, properties, warnings, compileErrors, message.

umg.cui_set_text_block_style (risk 2, mutates, UE 5.0+, requires plugin CommonUI, smoke)

Applies a Common UI text style to a CommonTextBlock.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name; empty targets the widget blueprint's class defaults.
style	string	Common UI style blueprint to apply (buttons and text blocks).
properties	array of UeaKeyValue
compile	boolean	Default true.

Returns: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.

umg.cui_validate (risk 0, UE 5.0+, requires plugin CommonUI, smoke)

Checks a widget blueprint for common Common UI mistakes (buttons without style, activatable without back handler...).

Argument	Type	Description
widgetBlueprint	string	required.

Returns: widgetBlueprint, issues, commonWidgets, message.

umg.delete (risk 3, mutates, destructive, smoke)

Deletes the widget blueprint asset. Fails when other assets still reference it.

Argument	Type	Description
widgetBlueprint	string	required. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name.

Returns: widgetBlueprint, compileErrors, applied, warnings.

umg.duplicate (risk 2, mutates, smoke)

Duplicates the widget blueprint (tree, animations and graphs included) into Folder under NewName.

Argument	Type	Description
widgetBlueprint	string	required.
newName	string	required. Name of the copy.
folder	string	Destination folder (default: the source folder).

Returns: name, parentClass, rootWidget, rootWidgetClass, widgetCount, createdWidgets.

umg.duplicate_widget (risk 2, mutates, smoke)

Copies a widget and its subtree under the same (or another) parent.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required. Widget to copy (its subtree is copied too).
newName	string	Name of the copy.
parent	string	Parent of the copy; empty = the same parent as the source.
compile	boolean	Compile after the change (default true). Default true.

Returns: widget.

umg.export_all_trees (risk 0, smoke)

Exports the widget tree of every widget blueprint of a folder as one JSON file each.

Argument	Type	Description
folder	string
outFolder	string	Output folder relative to the project directory. Default "Saved/UeaSmoke". Default TEXT("Saved/UmgTrees").
limit	integer	Default 200.

Returns: outFolder, files, count, message.

umg.export_tree (risk 0, smoke)

Exports the whole widget tree (classes, slots, properties, children) as JSON text; feed it back to umg.import_tree.

Argument	Type	Description
widgetBlueprint	string	required.
withProperties	boolean	Include every editable property of each widget (default false: only the non-default ones the kit tracks). Default false.

Returns: json, widgetCount.

umg.find_by_widget_class (risk 0, smoke)

Widgets of a given class across every widget blueprint of a folder.

Argument	Type	Description
folder	string
class	string	required. Widget class to look for ("Button", "CommonButtonBase").
includeSubclasses	boolean	Include subclasses of the class. Default true. Default true.
limit	integer	Default 200.

Returns: hits, count, blueprintsScanned, message.

umg.find_instance_widget (risk 0, requires PIE)

Finds widgets of a live instance by name and/or class. SmokeSkip: needs a live instance (see umg.create_instance).

Argument	Type	Description
id	string	required.
name	string	Widget name (exact or substring).
class	string	Widget class filter ("Button", "TextBlock").

Returns: id, widgets, count.

umg.find_widgets (risk 0, smoke)

Finds widgets whose name or designer label matches a wildcard pattern ("Btn_*").

Argument	Type	Description
widgetBlueprint	string	required.
pattern	string	required. Wildcard pattern matched against the widget name and label ("Btn_*", "Health").

Returns: widgets, count.

umg.find_widgets_using (risk 0, smoke)

Widget blueprints (and widgets) referencing an asset: texture, material, font, style or widget class.

Argument	Type	Description
asset	string	required. Asset to look for (texture, material, font, widget blueprint...).
folder	string
limit	integer	Default 200.

Returns: hits, count, blueprintsScanned, message.

umg.get (risk 0, smoke)

Root widget, widget count, tree depth, animations, bindings, named slots, exposed variables, design size and compile status of a widget blueprint.

Argument	Type	Description
widgetBlueprint	string	required. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name.

Returns: name, parentClass, rootWidget, rootWidgetClass, widgetCount, depth, animations, bindings, namedSlots, variables, designSize, status.

umg.get_class_defaults (risk 0, smoke)

Lists the class default object properties of the generated widget class as JSON values.

Argument	Type	Description
widgetBlueprint	string	required.
nameContains	string	Case-insensitive substring filter on the property name (read tools only).
properties	array of UeaKeyValue	Property assignments on the class default object ("PropertyName" -> JSON or text value).
limit	integer	Maximum number of properties listed (default 100). Default 0.

Returns: properties, count.

umg.get_compile_errors (risk 0, smoke)

Returns the errors and warnings of the last compile without recompiling.

Argument	Type	Description
widgetBlueprint	string	required. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name.

Returns: compileWarnings, status.

umg.get_desired_size (risk 0, smoke)

Desired size of a widget blueprint (or one of its widgets) after a layout prepass.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget inside the tree. Empty = the root widget.

Returns: widget, width, height, message.

umg.get_font (risk 0, smoke)

Font asset details: cache type, legacy size and typeface entries.

Argument	Type	Description
font	string	required.

Returns: font, typefaces, message.

umg.get_instance_property (risk 0, requires PIE)

Reads a property of a live instance or one of its widgets. SmokeSkip: needs a widget tree fixture (the self-test sandbox is deleted before the PIE run).

Argument	Type	Description
id	string	required.
widget	string
property	string	required.

Returns: id, widget, property, value, message.

umg.get_instance_tree (risk 0, requires PIE)

Widget tree of a live instance (name, class, parent, depth, visibility). SmokeSkip: needs a live instance (see umg.create_instance).

Argument	Type	Description
id	string	required. Instance label from umg.create_instance (or a live widget's object/class name).

Returns: id, widgets, count.

umg.get_named_slot_content (risk 0, smoke)

Widget currently filling a NamedSlot.

Argument	Type	Description
widgetBlueprint	string	required.
slot	string	required. Named slot widget of the tree.
widgetClass	string	Widget class to create inside the slot (exclusive with widget).
widget	string	Existing widget to move into the slot (exclusive with widgetClass).
compile	boolean	Compile after the change (default true). Default true.

Returns: slot, content, contentClass.

umg.get_parent (risk 0, smoke)

Parent widget of a widget, with its class and the child index.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
withProperties	boolean	Include the non-default property values. Default false.

Returns: widget.

umg.get_properties (risk 0, smoke)

Lists the editable properties of a widget with type, category and current value as JSON.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
category	string	Details-panel category filter ("Appearance", "Content", ...).
nameContains	string	Case-insensitive substring of the property name.
includeInherited	boolean	Include properties declared by the base classes (default true). Default true.
limit	integer	Maximum number of properties returned (default 100). Default 0.

Returns: widget, class, properties, count.

umg.get_property (risk 0, smoke)

Reads one property of a widget as JSON text (paths like "Brush.ImageSize" work).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
property	string	required. Property name or path ("Text", "Brush.ImageSize", "Slot.Padding").

Returns: widget, class, properties, count.

umg.get_slot (risk 0, smoke)

Current slot class and values of a widget, plus the field names the slot class accepts.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
fields	array of UeaKeyValue	Slot field assignments ("Padding" -> "8", "HorizontalAlignment" -> "Fill", "LayoutData.Anchors" -> "center").

Returns: widget, slotClass, fields, validFields.

umg.get_style_asset (risk 0, smoke)

Reads a style asset: container class, Slate struct and every field as JSON.

Argument	Type	Description
style	string	required. Slate widget style asset (path or unique name).

Returns: style, properties, warnings, message.

umg.get_text (risk 0, smoke)

Reads the text of a widget with its localization namespace and key when it has one.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required. Widget name.

Returns: widget, class, text, namespace, key, property.

umg.get_tree (risk 0, smoke)

The whole widget hierarchy in order: name, class, parent, slot class, children, variable flag.

Argument	Type	Description
widgetBlueprint	string	required.
depth	integer	Maximum depth reported (0 = no limit). Default 0.
withProperties	boolean	Include the non-default property values of each widget. Default false.

Returns: widgets, count, root, depth.

umg.get_tree_depth (risk 0, smoke)

Deepest nesting level of the tree and the path down to it.

Argument	Type	Description
widgetBlueprint	string	required. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name.

Returns: depth, widgetCount, deepestPath.

umg.get_ui_settings (risk 0, smoke)

Project User Interface settings: application scale, DPI curve, scale rule, focus rule, default cursors.

Argument	Type	Description
folder	string	Content folder. Empty = /Game.
nameContains	string
limit	integer	Default 200.

Returns: applicationScale, uiScaleRule, customScalingRuleClass, renderFocusRule, defaultCursor, dpiCurve, values, message.

umg.get_widget (risk 0, smoke)

Class, parent, slot, children, variable flag, visibility and (optionally) the non-default properties of one widget.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
withProperties	boolean	Include the non-default property values. Default false.

Returns: widget.

umg.get_widget_class_info (risk 0, smoke)

Editable properties (type, category, default), BlueprintAssignable delegates, named slots and slot class of a widget class.

Argument	Type	Description
class	string	required. Widget class short name ("Button"), C++ name ("UButton") or widget blueprint path.
includeInherited	boolean	Include properties inherited from UWidget/UVisual (default false). Default false.

Returns: class, parentClass, category, description, isPanel, isContent, slotClass, properties, delegates, namedSlots.

umg.get_widget_description (risk 0, smoke)

Class, label, tooltip, slot summary and children of one widget, as a readable paragraph.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name inside the tree (empty = the root widget).

Returns: widget, description, toolTip, slotSummary.

umg.get_widget_geometry (risk 0, requires PIE)

Absolute screen position and size of a widget of a live instance. SmokeSkip: needs a widget tree fixture rendered for at least one frame.

Argument	Type	Description
id	string	required.
widget	string	required. Sub-widget inside the instance.

Returns: widget, x, y, width, height, scale, message.

umg.import_font_face (risk 2, mutates)

Imports a .ttf/.otf file as a UFontFace asset. SmokeSkip: needs a font file on disk.

Argument	Type	Description
folder	string	required.
name	string	required.
file	string	required. Absolute path to a .ttf/.otf file on disk.
hinting	string	Default, AutoHinting, DefaultHinting, Monochrome or None. Default TEXT("Default").

Returns: name, path, sourceFile, bytes, message.

umg.import_tree (risk 3, mutates, smoke)

Rebuilds the widget tree from JSON produced by umg.export_tree (a widget blueprint path instead of JSON copies that asset's tree). With replace=true the existing tree is discarded.

Argument	Type	Description
widgetBlueprint	string	required.
json	string	required. Tree JSON as produced by umg.export_tree, or the path of another widget blueprint whose tree is copied.
replace	boolean	Replace the existing tree (default true). When false the imported root is added under the current root. Default true.
compile	boolean	Compile after the import (default true). Default true.

Returns: json, widgetCount.

umg.insert_widget (risk 2, mutates, smoke)

Creates a widget positioned before/after a target widget, or inside it when position="into".

Argument	Type	Description
widgetBlueprint	string	required.
class	string	required. Widget class to create.
target	string	required. Existing widget the new one is positioned against.
position	string	"before" (default), "after" or "into" (as a child of the target panel).
name	string	Name of the new widget.
compile	boolean	Compile after the change (default true). Default true.

Returns: widget.

umg.is_animation_playing (risk 0, requires PIE)

Whether an animation is currently playing on a live instance, and its current time. SmokeSkip: needs a widget blueprint with an animation live in the PIE session.

Argument	Type	Description
id	string	required.
animation	string	Animation name. Empty stops every animation (umg.stop_animation).

Returns: id, animation, playing, currentTime, message.

umg.list (risk 0, smoke)

Finds widget blueprint assets by folder, parent class and name substring.

Argument	Type	Description
folder	string	Content folder to search (default "/Game").
parentClass	string	Only blueprints deriving from this class.
nameContains	string	Case-insensitive substring of the asset name.
limit	integer	Maximum number of results (default 50). Default 0.

Returns: assets, count.

umg.list_bind_widget_requirements (risk 0, smoke)

Widgets (and animations) the C++ parent class requires through BindWidget / BindWidgetOptional / BindWidgetAnim.

Argument	Type	Description
widgetBlueprint	string	required.

Returns: widgetBlueprint, parentClass, requirements, created, compileErrors, message.

umg.list_bindings (risk 0, smoke)

Property bindings of a widget blueprint (widget, property, function or variable, broken flag).

Argument	Type	Description
widgetBlueprint	string	required.

Returns: widgetBlueprint, bindings, compileErrors, message.

umg.list_bound_events (risk 0, smoke)

Bound widget-delegate event nodes present in the blueprint's graphs.

Argument	Type	Description
widgetBlueprint	string	required.

Returns: widgetBlueprint, node, existing, boundEvents, compileErrors, message.

umg.list_children (risk 0, smoke)

Direct children of a widget (empty widget = the root widget).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
withProperties	boolean	Include the non-default property values. Default false.

Returns: widgets, count.

umg.list_engine_fonts (risk 0, smoke)

Font assets shipped with the engine (/Engine/EngineFonts).

Argument	Type	Description
folder	string	Content folder. Empty = /Game.
nameContains	string
limit	integer	Default 200.

Returns: fonts, count.

umg.list_field_notify (risk 0, UE 5.1+, smoke)

Variables of the widget blueprint marked as Field Notify.

Argument	Type	Description
widgetBlueprint	string	required.

Returns: widgetBlueprint, variables, message.

umg.list_fonts (risk 0, smoke)

Font assets under a content folder.

Argument	Type	Description
folder	string	Content folder. Empty = /Game.
nameContains	string
limit	integer	Default 200.

Returns: fonts, count.

umg.list_instances (risk 0, requires PIE, smoke)

Live user widgets of the PIE world with their class, viewport state and widget count.

Argument	Type	Description
playerIndex	integer	Local player index of the PIE session. Default 0. Default 0.

Returns: instances, count, message.

umg.list_named_slots (risk 0, smoke)

Lists the named slots of the tree with the widget currently filling each one.

Argument	Type	Description
widgetBlueprint	string	required. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name.

Returns: slots, count.

umg.list_property_types (risk 0, smoke)

The JSON shapes accepted for Slate structs (colors, margins, anchors, fonts, brushes, child size).

Argument	Type	Description
nameContains	string	Optional type name filter ("brush", "color", "font").

Returns: types, count.

umg.list_style_assets (risk 0, smoke)

Slate widget style assets under a content folder.

Argument	Type	Description
folder	string	Content folder. Empty = /Game.
nameContains	string
limit	integer	Default 200.

Returns: styles, count.

umg.list_style_classes (risk 0, smoke)

Style container classes accepted by umg.create_style_asset, with the Slate struct each one carries.

Argument	Type	Description
folder	string	Content folder. Empty = /Game.
nameContains	string
limit	integer	Default 200.

Returns: classes.

umg.list_variables (risk 0, smoke)

Variables of a widget blueprint, including the widgets exposed as variables.

Argument	Type	Description
widgetBlueprint	string	required.

Returns: widgetBlueprint, variables, message.

umg.list_widget_classes (risk 0, smoke)

Lists the widget classes usable with umg.add_widget, with palette category, description and whether they accept children.

Argument	Type	Description
nameContains	string	Case-insensitive substring of the class name.
category	string	Palette category filter ("Common", "Panel", "Input", ...).
includeUserWidgets	boolean	Include widget blueprint classes found in the content browser (default false). Default false.
limit	integer	Maximum number of results (default 200). Default 0.

Returns: classes, count.

umg.list_widget_delegates (risk 0, smoke)

Assignable delegates of a widget (event names accepted by umg.bind_event) with their parameters.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name. Empty lists the delegates of every widget of the tree.

Returns: widget, class, delegates.

umg.list_widgets (risk 0, smoke)

Flat list of the widgets of a blueprint, optionally filtered by class and name substring.

Argument	Type	Description
widgetBlueprint	string	required.
classFilter	string	Only widgets of this class (or a subclass of it).
nameContains	string	Case-insensitive substring of the widget name.

Returns: widgets, count.

umg.move_widget (risk 2, mutates, smoke)

Moves a widget to another parent, keeping the compatible slot values.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required. Widget to move.
newParent	string	New parent panel; empty = the root widget.
index	integer	Insertion index in the new parent, -1 appends. Default -1.
keepSlot	boolean	Copy the compatible slot values to the new slot (default true). Default true.
compile	boolean	Compile after the change (default true). Default true.

Returns: widget.

umg.mvvm_add_binding (risk 2, mutates, UE 5.5+, requires plugin ModelViewViewModel, smoke)

Binds a view model property to a widget property.

Argument	Type	Description
widgetBlueprint	string	required.
viewModel	string	required. View model name inside the view (umg.mvvm_list_viewmodels).
viewModelProperty	string	required. Property of the view model to read.
widget	string	required. Widget of the tree to write to.
widgetProperty	string	required. Widget property to write ("Text", "Percent", "ToolTipText"...).
mode	string	oneWayToDestination (default), oneWayToSource, twoWay, oneTimeToDestination. Default TEXT("oneWayToDestination").
executionMode	string	Immediate, Delayed, Tick or DelayedWhenSharedElseImmediate. Empty keeps the default.
enabled	boolean	Default true.
compile	boolean	Default true.

Returns: widgetBlueprint, bindings, compileErrors, message.

umg.mvvm_add_event (risk 2, mutates, UE 5.5+, requires plugin ModelViewViewModel)

Binds a widget event to a view model function (MVVM events). SmokeSkip: needs a view model function with a matching signature.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required. Widget whose delegate fires the event.
event	string	required. Delegate name ("OnClicked").
viewModel	string	required. View model name inside the view.
function	string	required. View model function to call.
compile	boolean	Default true.

Returns: widgetBlueprint, bindings, compileErrors, message.

umg.mvvm_add_viewmodel (risk 2, mutates, UE 5.5+, requires plugin ModelViewViewModel, smoke)

Adds a view model context to a widget blueprint (creation type, global identifier, property path).

Argument	Type	Description
widgetBlueprint	string	required.
viewModelClass	string	required. View model class or blueprint.
name	string	Name of the view model inside the view. Empty = the class name without prefix.
creationType	string	manual, createInstance, globalCollection, propertyPath or resolver. Default TEXT("createInstance").
globalIdentifier	string	Identifier used by the global view model collection.
propertyPath	string	Property path used by the propertyPath creation type.
createSetter	boolean	Generate a public setter for the view model. Default false.
compile	boolean	Default true.

Returns: widgetBlueprint, viewModels, bindings, compileErrors, message.

umg.mvvm_add_viewmodel_property (risk 2, mutates, UE 5.1+, requires plugin ModelViewViewModel, smoke)

Adds a Field Notify property to a view model blueprint.

Argument	Type	Description
viewModel	string	required.
name	string	required.
type	string	required.
fieldNotify	boolean	Default true.
defaultValue	string
compile	boolean	Default true.

Returns: viewModel, path, parentClass, properties, compileErrors, message.

umg.mvvm_create_viewmodel (risk 2, mutates, UE 5.1+, requires plugin ModelViewViewModel, smoke)

Creates a view model blueprint (MVVMViewModelBase) with Field Notify properties.

Argument	Type	Description
folder	string	required.
name	string	required.
parentClass	string	Parent class. Empty = MVVMViewModelBase.
properties	array of UeaUmgMvvmPropertySpec

Returns: viewModel, path, parentClass, properties, compileErrors, message.

umg.mvvm_get_view (risk 0, UE 5.5+, requires plugin ModelViewViewModel, smoke)

Summary of a widget blueprint's MVVM view (contexts + binding count).

Argument	Type	Description
widgetBlueprint	string	required.

Returns: widgetBlueprint, viewModels, bindings, compileErrors, message.

umg.mvvm_get_viewmodel (risk 0, UE 5.1+, requires plugin ModelViewViewModel, smoke)

Properties of a view model blueprint with their Field Notify flag.

Argument	Type	Description
viewModel	string	required. View model blueprint (path or unique name).

Returns: viewModel, path, parentClass, properties, compileErrors, message.

umg.mvvm_list_available_viewmodels (risk 0, UE 5.1+, requires plugin ModelViewViewModel, smoke)

View model classes available in the project (Field Notify sources usable by MVVM).

Argument	Type	Description
sourceType	string	Source type name filter ("float", "int", "Text"...).
destinationType	string	Destination type name filter.
nameContains	string
limit	integer	Default 100.

Returns: viewModels, count, message.

umg.mvvm_list_bindings (risk 0, UE 5.5+, requires plugin ModelViewViewModel, smoke)

View bindings of a widget blueprint (source path, destination path, mode, enabled).

Argument	Type	Description
widgetBlueprint	string	required.

Returns: widgetBlueprint, bindings, compileErrors, message.

umg.mvvm_list_conversion_functions (risk 0, UE 5.1+, requires plugin ModelViewViewModel, smoke)

Blueprint functions usable as MVVM conversion functions, filtered by argument and return type.

Argument	Type	Description
sourceType	string	Source type name filter ("float", "int", "Text"...).
destinationType	string	Destination type name filter.
nameContains	string
limit	integer	Default 100.

Returns: functions, count.

umg.mvvm_list_viewmodels (risk 0, UE 5.5+, requires plugin ModelViewViewModel, smoke)

View model contexts declared on a widget blueprint's MVVM view.

Argument	Type	Description
widgetBlueprint	string	required.

Returns: widgetBlueprint, viewModels, bindings, compileErrors, message.

umg.mvvm_remove_binding (risk 3, mutates, destructive, UE 5.5+, requires plugin ModelViewViewModel, smoke)

Removes a view binding by index, or by widget + property.

Argument	Type	Description
widgetBlueprint	string	required.
index	integer	Binding index from umg.mvvm_list_bindings. -1 uses widget + widgetProperty. Default -1.
widget	string
widgetProperty	string
compile	boolean	Default true.

Returns: widgetBlueprint, bindings, compileErrors, message.

umg.mvvm_remove_viewmodel (risk 3, mutates, destructive, UE 5.5+, requires plugin ModelViewViewModel, smoke)

Removes a view model context from a widget blueprint.

Argument	Type	Description
widgetBlueprint	string	required.
name	string	required. View model name inside the view.
compile	boolean	Default true.

Returns: widgetBlueprint, viewModels, bindings, compileErrors, message.

umg.mvvm_rename_viewmodel (risk 2, mutates, UE 5.5+, requires plugin ModelViewViewModel, smoke)

Renames a view model context of a widget blueprint.

Argument	Type	Description
widgetBlueprint	string	required.
name	string	required.
newName	string	required.
compile	boolean	Default true.

Returns: widgetBlueprint, viewModels, bindings, compileErrors, message.

umg.mvvm_set_binding (risk 2, mutates, UE 5.5+, requires plugin ModelViewViewModel, smoke)

Changes the mode, enabled and compile flags of an existing view binding.

Argument	Type	Description
widgetBlueprint	string	required.
index	integer	required.
mode	string	oneWayToDestination, oneWayToSource, twoWay, oneTimeToDestination. Empty keeps it.
enabled	boolean	Default true.
compileBinding	boolean	Default true.
compile	boolean	Default true.

Returns: widgetBlueprint, bindings, compileErrors, message.

umg.mvvm_validate (risk 0, UE 5.5+, requires plugin ModelViewViewModel, smoke)

Checks the MVVM setup of a widget blueprint (unused view models, disabled or broken bindings).

Argument	Type	Description
widgetBlueprint	string	required.

Returns: widgetBlueprint, issues, viewModels, bindings, message.

umg.play_animation (risk 0, requires PIE)

Plays an animation on a live instance. SmokeSkip: needs a widget blueprint with an animation live in the PIE session.

Argument	Type	Description
id	string	required.
animation	string	required.
startTime	number	Start time in seconds. Default 0.0.
loops	integer	0 loops forever. Default 1. Default 1.
mode	string	forward, reverse, pingpong, pingpongreverse. Default TEXT("forward").
speed	number	Default 1.0.
restoreState	boolean	Restore the animated properties when the animation finishes. Default false.

Returns: id, animation, playing, currentTime, message.

umg.remove_all_widgets (risk 2, requires PIE, smoke)

Removes every user widget from the PIE viewport.

Argument	Type	Description
playerIndex	integer	Local player index of the PIE session. Default 0. Default 0.

Returns: instances, count, message.

umg.remove_binding (risk 2, mutates, smoke)

Removes a property binding (and optionally the generated function).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
property	string	required.
deleteFunction	boolean	Also delete the generated binding function. Default false. Default false.
compile	boolean	Default true.

Returns: widgetBlueprint, bindings, compileErrors, message.

umg.remove_instance (risk 1, requires PIE)

Removes a live instance from the viewport and forgets its label. SmokeSkip: needs a live instance (see umg.create_instance).

Argument	Type	Description
id	string	required. Instance label from umg.create_instance (or a live widget's object/class name).

Returns: instances, count, message.

umg.remove_override (risk 3, mutates, destructive, smoke)

Removes an override event node from the blueprint.

Argument	Type	Description
widgetBlueprint	string	required.
function	string	required.
compile	boolean	Default true.

Returns: widgetBlueprint, node, existing, boundEvents, compileErrors, message.

umg.remove_widget (risk 3, mutates, destructive, smoke)

Removes a widget (and its subtree unless keepChildren is set).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required. Widget to remove.
keepChildren	boolean	Re-parent the children to the removed widget's parent instead of deleting them (default false). Default false.
compile	boolean	Compile after the change (default true). Default true.

Returns: widgetBlueprint, compileErrors, applied, warnings.

umg.remove_widgets (risk 3, mutates, destructive, smoke)

Removes several widgets in one transaction.

Argument	Type	Description
widgetBlueprint	string	required.
widgets	array of string	required. Widgets to remove.
keepChildren	boolean	Re-parent the children instead of deleting them. Default false.
compile	boolean	Compile after the change (default true). Default true.

Returns: widgetBlueprint, compileErrors, applied, warnings.

umg.rename (risk 2, mutates, smoke)

Renames the widget blueprint asset (references are fixed up).

Argument	Type	Description
widgetBlueprint	string	required.
newName	string	required. New asset name (no path).

Returns: name, parentClass, rootWidget, rootWidgetClass, widgetCount, createdWidgets.

umg.rename_widget (risk 2, mutates, smoke)

Renames a widget; the Blueprint variable of the generated class follows.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required. Widget to rename.
newName	string	required. New name (must be unique in the tree).
compile	boolean	Compile after the change (default true). Default true.

Returns: widget.

umg.render_to_png (risk 0, smoke)

Renders a widget blueprint to a PNG file (project-relative path) with FWidgetRenderer.

Argument	Type	Description
widgetBlueprint	string	required. Widget blueprint to render.
file	string	required. Output file, relative to the project directory (e.g. "Saved/UeaSmoke/wbp.png").
width	integer	Default 512.
height	integer	Default 512.
scale	number	Render scale. Default 1. Default 1.0.
deltaTime	number	Delta time given to the widget before the capture (lets one construct/tick pass run). Default 0.0.

Returns: file, absolutePath, width, height, bytes, message.

umg.render_widget_class (risk 0, smoke)

Same as umg.render_to_png for any UserWidget class (C++ class or widget blueprint).

Argument	Type	Description
class	string	required. UserWidget class: a widget blueprint path or a C++ class name.
file	string	required.
width	integer	Default 512.
height	integer	Default 512.
scale	number	Default 1.0.
deltaTime	number	Default 0.0.

Returns: file, absolutePath, width, height, bytes, message.

umg.reorder_widget (risk 2, mutates, smoke)

Changes the position of a widget inside its parent (absolute index or relative shift).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required. Widget to reorder inside its parent.
index	string	Absolute index; leave empty to use shift.
shift	string	Relative move ("-1" up, "2" down).
compile	boolean	Compile after the change (default true). Default true.

Returns: widget.

umg.replace_widget (risk 3, mutates, smoke)

Replaces a widget by a new one of another class, keeping its name, slot and (for panels) its children.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required. Widget to replace.
newClass	string	required. Class of the replacement (a widget blueprint path also works).
keepChildren	boolean	Move the children of the old widget into the new one when both are panels (default true). Default true.
keepName	boolean	Keep the old widget's name for the replacement (default true). Default true.
compile	boolean	Compile after the change (default true). Default true.

Returns: widget.

umg.replace_with_child (risk 3, mutates, smoke)

Replaces a widget by its first child, deleting the widget (ReplaceWidgetWithChild semantics).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
compile	boolean	Compile after the change (default true). Default true.

Returns: widget.

umg.replace_with_named_slot (risk 3, mutates, smoke)

Replaces a widget by a NamedSlot of the same name, so a child blueprint can fill it.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required. Widget to replace with a NamedSlot.
name	string	Name of the created NamedSlot (default: the widget name with a "Slot_" prefix).
compile	boolean	Compile after the change (default true). Default true.

Returns: widget.

umg.reset_property (risk 2, mutates, smoke)

Resets a property to the value of the widget class default object.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
property	string	required. Property name or path ("Text", "Brush.ImageSize", "Slot.Padding").

Returns: widget, class, values.

umg.satisfy_bind_widgets (risk 2, mutates, smoke)

Creates the widgets a BindWidget parent class requires but the tree does not have yet.

Argument	Type	Description
widgetBlueprint	string	required.
parent	string	Parent panel the created widgets are added to. Empty = the root panel.
compile	boolean	Default true.

Returns: widgetBlueprint, parentClass, requirements, created, compileErrors, message.

umg.save (risk 2, mutates, smoke)

Saves the widget blueprint package to disk.

Argument	Type	Description
widgetBlueprint	string	required. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name.

Returns: saved.

umg.screenshot_viewport (risk 1, requires PIE)

Requests a viewport screenshot (with or without UI). SmokeSkip: needs a rendered game frame to land on disk.

Argument	Type	Description
file	string	required. Output file relative to the project directory.
showUi	boolean	Include the UI in the capture. Default true. Default true.

Returns: file, absolutePath, width, height, bytes, message.

umg.select_option (risk 0, requires PIE)

Selects an option of a combo box of a live instance, by text or index. SmokeSkip: needs a widget tree fixture in the PIE session.

Argument	Type	Description
id	string	required.
widget	string	required.
option	string	Option text. Use index when empty.
index	integer	Default -1.

Returns: id, widget, class, value, message.

umg.set_alignment (risk 2, mutates, smoke)

Sets the horizontal/vertical alignment of any slot class that has them.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
hAlign	string	Fill, Left, Center, Right.
vAlign	string	Fill, Top, Center, Bottom.

Returns: widget, slotClass, fields, validFields.

umg.set_background_blur (risk 2, mutates, smoke)

BackgroundBlur: strength, radius, alpha handling, fallback brush, padding and alignments.

Argument	Type	Description
strength	string	Blur strength.
radius	string	Blur radius in pixels (needs overrideAutoRadius).
overrideAutoRadius	string	"true"/"false": use radius instead of the computed one (5.x).
applyAlphaToBlur	string	"true"/"false".
lowQualityFallback	string	Brush used when blur is unsupported.
padding	string	Content padding {left,top,right,bottom}.
hAlign	string
vAlign	string

Returns: widget, class, values.

umg.set_border (risk 2, mutates, smoke)

Border: background brush and color, padding, content color and alignments.

Argument	Type	Description
brush	string	Background brush.
brushColor	string	Background tint {r,g,b,a}.
padding	string	Content padding {left,top,right,bottom}.
contentColor	string	Content tint {r,g,b,a}.
hAlign	string	Fill, Left, Center, Right.
vAlign	string	Fill, Top, Center, Bottom.
showEffectWhenDisabled	string	"true"/"false" (5.x).
desiredSizeScale	string	Desired size scale {x,y}.

Returns: widget, class, values.

umg.set_box_slot (risk 2, mutates, smoke)

Horizontal/vertical box (and stack box) slot: padding, size rule and weight, alignments.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
padding	string	Padding "{'left':4,'top':4,'right':4,'bottom':4}" or a single number.
sizeRule	string	"auto" or "fill".
sizeValue	string	Fill weight used with sizeRule=fill.
hAlign	string	Fill, Left, Center, Right.
vAlign	string	Fill, Top, Center, Bottom.

Returns: widget, slotClass, fields, validFields.

umg.set_brush (risk 2, mutates, smoke)

Writes any FSlateBrush property of a widget ("Brush", "Background", "WidgetStyle.Normal", ...).

Argument	Type	Description
property	string	required. Brush property to write ("Brush", "Background", "WidgetStyle.Normal", ...).
brush	string	required. Brush as {texture

Returns: widget, class, values.

umg.set_button (risk 2, mutates, smoke)

Button: colors, click/touch/press methods and focusability.

Argument	Type	Description
backgroundColor	string	Background tint {r,g,b,a}.
colorAndOpacity	string	Content tint {r,g,b,a}.
clickMethod	string	DownAndUp, MouseDown, PreciseClick.
touchMethod	string	Down, DownAndUp, PreciseTap.
pressMethod	string	DownAndUp, ButtonPress.
isFocusable	string	"true"/"false": the button can take keyboard focus.

Returns: widget, class, values.

umg.set_button_style (risk 2, mutates, smoke)

Button style: the four state brushes, paddings and (5.x) state foreground colors.

Argument	Type	Description
normal	string	Normal state brush.
hovered	string	Hovered state brush.
pressed	string	Pressed state brush.
disabled	string	Disabled state brush.
normalPadding	string	Padding in the normal state {left,top,right,bottom}.
pressedPadding	string	Padding in the pressed state.
normalForeground	string	Normal foreground color {r,g,b,a} (5.x).
hoveredForeground	string	Hovered foreground color (5.x).
pressedForeground	string	Pressed foreground color (5.x).

Returns: widget, class, values.

umg.set_canvas_slot (risk 2, mutates, smoke)

Canvas panel slot: position, size, anchors (preset or explicit), offsets, alignment, auto size, z-order.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
position	string	Position relative to the anchors, "{'x':40,'y':40}".
size	string	Size in pixels, "{'x':200,'y':50}".
anchors	string	Anchor preset (topLeft, top, topRight, left, center, right, bottomLeft, bottom, bottomRight, fill, fillTop, fillBottom, fillLeft, fillRight) or "{'minX':0,'minY':0,'maxX':1,'maxY':1}".
offsets	string	Raw offsets "{'left':0,'top':0,'right':0,'bottom':0}" (overrides position/size when both are given).
alignment	string	Alignment/pivot inside the slot, "{'x':0.5,'y':0.5}".
autoSize	string	"true" sizes the slot to the widget's desired size.
zOrder	string	Draw order inside the canvas.

Returns: widget, slotClass, fields, validFields.

umg.set_check (risk 0, requires PIE)

Checks or unchecks a check box of a live instance (broadcasts OnCheckStateChanged). SmokeSkip: needs a widget tree fixture in the PIE session.

Argument	Type	Description
id	string	required.
widget	string	required.
checked	boolean	Default true.

Returns: id, widget, class, value, message.

umg.set_check_box (risk 2, mutates, smoke)

CheckBox: checked state, padding, state brushes and click method.

Argument	Type	Description
checked	string	"true"/"false".
state	string	Unchecked, Checked, Undetermined (overrides checked).
padding	string	Content padding {left,top,right,bottom}.
checkedImage	string	Checked-state image brush.
uncheckedImage	string	Unchecked-state image brush.
clickMethod	string	DownAndUp, MouseDown, PreciseClick.

Returns: widget, class, values.

umg.set_circular_throbber (risk 2, mutates, smoke)

CircularThrobber: number of pieces, period and radius.

Argument	Type	Description
pieces	string	Number of pieces.
period	string	Seconds for a full turn.
radius	string	Circle radius in pixels.
image	string	Piece image brush (5.x).

Returns: widget, class, values.

umg.set_class_defaults (risk 2, mutates, smoke)

Writes properties on the class default object of the generated widget class (values are JSON or plain text).

Argument	Type	Description
widgetBlueprint	string	required.
nameContains	string	Case-insensitive substring filter on the property name (read tools only).
properties	array of UeaKeyValue	Property assignments on the class default object ("PropertyName" -> JSON or text value).
limit	integer	Maximum number of properties listed (default 100). Default 0.

Returns: properties, count.

umg.set_class_settings (risk 2, mutates, smoke)

Sets class-level settings of the generated widget class: palette category, dynamic creation, PreConstruct, tick frequency, focusable, volatile.

Argument	Type	Description
widgetBlueprint	string	required.
paletteCategory	string	Palette category of the generated widget class.
supportsDynamicCreation	string	"true"/"false": the widget may be created dynamically at runtime.
canCallPreConstruct	string	"true"/"false": run PreConstruct in the designer and at runtime.
tickFrequency	string	Tick frequency: "auto", "never" or "enabled".
isFocusable	string	"true"/"false": the widget can receive keyboard focus.
isVolatile	string	"true"/"false": the widget is treated as a volatile (never cached) widget.

Returns: widgetBlueprint, compileErrors, applied, warnings.

umg.set_clipping (risk 2, mutates, smoke)

Sets the clipping mode: Inherit, ClipToBounds, ClipToBoundsWithoutIntersecting, ClipToBoundsAlways, OnDemand.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
value	string	required. The value to set; meaning depends on the tool (see its description).

Returns: widget.

umg.set_combo_box (risk 2, mutates, smoke)

ComboBoxString: option list, selected option, padding, list height and arrow.

Argument	Type	Description
options	array of string	Replaces the option list.
selected	string	Option selected by default.
contentPadding	string	Content padding {left,top,right,bottom}.
maxListHeight	string	Maximum height of the drop-down in pixels.
hasDownArrow	string	"true"/"false": show the drop-down arrow.
fontSize	string	Font size in points.
foregroundColor	string	Text color {r,g,b,a}.

Returns: widget, class, values.

umg.set_cursor (risk 2, mutates, smoke)

Sets the mouse cursor shown over the widget (Default, Hand, Crosshairs, TextEditBeam, ...).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
value	string	required. The value to set; meaning depends on the tool (see its description).

Returns: widget.

umg.set_design_size (risk 2, mutates, smoke)

Sets the designer preview size (mode custom/desired/fillScreen). Affects the designer only.

Argument	Type	Description
widgetBlueprint	string	required.
width	integer	Preview width in pixels. Default 0.
height	integer	Preview height in pixels. Default 0.
mode	string	Size mode: "custom" (use width/height), "desired" or "fillScreen".

Returns: widgetBlueprint, compileErrors, applied, warnings.

umg.set_display_label (risk 2, mutates, smoke)

Sets the designer display label of a widget (the name stays unchanged).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
value	string	required. The value to set; meaning depends on the tool (see its description).

Returns: widget.

umg.set_dynamic_entry_box (risk 2, mutates, UE 5.0+)

DynamicEntryBox (5.x): entry widget class, box type, spacing and preview count. SmokeSkip: a ListView/DynamicEntryBox without an EntryWidgetClass fails ValidateCompiledDefaults, so one cannot live in the smoke fixture.

Argument	Type	Description
entryClass	string	Widget blueprint used for each entry.
boxType	string	Horizontal, Vertical, Wrap, Overlay, Radial (engine dependent).
spacing	string	Space between entries {x,y}.
maxDisplayed	string	Maximum number of entries shown in the designer preview.

Returns: widget, class, values.

umg.set_editable_text (risk 2, mutates, smoke)

EditableText(Box): text, hint, password/read-only flags, justification, font size and focus behaviour.

Argument	Type	Description
text	string
hintText	string	Placeholder shown when empty.
isPassword	string	"true"/"false": show dots instead of characters.
readOnly	string	"true"/"false".
justification	string	Left, Center, Right.
fontSize	string	Font size in points.
minDesiredWidth	string	Minimum desired width in pixels.
clearKeyboardFocusOnCommit	string	"true"/"false".
selectAllTextWhenFocused	string	"true"/"false".
foregroundColor	string	Text color {r,g,b,a}.

Returns: widget, class, values.

umg.set_enabled (risk 2, mutates, smoke)

Enables or disables a widget ("true"/"false").

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
value	string	required. The value to set; meaning depends on the tool (see its description).

Returns: widget.

umg.set_expandable_area (risk 2, mutates, smoke)

ExpandableArea: expanded state, paddings, max height and border color.

Argument	Type	Description
expanded	string	"true"/"false": start expanded.
headerPadding	string	Header padding {left,top,right,bottom} (5.x).
areaPadding	string	Body padding {left,top,right,bottom} (5.x).
maxHeight	string	Maximum body height in pixels (5.x).
borderColor	string	Border color {r,g,b,a} (5.x).

Returns: widget, class, values.

umg.set_field_notify (risk 2, mutates, UE 5.1+, smoke)

Turns Field Notify (MVVM change notification) on or off for a variable.

Argument	Type	Description
widgetBlueprint	string	required.
variable	string	required.
enabled	boolean	Turn Field Notify on (default) or off. Default true.
compile	boolean	Default true.

Returns: widgetBlueprint, variables, message.

umg.set_font (risk 2, mutates, smoke)

Sets a font (asset, typeface, size, outline, letter spacing) on any widget that has one.

Argument	Type	Description
font	string	Font asset path (UFont or composite font).
typeface	string	Typeface name inside the font.
size	string	Size in points.
outlineSize	string	Outline thickness in pixels.
outlineColor	string	Outline color {r,g,b,a}.
letterSpacing	string	Extra letter spacing.
property	string	Font property to write (default "Font"; use "WidgetStyle.TextStyle.Font" for styled widgets).

Returns: widget, class, values.

umg.set_grid_panel (risk 2, mutates, smoke)

GridPanel: per-column and per-row fill weights.

Argument	Type	Description
columnFills	array of UeaKeyValue	Column index -> fill weight ("0" -> "1").
rowFills	array of UeaKeyValue	Row index -> fill weight.

Returns: widget, class, values.

umg.set_grid_slot (risk 2, mutates, smoke)

Grid (and uniform grid) slot: row, column, spans, layer, nudge, padding, alignments.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
row	string
column	string
rowSpan	string
columnSpan	string
layer	string	Draw layer inside the grid.
nudge	string	Pixel nudge "{'x':0,'y':0}".
padding	string
hAlign	string
vAlign	string

Returns: widget, slotClass, fields, validFields.

umg.set_image (risk 2, mutates, smoke)

Image: texture or material, draw size, tint, draw mode and nine-slice margin.

Argument	Type	Description
texture	string	Texture asset path.
material	string	Material asset path (exclusive with texture).
size	string	Draw size {x,y}.
tint	string	Brush tint {r,g,b,a}.
drawAs	string	Box, Border, Image, RoundedBox (5.x), None.
matchSize	string	"true" sets the draw size from the texture resolution.
colorAndOpacity	string	Widget-level tint {r,g,b,a} multiplied with the brush.
margin	string	Nine-slice margin {left,top,right,bottom} (used by drawAs=Box/Border).

Returns: widget, class, values.

umg.set_input_key_selector (risk 2, mutates, smoke)

InputKeySelector: bound key, modifier/gamepad flags, escape keys and prompt texts.

Argument	Type	Description
key	string	Key name ("SpaceBar", "Gamepad_FaceButton_Bottom").
allowModifiers	string	"true"/"false".
allowGamepad	string	"true"/"false".
escapeKeys	array of string	Keys that cancel the selection.
keySelectionText	string	Text shown while waiting for a key.
noKeySpecifiedText	string	Text shown when no key is bound.

Returns: widget, class, values.

umg.set_input_mode (risk 0, requires PIE, smoke)

Sets the PIE player's input mode (game only / UI only / game and UI) and cursor visibility.

Argument	Type	Description
mode	string	required. gameOnly, uiOnly or gameAndUi.
playerIndex	integer	Default 0.
showCursor	boolean	Default true.
id	string	Instance to focus (uiOnly / gameAndUi).
mouseLock	string	Mouse lock: doNotLock, lockOnCapture, lockAlways, lockInFullscreen. Default TEXT("doNotLock").

Returns: target, handledDown, handledUp, message.

umg.set_instance_position (risk 0, requires PIE)

Sets the viewport position (and optionally the desired size) of a live instance. SmokeSkip: needs a live instance (see umg.create_instance).

Argument	Type	Description
id	string	required.
x	number	Default 0.0.
y	number	Default 0.0.
width	number	Desired size in the viewport. 0,0 leaves it unset. Default 0.0.
height	number	Default 0.0.
removeDpiScale	boolean	Remove the DPI scale from the position. Default true. Default true.

Returns: instance, message.

umg.set_instance_property (risk 0, requires PIE)

Writes a property on a live instance or one of its widgets (no asset change). SmokeSkip: needs a widget tree fixture (the self-test sandbox is deleted before the PIE run).

Argument	Type	Description
id	string	required.
widget	string	Sub-widget of the instance. Empty = the instance itself.
property	string	required.
value	string	required. JSON value (see the umg conventions: colours, margins, brushes, fonts).

Returns: id, widget, property, value, message.

umg.set_instance_visibility (risk 0, requires PIE)

Sets the visibility of a live instance or of one of its widgets. SmokeSkip: needs a live instance (see umg.create_instance).

Argument	Type	Description
id	string	required.
visibility	string	required. Visible, Collapsed, Hidden, HitTestInvisible, SelfHitTestInvisible.
widget	string	Sub-widget inside the instance. Empty = the instance itself.

Returns: instance, message.

umg.set_invalidation_box (risk 2, mutates, smoke)

InvalidationBox: caching on or off.

Argument	Type	Description
canCache	string	required. "true"/"false": cache the children's geometry and draw elements.

Returns: widget, class, values.

umg.set_is_variable (risk 2, mutates, smoke)

Exposes (or hides) the widget as a Blueprint variable of the generated class.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
isVariable	boolean	True exposes the widget as a Blueprint variable of the generated class. Default true.
compile	boolean	Compile after the change (default true). Default true.

Returns: widget.

umg.set_list_view (risk 2, mutates)

ListView/TileView/TreeView: entry widget class, orientation, selection mode, spacing and tile size. SmokeSkip: a ListView/DynamicEntryBox without an EntryWidgetClass fails ValidateCompiledDefaults, so one cannot live in the smoke fixture.

Argument	Type	Description
entryClass	string	Widget blueprint used for each entry (must implement IUserObjectListEntry).
orientation	string	Horizontal, Vertical.
selectionMode	string	None, Single, SingleToggle, Multi.
entrySpacing	string	Space between entries in pixels.
scrollbarVisibility	string	Visible, Collapsed, ...
clearSelectionOnClick	string	"true"/"false".
itemAlignment	string	EvenlyDistributed, EvenlySize, EvenlyWide, LeftAligned, Fill (tile view, 5.x).
tileWidth	string	Tile width in pixels (tile view).
tileHeight	string	Tile height in pixels (tile view).

Returns: widget, class, values.

umg.set_localized_text (risk 2, mutates, smoke)

Sets a localized FText (namespace + key + source string) on a text property.

Argument	Type	Description
namespace	string	required. Localization namespace.
key	string	required. Localization key.
source	string	required. Source (native language) string.
property	string	Text property to write (default "Text").

Returns: widget, class, values.

umg.set_menu_anchor (risk 2, mutates, smoke)

MenuAnchor: menu widget class, placement and window fitting.

Argument	Type	Description
menuClass	string	Widget blueprint opened as the menu.
placement	string	ComboBox, ComboBoxRight, BelowAnchor, CenteredBelowAnchor, MenuRight, AboveAnchor, ...
fitInWindow	string	"true"/"false": keep the menu inside the window.
useApplicationMenuStack	string	"true"/"false": use the application menu stack.

Returns: widget, class, values.

umg.set_multi_line_text (risk 2, mutates, smoke)

MultiLineEditableText(Box): text, hint, read-only, justification, wrapping.

Argument	Type	Description
text	string
hintText	string
readOnly	string	"true"/"false".
justification	string	Left, Center, Right.
autoWrap	string	"true"/"false": auto-wrap the text.

Returns: widget, class, values.

umg.set_named_slot_content (risk 2, mutates, smoke)

Fills a NamedSlot with a new widget of widgetClass, or moves an existing widget into it.

Argument	Type	Description
widgetBlueprint	string	required.
slot	string	required. Named slot widget of the tree.
widgetClass	string	Widget class to create inside the slot (exclusive with widget).
widget	string	Existing widget to move into the slot (exclusive with widgetClass).
compile	boolean	Compile after the change (default true). Default true.

Returns: slot, content, contentClass.

umg.set_navigation (risk 2, mutates, smoke)

Sets one navigation rule of a widget (direction up/down/left/right/next/previous or "all").

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
direction	string	required. up, down, left, right, next, previous, or "all" for every direction.
rule	string	required. escape, stop, wrap, explicit, custom, customBoundary.
target	string	Target widget name for the "explicit" rule.

Returns: widget.

umg.set_padding (risk 2, mutates, smoke)

Sets the padding of any slot class that has one.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
padding	string	required. Padding "{'left':8,'top':4,'right':8,'bottom':4}", "8,4" or a single number.

Returns: widget, slotClass, fields, validFields.

umg.set_parent_class (risk 2, mutates, smoke)

Reparents the widget blueprint to another UserWidget-derived class and recompiles.

Argument	Type	Description
widgetBlueprint	string	required.
parentClass	string	required. New parent class; must derive from UserWidget.

Returns: name, parentClass, rootWidget, rootWidgetClass, widgetCount, createdWidgets.

umg.set_progress_bar (risk 2, mutates, smoke)

ProgressBar: percent, fill color, fill type, marquee and the two brushes.

Argument	Type	Description
percent	string	Fill amount 0..1.
fillColor	string	Fill color {r,g,b,a}.
fillType	string	LeftToRight, RightToLeft, FillFromCenter, TopToBottom, BottomToTop.
marquee	string	"true"/"false": indeterminate marquee animation.
barFillStyle	string	Mask, Scale (5.x).
backgroundImage	string	Background image brush.
fillImage	string	Fill image brush.

Returns: widget, class, values.

umg.set_properties (risk 2, mutates, smoke)

Writes several properties of one widget in one call.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
properties	array of UeaKeyValue	required. Property name -> value pairs.
compile	boolean	Compile after the change (default false). Default false.

Returns: widget, class, values.

umg.set_property (risk 2, mutates, smoke)

Writes one property of a widget from text or a JSON fragment.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
property	string	required. Property name or path.
value	string	required. New value: plain text or a JSON fragment (see the struct conventions in the kit guide).
compile	boolean	Compile after the change (default false: property edits do not change the class layout). Default false.

Returns: widget, class, values.

umg.set_property_on_all (risk 2, mutates, smoke)

Writes one property on every widget of a class inside the blueprint.

Argument	Type	Description
widgetBlueprint	string	required.
classFilter	string	required. Only widgets of this class (or a subclass).
property	string	required. Property name or path.
value	string	required. New value.

Returns: widgets, count.

umg.set_render_opacity (risk 2, mutates, smoke)

Sets the render opacity of a widget (0..1).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
value	string	required. The value to set; meaning depends on the tool (see its description).

Returns: widget.

umg.set_render_transform (risk 2, mutates, smoke)

Sets the render transform: translation, scale, shear, angle (degrees) and pivot.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
translation	string	Translation as "{'x':0,'y':0}" or "0,0".
scale	string	Scale as "{'x':1,'y':1}" or a single number.
shear	string	Shear as "{'x':0,'y':0}".
angle	string	Rotation angle in degrees.
pivot	string	Transform pivot in normalized widget space, default "{'x':0.5,'y':0.5}".

Returns: widget.

umg.set_retainer_box (risk 2, mutates, smoke)

RetainerBox: effect material, texture parameter, render phase and retain flag.

Argument	Type	Description
material	string	Effect material applied to the retained render.
textureParameter	string	Texture parameter of the material receiving the render target.
phase	string	Phase index (renders every phaseCount frames).
phaseCount	string	Number of phases.
retainRendering	string	"true"/"false": actually retain the rendering.

Returns: widget, class, values.

umg.set_rich_text (risk 2, mutates, smoke)

RichTextBlock: text with markup, style set data table and decorators.

Argument	Type	Description
text	string	The rich text, with
styleSet	string	Data table of FRichTextStyleRow rows.
decorators	array of string	Decorator classes to use.
autoWrap	string	"true"/"false": wrap long lines.
minDesiredWidth	string	Minimum desired width in pixels.

Returns: widget, class, values.

umg.set_root (risk 3, mutates, smoke)

Sets the root widget of the tree: a new widget of Class, or an existing widget promoted to root.

Argument	Type	Description
widgetBlueprint	string	required.
class	string	Widget class to create as the new root (exclusive with widget).
widget	string	Existing widget of the tree to promote to root (exclusive with class).
keepExisting	boolean	Move the current root under the new root when it is a panel (default true). Default true.
compile	boolean	Compile after the change (default true). Default true.

Returns: widget.

umg.set_safe_zone (risk 2, mutates, smoke)

SafeZone: which sides to pad and the title-safe flag.

Argument	Type	Description
padLeft	string	"true"/"false": pad the left side.
padRight	string
padTop	string
padBottom	string
isTitleSafe	string	"true"/"false": use the title-safe zone instead of the action-safe zone.

Returns: widget, class, values.

umg.set_scale_box (risk 2, mutates, smoke)

ScaleBox: stretch mode, direction, user scale and inherited-scale flag.

Argument	Type	Description
stretch	string	None, Fill, ScaleToFit, ScaleToFitX, ScaleToFitY, ScaleToFill, ScaleBySafeZone, UserSpecified.
stretchDirection	string	Both, DownOnly, UpOnly.
userScale	string	Scale used with stretch=UserSpecified.
ignoreInheritedScale	string	"true"/"false".

Returns: widget, class, values.

umg.set_scroll_box (risk 2, mutates, smoke)

ScrollBox: orientation, scroll bar look and scrolling behaviour.

Argument	Type	Description
orientation	string	Horizontal, Vertical.
barVisibility	string	Visible, Collapsed, Hidden, HitTestInvisible, SelfHitTestInvisible.
barThickness	string	Scroll bar thickness {x,y}.
animateWheel	string	"true"/"false": smooth wheel scrolling.
allowOverscroll	string	"true"/"false": rubber-band past the ends.
scrollWhenFocusChanges	string	NoScroll, IntoView.
consumeMouseWheel	string	"true"/"false": the box consumes the mouse wheel.
alwaysShowScrollbar	string	"true"/"false".
barPadding	string	Scroll bar padding {left,top,right,bottom}.

Returns: widget, class, values.

umg.set_size_box (risk 2, mutates, smoke)

SizeBox: width/height overrides, min/max sizes and aspect ratios; clear removes overrides.

Argument	Type	Description
width	string	Fixed width override.
height	string	Fixed height override.
minWidth	string
minHeight	string
maxWidth	string
maxHeight	string
minAspect	string	Minimum width/height ratio.
maxAspect	string	Maximum width/height ratio.
clear	array of string	Overrides to clear: width, height, minWidth, minHeight, maxWidth, maxHeight, minAspect, maxAspect, all.

Returns: widget, class, values.

umg.set_slider (risk 2, mutates, smoke)

Slider: value, range, step, orientation, locked/indent and colors.

Argument	Type	Description
value	string
minValue	string
maxValue	string
stepSize	string	Keyboard/controller step size.
orientation	string	Horizontal, Vertical.
locked	string	"true"/"false": the handle cannot be moved.
indentHandle	string	"true"/"false": the handle is indented into the bar.
barColor	string	Bar color {r,g,b,a}.
handleColor	string	Handle color {r,g,b,a}.

Returns: widget, class, values.

umg.set_slider_value (risk 0, requires PIE)

Sets a slider (or spin box) value on a live instance and broadcasts its change delegate. SmokeSkip: needs a widget tree fixture in the PIE session.

Argument	Type	Description
id	string	required.
widget	string	required.
value	number	required.

Returns: id, widget, class, value, message.

umg.set_slot (risk 2, mutates, smoke)

Writes any field of a widget's slot by name; unknown fields are reported with the valid list.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
fields	array of UeaKeyValue	Slot field assignments ("Padding" -> "8", "HorizontalAlignment" -> "Fill", "LayoutData.Anchors" -> "center").

Returns: widget, slotClass, fields, validFields.

umg.set_spacer (risk 2, mutates, smoke)

Spacer: fixed size.

Argument	Type	Description
size	string	required. Size {x,y} in pixels.

Returns: widget, class, values.

umg.set_spin_box (risk 2, mutates, smoke)

SpinBox: value, ranges, delta and fractional digits.

Argument	Type	Description
value	string
minValue	string
maxValue	string
minSliderValue	string	Lower bound of the slider part.
maxSliderValue	string	Upper bound of the slider part.
delta	string	Increment per drag unit (0 = continuous).
minFractionalDigits	string
maxFractionalDigits	string
foregroundColor	string	Text color {r,g,b,a}.

Returns: widget, class, values.

umg.set_style_asset_property (risk 2, mutates, smoke)

Writes fields of the style struct inside a style asset ("Normal.TintColor", "NormalPadding"...).

Argument	Type	Description
style	string	required.
properties	array of UeaKeyValue	required. Property paths inside the style struct and their JSON values.

Returns: style, properties, warnings, message.

umg.set_switcher (risk 0, requires PIE)

Sets the active index of a widget switcher of a live instance. SmokeSkip: needs a widget tree fixture in the PIE session.

Argument	Type	Description
id	string	required.
widget	string	required.
index	integer	required.

Returns: id, widget, class, value, message.

umg.set_switcher_index (risk 2, mutates, smoke)

WidgetSwitcher: active child by index or by widget name.

Argument	Type	Description
index	string	Index of the child to show.
activeWidget	string	Name of the child widget to show (overrides index).

Returns: widget, class, values.

umg.set_text (risk 2, mutates, smoke)

TextBlock: text, wrapping, justification, color, font and shadow in one call.

Argument	Type	Description
text	string	The text to display.
autoWrap	string	"true"/"false": wrap long lines automatically.
justification	string	Left, Center, Right, InvariantLeft...
color	string	Text color {r,g,b,a}.
fontSize	string	Font size in points.
font	string	Font asset path.
typeface	string	Typeface inside the font ("Bold", "Italic").
shadowOffset	string	Shadow offset {x,y}.
shadowColor	string	Shadow color {r,g,b,a}.
letterSpacing	string	Extra spacing between letters (1/1000 em).
minDesiredWidth	string	Minimum desired width in pixels.
transformPolicy	string	None, ToLower, ToUpper (5.x).
overflowPolicy	string	Clip, Ellipsis (5.x).
wrapTextAt	string	Wrap width in pixels (0 = use the desired width).

Returns: widget, class, values.

umg.set_text_input (risk 0, requires PIE)

Types text into an editable text (box) of a live instance and optionally commits it. SmokeSkip: needs a widget tree fixture in the PIE session.

Argument	Type	Description
id	string	required.
widget	string	required.
text	string	required.
commit	boolean	Fire OnTextCommitted (OnCommit) after setting the text. Default true. Default true.

Returns: id, widget, class, value, message.

umg.set_text_style_everywhere (risk 2, mutates, smoke)

Applies one font/size/typeface/colour to every text block of a widget blueprint.

Argument	Type	Description
widgetBlueprint	string	required.
font	string	Font asset path. Empty keeps the current font object.
size	integer	Font size in points. 0 keeps the current size. Default 0.
typeface	string	Typeface name ("Regular", "Bold"...). Empty keeps the current one.
color	string	Colour as {r,g,b,a} or a comma list. Empty keeps the current colour.
nameContains	string	Only widgets whose name contains this text.
compile	boolean	Default true.

Returns: widgetBlueprint, applied, warnings, compileErrors, message.

umg.set_throbber (risk 2, mutates, smoke)

Throbber: number of pieces, animation axes and (5.x) the piece image.

Argument	Type	Description
pieces	string	Number of pieces.
animateHorizontally	string	"true"/"false".
animateVertically	string	"true"/"false".
animateOpacity	string	"true"/"false".
image	string	Piece image brush (5.x).

Returns: widget, class, values.

umg.set_tooltip (risk 2, mutates, smoke)

Sets the tooltip text of a widget.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
value	string	required. The value to set; meaning depends on the tool (see its description).

Returns: widget.

umg.set_ui_settings (risk 4, mutates)

Writes the project's User Interface settings. SmokeSkip: writes project config (DefaultEngine.ini).

Argument	Type	Description
properties	array of UeaKeyValue	required. Properties of UUserInterfaceSettings to write ("ApplicationScale", "UIScaleRule", "RenderFocusRule"...).
saveConfig	boolean	Save to DefaultEngine.ini. Default true. Default true.

Returns: applicationScale, uiScaleRule, customScalingRuleClass, renderFocusRule, defaultCursor, dpiCurve, values, message.

umg.set_uniform_grid (risk 2, mutates, smoke)

UniformGridPanel: cell padding and minimum cell size.

Argument	Type	Description
slotPadding	string	Padding of every cell {left,top,right,bottom}.
minSlotWidth	string
minSlotHeight	string

Returns: widget, class, values.

umg.set_visibility (risk 2, mutates, smoke)

Sets the visibility: Visible, Collapsed, Hidden, HitTestInvisible, SelfHitTestInvisible.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
value	string	required. The value to set; meaning depends on the tool (see its description).

Returns: widget.

umg.set_widget_color (risk 2, mutates, smoke)

Sets the main color of a widget, choosing the right property for its class (text, image, border, progress bar...).

Argument	Type	Description
color	string	required. Color {r,g,b,a} written to the first matching color property of the widget.
slot	string	Which color to write: "auto" (default), "content", "background", "fill", "foreground".

Returns: widget, class, values.

umg.set_widget_navigation_rules (risk 2, mutates, smoke)

Sets every navigation direction of a widget at once ("stop", "wrap", "escape" or "explicit:WidgetName").

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
up	string	Rule for the up direction (escape, stop, wrap, explicit:WidgetName).
down	string
left	string
right	string
next	string
previous	string

Returns: widget.

umg.set_widget_style (risk 2, mutates, smoke)

Writes a whole widget style struct (WidgetStyle by default) from a JSON object.

Argument	Type	Description
style	string	required. JSON object written into the widget's style struct ("{'Normal':{'texture':'...'},'NormalPadding':4}").
property	string	Style property name (default "WidgetStyle").

Returns: widget, class, values.

umg.set_widget_texts (risk 2, mutates, smoke)

Sets the text of several widgets at once (widget name -> text).

Argument	Type	Description
widgetBlueprint	string	required.
texts	array of UeaKeyValue	required. Widget name -> text. Widgets without a text property are reported in warnings.

Returns: widgets, count.

umg.set_wrap_box (risk 2, mutates, smoke)

WrapBox: inner padding and (5.x) wrap size, orientation and alignment.

Argument	Type	Description
innerSlotPadding	string	Padding between items {x,y}.
wrapSize	string	Wrap width in pixels (5.x).
explicitWrapSize	string	"true"/"false": use wrapSize instead of the available size (5.x).
orientation	string	Horizontal, Vertical (5.x).
hAlign	string	Fill, Left, Center, Right (5.x).

Returns: widget, class, values.

umg.simulate_click_at (risk 2, requires PIE)

Sends a raw mouse press+release at an absolute screen position. SmokeSkip: moves the real cursor.

Argument	Type	Description
x	number	required. Absolute screen X.
y	number	required. Absolute screen Y.
button	string	LeftMouseButton (default), RightMouseButton, MiddleMouseButton. Default TEXT("LeftMouseButton").

Returns: target, handledDown, handledUp, message.

umg.simulate_key (risk 1, requires PIE, smoke)

Sends a raw key event to Slate (the focused widget handles it).

Argument	Type	Description
key	string	required. FKey name: SpaceBar, Enter, Escape, Gamepad_FaceButton_Bottom...
event	string	press, release or tap (default). Default TEXT("tap").
control	boolean	Default false.
alt	boolean	Default false.
shift	boolean	Default false.

Returns: target, handledDown, handledUp, message.

umg.stop_animation (risk 0, requires PIE)

Stops one animation (or all of them when animation is empty) on a live instance. SmokeSkip: needs a live instance (see umg.create_instance).

Argument	Type	Description
id	string	required.
animation	string	Animation name. Empty stops every animation (umg.stop_animation).

Returns: id, animation, playing, currentTime, message.

umg.unbind_event (risk 3, mutates, destructive, smoke)

Removes the bound event node of a widget delegate.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	required.
event	string	required. Delegate name: OnClicked, OnHovered, OnValueChanged, OnTextCommitted, OnCheckStateChanged...
compile	boolean	Default true.

Returns: widgetBlueprint, node, existing, boundEvents, compileErrors, message.

umg.unwrap_widget (risk 3, mutates, smoke)

Replaces a widget by its single child (the inverse of umg.wrap_widget).

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget name (empty = the root widget).
compile	boolean	Compile after the change (default true). Default true.

Returns: widget.

umg.validate (risk 0, smoke)

Audits a widget blueprint: unfilled BindWidget requirements, empty panels, widgets outside the design area, broken bindings, unused variable widgets.

Argument	Type	Description
widgetBlueprint	string	required. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name.

Returns: issues, notes, valid.

umg.wrap_widget (risk 2, mutates, smoke)

Wraps one or several sibling widgets into a new panel of WrapperClass.

Argument	Type	Description
widgetBlueprint	string	required.
widget	string	Widget to wrap (use widgets for several).
widgets	array of string	Widgets to wrap into a single new panel (they must share a parent).
wrapperClass	string	required. Panel class that becomes their new parent ("SizeBox", "Border", "VerticalBox", ...).
name	string	Name of the wrapper.
compile	boolean	Compile after the change (default true). Default true.

Returns: widget.