Kit umg

252 ferramentas. Gerado a partir do código-fonte do plugin; não edite manualmente.

As descrições das ferramentas e dos argumentos são exibidas em inglês porque espelham o schema das ferramentas (o mesmo texto que o agente recebe em tools/list).

Guia

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.

Ferramentas

Legenda. risco 0 = somente leitura, 1 = operação inofensiva do editor, 2 = altera asset, 3 = apaga/substitui asset, 4 = projeto/config/build, 5 = potencialmente destrutivo (chamadas acima de MaxAutoRisk exigem "_confirm": true). altera = roda numa transação (edit.undo reverte). requer PIE / requer mundo = recusado sem sessão PIE / sem nível aberto. requer plugin = indisponível quando o plugin está desativado. dryRun = aceita o argumento dryRun. smoke = coberto por edit.self_test.

umg.add_dispatcher (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
name	string	obrigatório.
params	array of UeaUmgDispatcherParam
compile	boolean	Padrão true.

Retorna: widgetBlueprint, variables, message.

umg.add_override (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
function	string	obrigatório. PreConstruct, Construct, Tick, Destruct, OnMouseButtonDown, OnKeyDown, OnDrop, OnDragDetected...
graph	string	Event graph name. Empty = the main EventGraph.
x	integer	Padrão 0.
y	integer	Padrão 0.
compile	boolean	Padrão true.

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

umg.add_property_binding (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
property	string	obrigatório. 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. Padrão true.

Retorna: widgetBlueprint, bindings, compileErrors, message.

umg.add_rich_image (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
table	string	obrigatório. Data table asset.
row	string	obrigatório. 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").

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

umg.add_rich_text_style (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
table	string	obrigatório. Data table asset.
row	string	obrigatório. 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").

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

umg.add_typeface (risco 2, altera)

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

Argumento	Tipo	Descrição
font	string	obrigatório.
name	string	obrigatório.
fontFace	string	obrigatório. Font face asset for this typeface entry.

Retorna: font, typefaces, message.

umg.add_user_widget (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
userWidget	string	obrigatório. 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. Padrão -1.
compile	boolean	Compile after the change (default true). Padrão true.

Retorna: widget.

umg.add_variable (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
name	string	obrigatório.
type	string	obrigatório. 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	Padrão false.
exposeOnSpawn	boolean	Padrão false.
fieldNotify	boolean	Mark as Field Notify (MVVM), 5.1+. Padrão false.
compile	boolean	Padrão true.

Retorna: widgetBlueprint, variables, message.

umg.add_widget (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
class	string	obrigatório. 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. Padrão -1.
isVariable	boolean	Expose the widget as a Blueprint variable (default true, like the designer). Padrão 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). Padrão true.

Retorna: widget.

umg.add_widgets (risco 2, altera, 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.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widgets	array of UeaUmgWidgetSpec	obrigatório. Widgets to create, in order; each may parent to one created earlier in the list.
compile	boolean	Compile once at the end (default true). Padrão true.

Retorna: widgets, count.

umg.anim_add_binding (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório.
widget	string	obrigatório.
slot	boolean	Bind the widget's slot (for Slot.* properties) instead of the widget itself. Padrão false.

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

umg.anim_add_key (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório.
widget	string	obrigatório.
property	string	obrigatório.
time	number	obrigatório. Time in seconds.
value	string	obrigatório. 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". Padrão TEXT("cubic").

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

umg.anim_add_keys (risco 2, altera, smoke)

Adds several keys to one track in a single call.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório.
widget	string	obrigatório.
property	string	obrigatório.
keys	array of UeaUmgAnimKeyEntry	obrigatório.

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

umg.anim_add_track (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório.
widget	string	obrigatório.
property	string	obrigatório. Property path: "RenderOpacity", "ColorAndOpacity", "Visibility", "RenderTransform", "Slot.Offsets"...

Retorna: animation, tracks, message.

umg.anim_clear_keys (risco 3, altera, destrutivo, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório.
widget	string	obrigatório.
property	string	obrigatório. Property path: "RenderOpacity", "ColorAndOpacity", "Visibility", "RenderTransform", "Slot.Offsets"...

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

umg.anim_color (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório. Widget to animate.
animation	string	obrigatório. 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. Padrão 0.3.
startTime	number	Start time in seconds. Default 0. Padrão 0.0.
interp	string	"cubic" (default), "linear" or "constant". Padrão TEXT("cubic").

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

umg.anim_create (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
name	string	obrigatório.
length	number	Length in seconds. Default 5. Padrão 5.0.
displayRate	number	Editor display rate in fps. 0 = the engine default (20 on 4.27, project setting on 5.x). Padrão 0.0.

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

umg.anim_duplicate (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório.
newName	string	Name of the copy. Empty appends "_Copy".

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

umg.anim_export (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório. Animation object name or display label. Empty picks the only animation of the blueprint.

Retorna: animation, json.

umg.anim_fade (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório. Widget to animate.
animation	string	obrigatório. 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. Padrão 0.3.
startTime	number	Start time in seconds. Default 0. Padrão 0.0.
interp	string	"cubic" (default), "linear" or "constant". Padrão TEXT("cubic").

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

umg.anim_get (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório. Animation object name or display label. Empty picks the only animation of the blueprint.

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

umg.anim_get_keys (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório.
widget	string	obrigatório.
property	string	obrigatório. Property path: "RenderOpacity", "ColorAndOpacity", "Visibility", "RenderTransform", "Slot.Offsets"...

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

umg.anim_import (risco 2, altera)

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.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório. Animation name to create or overwrite.
json	string	obrigatório. JSON from umg.anim_export.
replace	boolean	Remove the existing tracks of the animation first. Default true. Padrão true.

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

umg.anim_list (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório. Widget blueprint: object path, package path or unique asset name.

Retorna: widgetBlueprint, animations.

umg.anim_list_properties (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.

Retorna: widget, class, properties.

umg.anim_list_tracks (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório. Animation object name or display label. Empty picks the only animation of the blueprint.

Retorna: animation, tracks, message.

umg.anim_pulse (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório. Widget to animate.
animation	string	obrigatório. 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. Padrão 0.3.
startTime	number	Start time in seconds. Default 0. Padrão 0.0.
interp	string	"cubic" (default), "linear" or "constant". Padrão TEXT("cubic").

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

umg.anim_remove (risco 3, altera, destrutivo, smoke)

Removes an animation from the widget blueprint.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório. Animation object name or display label. Empty picks the only animation of the blueprint.

Retorna: widgetBlueprint, animations.

umg.anim_remove_binding (risco 3, altera, destrutivo, smoke)

Removes a widget binding and every track attached to it.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório.
widget	string	obrigatório.
slot	boolean	Bind the widget's slot (for Slot.* properties) instead of the widget itself. Padrão false.

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

umg.anim_remove_key (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório.
widget	string	obrigatório.
property	string	obrigatório.
time	number	obrigatório. 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. Padrão -1.

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

umg.anim_remove_track (risco 3, altera, destrutivo, smoke)

Removes a property track from an animation.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório.
widget	string	obrigatório.
property	string	obrigatório. Property path: "RenderOpacity", "ColorAndOpacity", "Visibility", "RenderTransform", "Slot.Offsets"...

Retorna: animation, tracks, message.

umg.anim_rename (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório.
newName	string	obrigatório.

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

umg.anim_scale (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório. Widget to animate.
animation	string	obrigatório. 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. Padrão 0.3.
startTime	number	Start time in seconds. Default 0. Padrão 0.0.
interp	string	"cubic" (default), "linear" or "constant". Padrão TEXT("cubic").

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

umg.anim_set_display_rate (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório.
displayRate	number	obrigatório. Frames per second shown in the Sequencer timeline.

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

umg.anim_set_key (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório.
widget	string	obrigatório.
property	string	obrigatório.
time	number	obrigatório. Time in seconds.
value	string	obrigatório. 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". Padrão TEXT("cubic").

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

umg.anim_set_range (risco 2, altera, smoke)

Sets the playback range of an animation in seconds.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
animation	string	obrigatório.
start	number	Start in seconds. Padrão 0.0.
end	number	obrigatório. End in seconds.

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

umg.anim_slide (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório. Widget to animate.
animation	string	obrigatório. 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. Padrão 0.3.
startTime	number	Start time in seconds. Default 0. Padrão 0.0.
interp	string	"cubic" (default), "linear" or "constant". Padrão TEXT("cubic").

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

umg.apply_style_asset (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
style	string	obrigatório.
property	string	Style property of the widget. Empty = WidgetStyle.
compile	boolean	Padrão true.

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

umg.apply_theme (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
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. Padrão 0.
compile	boolean	Padrão true.

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

umg.audit (risco 0, smoke)

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

Argumento	Tipo	Descrição
folder	string	Content folder to walk (recursive). Empty = /Game.
nameContains	string	Only widget blueprints whose name contains this text.
limit	integer	Padrão 200.

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

umg.batch_compile (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
folder	string	Content folder to walk (recursive). Empty = /Game.
nameContains	string	Only widget blueprints whose name contains this text.
limit	integer	Padrão 200.

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

umg.batch_rename_widgets (risco 2, altera, dryRun, smoke)

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

Argumento	Tipo	Descrição
folder	string
pattern	string	obrigatório. Substring to look for in widget names.
replace	string	obrigatório. Replacement text.
dryRun	boolean	Padrão false.
compile	boolean	Padrão true.

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

umg.batch_replace_class (risco 3, altera, dryRun, smoke)

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

Argumento	Tipo	Descrição
folder	string
fromClass	string	obrigatório. Widget class to replace ("TextBlock").
toClass	string	obrigatório. Replacement widget class ("RichTextBlock").
copyProperties	boolean	Copy the properties both classes share. Default true. Padrão true.
dryRun	boolean	Padrão false.
compile	boolean	Padrão true.

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

umg.batch_replace_texture (risco 2, altera, dryRun, smoke)

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

Argumento	Tipo	Descrição
folder	string
from	string	obrigatório. Asset currently referenced (texture, material, font...).
to	string	obrigatório. Replacement asset.
dryRun	boolean	Padrão false.
compile	boolean	Padrão true.

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

umg.batch_set_font (risco 2, altera, dryRun, smoke)

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

Argumento	Tipo	Descrição
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. Padrão 0.
typeface	string	Typeface name. Empty keeps it.
classFilter	string	Widget class filter. Default TextBlock. Padrão TEXT("TextBlock").
dryRun	boolean	Padrão false.
compile	boolean	Padrão true.

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

umg.batch_set_properties (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
items	array of UeaUmgBatchItem	obrigatório. One entry per widget.
compile	boolean	Compile once at the end (default false). Padrão false.

Retorna: widgets, count.

umg.batch_set_property (risco 2, altera, dryRun, smoke)

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

Argumento	Tipo	Descrição
folder	string
classFilter	string	obrigatório. Widget class the property is written on.
property	string	obrigatório.
value	string	obrigatório. JSON value (see the umg conventions).
dryRun	boolean	Padrão false.
compile	boolean	Padrão true.

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

umg.bind_event (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
event	string	obrigatório. Delegate name: OnClicked, OnHovered, OnValueChanged, OnTextCommitted, OnCheckStateChanged...
compile	boolean	Padrão true.

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

umg.call_dispatcher_on_event (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
event	string	obrigatório. Widget delegate to bind (OnClicked...).
dispatcher	string	obrigatório. Event dispatcher of the widget blueprint to call.
compile	boolean	Padrão true.

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

umg.clear_tree (risco 5, altera, destrutivo, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
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). Padrão true.

Retorna: widgetBlueprint, compileErrors, applied, warnings.

umg.click_button (risco 0, requer 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.

Argumento	Tipo	Descrição
id	string	obrigatório.
widget	string	obrigatório. Sub-widget inside the instance.

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

umg.compile (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
save	boolean	Save the asset after a successful compile (default false). Padrão false.

Retorna: compileWarnings, status.

umg.copy_properties (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
from	string	obrigatório. Source widget.
to	array of string	obrigatório. Destination widgets.
properties	array of string	Property names to copy; empty copies every editable property the classes share.

Retorna: widgets, count.

umg.create (risco 2, altera, 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.

Argumento	Tipo	Descrição
folder	string	obrigatório. Destination content folder ("/Game/UI").
name	string	obrigatório. 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). Padrão 0.
designHeight	integer	Designer preview height in pixels (0 = engine default). Padrão 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).

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

umg.create_font (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
folder	string	obrigatório.
name	string	obrigatório.
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". Padrão TEXT("Default").
size	integer	Legacy font size stored on the asset. Default 24. Padrão 24.

Retorna: font, typefaces, message.

umg.create_from_template (risco 2, altera, 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.

Argumento	Tipo	Descrição
folder	string	obrigatório. Destination content folder.
name	string	obrigatório. Asset name.
template	string	obrigatório. One of: hud, mainMenu, pauseMenu, dialog, inventoryGrid, healthBar, loadingScreen, settingsList.
parentClass	string	Parent class (default "UserWidget").

Retorna: widgets, template.

umg.create_instance (risco 0, requer 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.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório. 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	Padrão 0.
addToViewport	boolean	Add it to the player viewport. Default true. Padrão true.
zOrder	integer	Padrão 0.

Retorna: instance, message.

umg.create_rich_image_table (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
folder	string	obrigatório.
name	string	obrigatório.

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

umg.create_rich_text_style_table (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
folder	string	obrigatório.
name	string	obrigatório.

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

umg.create_style_asset (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
folder	string	obrigatório. Destination content folder, e.g. "/Game/UI/Styles".
name	string	obrigatório.
styleClass	string	obrigatório. 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}").

Retorna: style, properties, warnings, message.

umg.cui_add_button (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
name	string	obrigatório.
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	Padrão true.

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

umg.cui_add_input_action (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

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

Argumento	Tipo	Descrição
table	string	obrigatório.
row	string	obrigatório.
properties	array of UeaKeyValue	Row fields ("DisplayName", "KeyboardInputTypeInfo.Key", "bActionRequiresHold"...).

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

umg.cui_add_stack (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
name	string	obrigatório.
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	Padrão true.

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

umg.cui_add_switcher (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

Adds a CommonActivatableWidgetSwitcher to a widget tree.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
name	string	obrigatório.
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	Padrão true.

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

umg.cui_add_tab_list (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
name	string	obrigatório.
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	Padrão true.

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

umg.cui_add_text (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
name	string	obrigatório.
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	Padrão true.

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

umg.cui_create_activatable_widget (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

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

Argumento	Tipo	Descrição
folder	string	obrigatório.
name	string	obrigatório.
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...).

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

umg.cui_create_border_style (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

Creates a CommonBorderStyle blueprint (background brush and tint).

Argumento	Tipo	Descrição
folder	string	obrigatório.
name	string	obrigatório.
properties	array of UeaKeyValue	Initial values of the style class defaults ("NormalBase.TintColor", "MinWidth"...).
parentClass	string	Parent class override (a CommonButtonStyle/CommonTextStyle/CommonBorderStyle subclass).

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

umg.cui_create_button_style (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

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

Argumento	Tipo	Descrição
folder	string	obrigatório.
name	string	obrigatório.
properties	array of UeaKeyValue	Initial values of the style class defaults ("NormalBase.TintColor", "MinWidth"...).
parentClass	string	Parent class override (a CommonButtonStyle/CommonTextStyle/CommonBorderStyle subclass).

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

umg.cui_create_input_action_table (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

Creates a data table of Common UI input action rows.

Argumento	Tipo	Descrição
folder	string	obrigatório.
name	string	obrigatório.

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

umg.cui_create_text_style (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

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

Argumento	Tipo	Descrição
folder	string	obrigatório.
name	string	obrigatório.
properties	array of UeaKeyValue	Initial values of the style class defaults ("NormalBase.TintColor", "MinWidth"...).
parentClass	string	Parent class override (a CommonButtonStyle/CommonTextStyle/CommonBorderStyle subclass).

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

umg.cui_get_input_settings (risco 0, UE 5.0+, requer plugin CommonUI, smoke)

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

Argumento	Tipo	Descrição
nameContains	string
placeableOnly	boolean	Only classes that can be placed in a widget tree (skips abstract ones). Padrão false.
limit	integer	Padrão 200.

Retorna: settingsClass, values, message.

umg.cui_get_style (risco 0, UE 5.0+, requer plugin CommonUI, smoke)

Class defaults of a Common UI style blueprint.

Argumento	Tipo	Descrição
style	string	obrigatório. Style blueprint created by umg.cui_create_*_style.

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

umg.cui_list_input_actions (risco 0, UE 5.0+, requer plugin CommonUI, smoke)

Rows of a Common UI input action table.

Argumento	Tipo	Descrição
table	string	obrigatório.

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

umg.cui_list_widget_classes (risco 0, UE 5.0+, requer plugin CommonUI, smoke)

Common UI widget and style classes available in the project.

Argumento	Tipo	Descrição
nameContains	string
placeableOnly	boolean	Only classes that can be placed in a widget tree (skips abstract ones). Padrão false.
limit	integer	Padrão 200.

Retorna: classes, count, message.

umg.cui_set_activatable (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
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	Padrão true.

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

umg.cui_set_button (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
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	Padrão true.

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

umg.cui_set_input_settings (risco 4, altera, UE 5.0+, requer plugin CommonUI)

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

Argumento	Tipo	Descrição
properties	array of UeaKeyValue	obrigatório. Properties of the Common UI input settings to write.
saveConfig	boolean	Padrão true.

Retorna: settingsClass, values, message.

umg.cui_set_style_property (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

Writes class defaults on a Common UI style blueprint.

Argumento	Tipo	Descrição
style	string	obrigatório.
properties	array of UeaKeyValue	obrigatório.
compile	boolean	Padrão true.

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

umg.cui_set_text_block_style (risco 2, altera, UE 5.0+, requer plugin CommonUI, smoke)

Applies a Common UI text style to a CommonTextBlock.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
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	Padrão true.

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

umg.cui_validate (risco 0, UE 5.0+, requer plugin CommonUI, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.

Retorna: widgetBlueprint, issues, commonWidgets, message.

umg.delete (risco 3, altera, destrutivo, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name.

Retorna: widgetBlueprint, compileErrors, applied, warnings.

umg.duplicate (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
newName	string	obrigatório. Name of the copy.
folder	string	Destination folder (default: the source folder).

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

umg.duplicate_widget (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório. 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). Padrão true.

Retorna: widget.

umg.export_all_trees (risco 0, smoke)

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

Argumento	Tipo	Descrição
folder	string
outFolder	string	Output folder relative to the project directory. Default "Saved/UeaSmoke". Padrão TEXT("Saved/UmgTrees").
limit	integer	Padrão 200.

Retorna: outFolder, files, count, message.

umg.export_tree (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
withProperties	boolean	Include every editable property of each widget (default false: only the non-default ones the kit tracks). Padrão false.

Retorna: json, widgetCount.

umg.find_by_widget_class (risco 0, smoke)

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

Argumento	Tipo	Descrição
folder	string
class	string	obrigatório. Widget class to look for ("Button", "CommonButtonBase").
includeSubclasses	boolean	Include subclasses of the class. Default true. Padrão true.
limit	integer	Padrão 200.

Retorna: hits, count, blueprintsScanned, message.

umg.find_instance_widget (risco 0, requer PIE)

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

Argumento	Tipo	Descrição
id	string	obrigatório.
name	string	Widget name (exact or substring).
class	string	Widget class filter ("Button", "TextBlock").

Retorna: id, widgets, count.

umg.find_widgets (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
pattern	string	obrigatório. Wildcard pattern matched against the widget name and label ("Btn_*", "Health").

Retorna: widgets, count.

umg.find_widgets_using (risco 0, smoke)

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

Argumento	Tipo	Descrição
asset	string	obrigatório. Asset to look for (texture, material, font, widget blueprint...).
folder	string
limit	integer	Padrão 200.

Retorna: hits, count, blueprintsScanned, message.

umg.get (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name.

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

umg.get_class_defaults (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
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). Padrão 0.

Retorna: properties, count.

umg.get_compile_errors (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name.

Retorna: compileWarnings, status.

umg.get_desired_size (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget inside the tree. Empty = the root widget.

Retorna: widget, width, height, message.

umg.get_font (risco 0, smoke)

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

Argumento	Tipo	Descrição
font	string	obrigatório.

Retorna: font, typefaces, message.

umg.get_instance_property (risco 0, requer 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).

Argumento	Tipo	Descrição
id	string	obrigatório.
widget	string
property	string	obrigatório.

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

umg.get_instance_tree (risco 0, requer PIE)

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

Argumento	Tipo	Descrição
id	string	obrigatório. Instance label from umg.create_instance (or a live widget's object/class name).

Retorna: id, widgets, count.

umg.get_named_slot_content (risco 0, smoke)

Widget currently filling a NamedSlot.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
slot	string	obrigatório. 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). Padrão true.

Retorna: slot, content, contentClass.

umg.get_parent (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
withProperties	boolean	Include the non-default property values. Padrão false.

Retorna: widget.

umg.get_properties (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
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). Padrão true.
limit	integer	Maximum number of properties returned (default 100). Padrão 0.

Retorna: widget, class, properties, count.

umg.get_property (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
property	string	obrigatório. Property name or path ("Text", "Brush.ImageSize", "Slot.Padding").

Retorna: widget, class, properties, count.

umg.get_slot (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
fields	array of UeaKeyValue	Slot field assignments ("Padding" -> "8", "HorizontalAlignment" -> "Fill", "LayoutData.Anchors" -> "center").

Retorna: widget, slotClass, fields, validFields.

umg.get_style_asset (risco 0, smoke)

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

Argumento	Tipo	Descrição
style	string	obrigatório. Slate widget style asset (path or unique name).

Retorna: style, properties, warnings, message.

umg.get_text (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório. Widget name.

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

umg.get_tree (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
depth	integer	Maximum depth reported (0 = no limit). Padrão 0.
withProperties	boolean	Include the non-default property values of each widget. Padrão false.

Retorna: widgets, count, root, depth.

umg.get_tree_depth (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name.

Retorna: depth, widgetCount, deepestPath.

umg.get_ui_settings (risco 0, smoke)

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

Argumento	Tipo	Descrição
folder	string	Content folder. Empty = /Game.
nameContains	string
limit	integer	Padrão 200.

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

umg.get_widget (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
withProperties	boolean	Include the non-default property values. Padrão false.

Retorna: widget.

umg.get_widget_class_info (risco 0, smoke)

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

Argumento	Tipo	Descrição
class	string	obrigatório. Widget class short name ("Button"), C++ name ("UButton") or widget blueprint path.
includeInherited	boolean	Include properties inherited from UWidget/UVisual (default false). Padrão false.

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

umg.get_widget_description (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name inside the tree (empty = the root widget).

Retorna: widget, description, toolTip, slotSummary.

umg.get_widget_geometry (risco 0, requer 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.

Argumento	Tipo	Descrição
id	string	obrigatório.
widget	string	obrigatório. Sub-widget inside the instance.

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

umg.import_font_face (risco 2, altera)

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

Argumento	Tipo	Descrição
folder	string	obrigatório.
name	string	obrigatório.
file	string	obrigatório. Absolute path to a .ttf/.otf file on disk.
hinting	string	Default, AutoHinting, DefaultHinting, Monochrome or None. Padrão TEXT("Default").

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

umg.import_tree (risco 3, altera, 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.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
json	string	obrigatório. 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. Padrão true.
compile	boolean	Compile after the import (default true). Padrão true.

Retorna: json, widgetCount.

umg.insert_widget (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
class	string	obrigatório. Widget class to create.
target	string	obrigatório. 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). Padrão true.

Retorna: widget.

umg.is_animation_playing (risco 0, requer 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.

Argumento	Tipo	Descrição
id	string	obrigatório.
animation	string	Animation name. Empty stops every animation (umg.stop_animation).

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

umg.list (risco 0, smoke)

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

Argumento	Tipo	Descrição
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). Padrão 0.

Retorna: assets, count.

umg.list_bind_widget_requirements (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.

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

umg.list_bindings (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.

Retorna: widgetBlueprint, bindings, compileErrors, message.

umg.list_bound_events (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.

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

umg.list_children (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
withProperties	boolean	Include the non-default property values. Padrão false.

Retorna: widgets, count.

umg.list_engine_fonts (risco 0, smoke)

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

Argumento	Tipo	Descrição
folder	string	Content folder. Empty = /Game.
nameContains	string
limit	integer	Padrão 200.

Retorna: fonts, count.

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

Variables of the widget blueprint marked as Field Notify.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.

Retorna: widgetBlueprint, variables, message.

umg.list_fonts (risco 0, smoke)

Font assets under a content folder.

Argumento	Tipo	Descrição
folder	string	Content folder. Empty = /Game.
nameContains	string
limit	integer	Padrão 200.

Retorna: fonts, count.

umg.list_instances (risco 0, requer PIE, smoke)

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

Argumento	Tipo	Descrição
playerIndex	integer	Local player index of the PIE session. Default 0. Padrão 0.

Retorna: instances, count, message.

umg.list_named_slots (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name.

Retorna: slots, count.

umg.list_property_types (risco 0, smoke)

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

Argumento	Tipo	Descrição
nameContains	string	Optional type name filter ("brush", "color", "font").

Retorna: types, count.

umg.list_style_assets (risco 0, smoke)

Slate widget style assets under a content folder.

Argumento	Tipo	Descrição
folder	string	Content folder. Empty = /Game.
nameContains	string
limit	integer	Padrão 200.

Retorna: styles, count.

umg.list_style_classes (risco 0, smoke)

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

Argumento	Tipo	Descrição
folder	string	Content folder. Empty = /Game.
nameContains	string
limit	integer	Padrão 200.

Retorna: classes.

umg.list_variables (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.

Retorna: widgetBlueprint, variables, message.

umg.list_widget_classes (risco 0, smoke)

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

Argumento	Tipo	Descrição
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). Padrão false.
limit	integer	Maximum number of results (default 200). Padrão 0.

Retorna: classes, count.

umg.list_widget_delegates (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name. Empty lists the delegates of every widget of the tree.

Retorna: widget, class, delegates.

umg.list_widgets (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
classFilter	string	Only widgets of this class (or a subclass of it).
nameContains	string	Case-insensitive substring of the widget name.

Retorna: widgets, count.

umg.move_widget (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório. Widget to move.
newParent	string	New parent panel; empty = the root widget.
index	integer	Insertion index in the new parent, -1 appends. Padrão -1.
keepSlot	boolean	Copy the compatible slot values to the new slot (default true). Padrão true.
compile	boolean	Compile after the change (default true). Padrão true.

Retorna: widget.

umg.mvvm_add_binding (risco 2, altera, UE 5.5+, requer plugin ModelViewViewModel, smoke)

Binds a view model property to a widget property.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
viewModel	string	obrigatório. View model name inside the view (umg.mvvm_list_viewmodels).
viewModelProperty	string	obrigatório. Property of the view model to read.
widget	string	obrigatório. Widget of the tree to write to.
widgetProperty	string	obrigatório. Widget property to write ("Text", "Percent", "ToolTipText"...).
mode	string	oneWayToDestination (default), oneWayToSource, twoWay, oneTimeToDestination. Padrão TEXT("oneWayToDestination").
executionMode	string	Immediate, Delayed, Tick or DelayedWhenSharedElseImmediate. Empty keeps the default.
enabled	boolean	Padrão true.
compile	boolean	Padrão true.

Retorna: widgetBlueprint, bindings, compileErrors, message.

umg.mvvm_add_event (risco 2, altera, UE 5.5+, requer plugin ModelViewViewModel)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório. Widget whose delegate fires the event.
event	string	obrigatório. Delegate name ("OnClicked").
viewModel	string	obrigatório. View model name inside the view.
function	string	obrigatório. View model function to call.
compile	boolean	Padrão true.

Retorna: widgetBlueprint, bindings, compileErrors, message.

umg.mvvm_add_viewmodel (risco 2, altera, UE 5.5+, requer plugin ModelViewViewModel, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
viewModelClass	string	obrigatório. 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. Padrão 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. Padrão false.
compile	boolean	Padrão true.

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

umg.mvvm_add_viewmodel_property (risco 2, altera, UE 5.1+, requer plugin ModelViewViewModel, smoke)

Adds a Field Notify property to a view model blueprint.

Argumento	Tipo	Descrição
viewModel	string	obrigatório.
name	string	obrigatório.
type	string	obrigatório.
fieldNotify	boolean	Padrão true.
defaultValue	string
compile	boolean	Padrão true.

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

umg.mvvm_create_viewmodel (risco 2, altera, UE 5.1+, requer plugin ModelViewViewModel, smoke)

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

Argumento	Tipo	Descrição
folder	string	obrigatório.
name	string	obrigatório.
parentClass	string	Parent class. Empty = MVVMViewModelBase.
properties	array of UeaUmgMvvmPropertySpec

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

umg.mvvm_get_view (risco 0, UE 5.5+, requer plugin ModelViewViewModel, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.

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

umg.mvvm_get_viewmodel (risco 0, UE 5.1+, requer plugin ModelViewViewModel, smoke)

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

Argumento	Tipo	Descrição
viewModel	string	obrigatório. View model blueprint (path or unique name).

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

umg.mvvm_list_available_viewmodels (risco 0, UE 5.1+, requer plugin ModelViewViewModel, smoke)

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

Argumento	Tipo	Descrição
sourceType	string	Source type name filter ("float", "int", "Text"...).
destinationType	string	Destination type name filter.
nameContains	string
limit	integer	Padrão 100.

Retorna: viewModels, count, message.

umg.mvvm_list_bindings (risco 0, UE 5.5+, requer plugin ModelViewViewModel, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.

Retorna: widgetBlueprint, bindings, compileErrors, message.

umg.mvvm_list_conversion_functions (risco 0, UE 5.1+, requer plugin ModelViewViewModel, smoke)

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

Argumento	Tipo	Descrição
sourceType	string	Source type name filter ("float", "int", "Text"...).
destinationType	string	Destination type name filter.
nameContains	string
limit	integer	Padrão 100.

Retorna: functions, count.

umg.mvvm_list_viewmodels (risco 0, UE 5.5+, requer plugin ModelViewViewModel, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.

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

umg.mvvm_remove_binding (risco 3, altera, destrutivo, UE 5.5+, requer plugin ModelViewViewModel, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
index	integer	Binding index from umg.mvvm_list_bindings. -1 uses widget + widgetProperty. Padrão -1.
widget	string
widgetProperty	string
compile	boolean	Padrão true.

Retorna: widgetBlueprint, bindings, compileErrors, message.

umg.mvvm_remove_viewmodel (risco 3, altera, destrutivo, UE 5.5+, requer plugin ModelViewViewModel, smoke)

Removes a view model context from a widget blueprint.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
name	string	obrigatório. View model name inside the view.
compile	boolean	Padrão true.

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

umg.mvvm_rename_viewmodel (risco 2, altera, UE 5.5+, requer plugin ModelViewViewModel, smoke)

Renames a view model context of a widget blueprint.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
name	string	obrigatório.
newName	string	obrigatório.
compile	boolean	Padrão true.

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

umg.mvvm_set_binding (risco 2, altera, UE 5.5+, requer plugin ModelViewViewModel, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
index	integer	obrigatório.
mode	string	oneWayToDestination, oneWayToSource, twoWay, oneTimeToDestination. Empty keeps it.
enabled	boolean	Padrão true.
compileBinding	boolean	Padrão true.
compile	boolean	Padrão true.

Retorna: widgetBlueprint, bindings, compileErrors, message.

umg.mvvm_validate (risco 0, UE 5.5+, requer plugin ModelViewViewModel, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.

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

umg.play_animation (risco 0, requer PIE)

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

Argumento	Tipo	Descrição
id	string	obrigatório.
animation	string	obrigatório.
startTime	number	Start time in seconds. Padrão 0.0.
loops	integer	0 loops forever. Default 1. Padrão 1.
mode	string	forward, reverse, pingpong, pingpongreverse. Padrão TEXT("forward").
speed	number	Padrão 1.0.
restoreState	boolean	Restore the animated properties when the animation finishes. Padrão false.

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

umg.remove_all_widgets (risco 2, requer PIE, smoke)

Removes every user widget from the PIE viewport.

Argumento	Tipo	Descrição
playerIndex	integer	Local player index of the PIE session. Default 0. Padrão 0.

Retorna: instances, count, message.

umg.remove_binding (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
property	string	obrigatório.
deleteFunction	boolean	Also delete the generated binding function. Default false. Padrão false.
compile	boolean	Padrão true.

Retorna: widgetBlueprint, bindings, compileErrors, message.

umg.remove_instance (risco 1, requer PIE)

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

Argumento	Tipo	Descrição
id	string	obrigatório. Instance label from umg.create_instance (or a live widget's object/class name).

Retorna: instances, count, message.

umg.remove_override (risco 3, altera, destrutivo, smoke)

Removes an override event node from the blueprint.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
function	string	obrigatório.
compile	boolean	Padrão true.

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

umg.remove_widget (risco 3, altera, destrutivo, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório. Widget to remove.
keepChildren	boolean	Re-parent the children to the removed widget's parent instead of deleting them (default false). Padrão false.
compile	boolean	Compile after the change (default true). Padrão true.

Retorna: widgetBlueprint, compileErrors, applied, warnings.

umg.remove_widgets (risco 3, altera, destrutivo, smoke)

Removes several widgets in one transaction.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widgets	array of string	obrigatório. Widgets to remove.
keepChildren	boolean	Re-parent the children instead of deleting them. Padrão false.
compile	boolean	Compile after the change (default true). Padrão true.

Retorna: widgetBlueprint, compileErrors, applied, warnings.

umg.rename (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
newName	string	obrigatório. New asset name (no path).

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

umg.rename_widget (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório. Widget to rename.
newName	string	obrigatório. New name (must be unique in the tree).
compile	boolean	Compile after the change (default true). Padrão true.

Retorna: widget.

umg.render_to_png (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório. Widget blueprint to render.
file	string	obrigatório. Output file, relative to the project directory (e.g. "Saved/UeaSmoke/wbp.png").
width	integer	Padrão 512.
height	integer	Padrão 512.
scale	number	Render scale. Default 1. Padrão 1.0.
deltaTime	number	Delta time given to the widget before the capture (lets one construct/tick pass run). Padrão 0.0.

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

umg.render_widget_class (risco 0, smoke)

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

Argumento	Tipo	Descrição
class	string	obrigatório. UserWidget class: a widget blueprint path or a C++ class name.
file	string	obrigatório.
width	integer	Padrão 512.
height	integer	Padrão 512.
scale	number	Padrão 1.0.
deltaTime	number	Padrão 0.0.

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

umg.reorder_widget (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório. 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). Padrão true.

Retorna: widget.

umg.replace_widget (risco 3, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório. Widget to replace.
newClass	string	obrigatório. 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). Padrão true.
keepName	boolean	Keep the old widget's name for the replacement (default true). Padrão true.
compile	boolean	Compile after the change (default true). Padrão true.

Retorna: widget.

umg.replace_with_child (risco 3, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
compile	boolean	Compile after the change (default true). Padrão true.

Retorna: widget.

umg.replace_with_named_slot (risco 3, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório. 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). Padrão true.

Retorna: widget.

umg.reset_property (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
property	string	obrigatório. Property name or path ("Text", "Brush.ImageSize", "Slot.Padding").

Retorna: widget, class, values.

umg.satisfy_bind_widgets (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
parent	string	Parent panel the created widgets are added to. Empty = the root panel.
compile	boolean	Padrão true.

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

umg.save (risco 2, altera, smoke)

Saves the widget blueprint package to disk.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name.

Retorna: saved.

umg.screenshot_viewport (risco 1, requer PIE)

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

Argumento	Tipo	Descrição
file	string	obrigatório. Output file relative to the project directory.
showUi	boolean	Include the UI in the capture. Default true. Padrão true.

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

umg.select_option (risco 0, requer 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.

Argumento	Tipo	Descrição
id	string	obrigatório.
widget	string	obrigatório.
option	string	Option text. Use index when empty.
index	integer	Padrão -1.

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

umg.set_alignment (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
hAlign	string	Fill, Left, Center, Right.
vAlign	string	Fill, Top, Center, Bottom.

Retorna: widget, slotClass, fields, validFields.

umg.set_background_blur (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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

Retorna: widget, class, values.

umg.set_border (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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}.

Retorna: widget, class, values.

umg.set_box_slot (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
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.

Retorna: widget, slotClass, fields, validFields.

umg.set_brush (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
property	string	obrigatório. Brush property to write ("Brush", "Background", "WidgetStyle.Normal", ...).
brush	string	obrigatório. Brush as {texture

Retorna: widget, class, values.

umg.set_button (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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.

Retorna: widget, class, values.

umg.set_button_style (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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).

Retorna: widget, class, values.

umg.set_canvas_slot (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
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.

Retorna: widget, slotClass, fields, validFields.

umg.set_check (risco 0, requer PIE)

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

Argumento	Tipo	Descrição
id	string	obrigatório.
widget	string	obrigatório.
checked	boolean	Padrão true.

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

umg.set_check_box (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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.

Retorna: widget, class, values.

umg.set_circular_throbber (risco 2, altera, smoke)

CircularThrobber: number of pieces, period and radius.

Argumento	Tipo	Descrição
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).

Retorna: widget, class, values.

umg.set_class_defaults (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
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). Padrão 0.

Retorna: properties, count.

umg.set_class_settings (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
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.

Retorna: widgetBlueprint, compileErrors, applied, warnings.

umg.set_clipping (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
value	string	obrigatório. The value to set; meaning depends on the tool (see its description).

Retorna: widget.

umg.set_combo_box (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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}.

Retorna: widget, class, values.

umg.set_cursor (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
value	string	obrigatório. The value to set; meaning depends on the tool (see its description).

Retorna: widget.

umg.set_design_size (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
width	integer	Preview width in pixels. Padrão 0.
height	integer	Preview height in pixels. Padrão 0.
mode	string	Size mode: "custom" (use width/height), "desired" or "fillScreen".

Retorna: widgetBlueprint, compileErrors, applied, warnings.

umg.set_display_label (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
value	string	obrigatório. The value to set; meaning depends on the tool (see its description).

Retorna: widget.

umg.set_dynamic_entry_box (risco 2, altera, 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.

Argumento	Tipo	Descrição
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.

Retorna: widget, class, values.

umg.set_editable_text (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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}.

Retorna: widget, class, values.

umg.set_enabled (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
value	string	obrigatório. The value to set; meaning depends on the tool (see its description).

Retorna: widget.

umg.set_expandable_area (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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).

Retorna: widget, class, values.

umg.set_field_notify (risco 2, altera, UE 5.1+, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
variable	string	obrigatório.
enabled	boolean	Turn Field Notify on (default) or off. Padrão true.
compile	boolean	Padrão true.

Retorna: widgetBlueprint, variables, message.

umg.set_font (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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).

Retorna: widget, class, values.

umg.set_grid_panel (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
columnFills	array of UeaKeyValue	Column index -> fill weight ("0" -> "1").
rowFills	array of UeaKeyValue	Row index -> fill weight.

Retorna: widget, class, values.

umg.set_grid_slot (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
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

Retorna: widget, slotClass, fields, validFields.

umg.set_image (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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).

Retorna: widget, class, values.

umg.set_input_key_selector (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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.

Retorna: widget, class, values.

umg.set_input_mode (risco 0, requer PIE, smoke)

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

Argumento	Tipo	Descrição
mode	string	obrigatório. gameOnly, uiOnly or gameAndUi.
playerIndex	integer	Padrão 0.
showCursor	boolean	Padrão true.
id	string	Instance to focus (uiOnly / gameAndUi).
mouseLock	string	Mouse lock: doNotLock, lockOnCapture, lockAlways, lockInFullscreen. Padrão TEXT("doNotLock").

Retorna: target, handledDown, handledUp, message.

umg.set_instance_position (risco 0, requer PIE)

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

Argumento	Tipo	Descrição
id	string	obrigatório.
x	number	Padrão 0.0.
y	number	Padrão 0.0.
width	number	Desired size in the viewport. 0,0 leaves it unset. Padrão 0.0.
height	number	Padrão 0.0.
removeDpiScale	boolean	Remove the DPI scale from the position. Default true. Padrão true.

Retorna: instance, message.

umg.set_instance_property (risco 0, requer 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).

Argumento	Tipo	Descrição
id	string	obrigatório.
widget	string	Sub-widget of the instance. Empty = the instance itself.
property	string	obrigatório.
value	string	obrigatório. JSON value (see the umg conventions: colours, margins, brushes, fonts).

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

umg.set_instance_visibility (risco 0, requer PIE)

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

Argumento	Tipo	Descrição
id	string	obrigatório.
visibility	string	obrigatório. Visible, Collapsed, Hidden, HitTestInvisible, SelfHitTestInvisible.
widget	string	Sub-widget inside the instance. Empty = the instance itself.

Retorna: instance, message.

umg.set_invalidation_box (risco 2, altera, smoke)

InvalidationBox: caching on or off.

Argumento	Tipo	Descrição
canCache	string	obrigatório. "true"/"false": cache the children's geometry and draw elements.

Retorna: widget, class, values.

umg.set_is_variable (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
isVariable	boolean	True exposes the widget as a Blueprint variable of the generated class. Padrão true.
compile	boolean	Compile after the change (default true). Padrão true.

Retorna: widget.

umg.set_list_view (risco 2, altera)

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.

Argumento	Tipo	Descrição
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).

Retorna: widget, class, values.

umg.set_localized_text (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
namespace	string	obrigatório. Localization namespace.
key	string	obrigatório. Localization key.
source	string	obrigatório. Source (native language) string.
property	string	Text property to write (default "Text").

Retorna: widget, class, values.

umg.set_menu_anchor (risco 2, altera, smoke)

MenuAnchor: menu widget class, placement and window fitting.

Argumento	Tipo	Descrição
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.

Retorna: widget, class, values.

umg.set_multi_line_text (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
text	string
hintText	string
readOnly	string	"true"/"false".
justification	string	Left, Center, Right.
autoWrap	string	"true"/"false": auto-wrap the text.

Retorna: widget, class, values.

umg.set_named_slot_content (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
slot	string	obrigatório. 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). Padrão true.

Retorna: slot, content, contentClass.

umg.set_navigation (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
direction	string	obrigatório. up, down, left, right, next, previous, or "all" for every direction.
rule	string	obrigatório. escape, stop, wrap, explicit, custom, customBoundary.
target	string	Target widget name for the "explicit" rule.

Retorna: widget.

umg.set_padding (risco 2, altera, smoke)

Sets the padding of any slot class that has one.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
padding	string	obrigatório. Padding "{'left':8,'top':4,'right':8,'bottom':4}", "8,4" or a single number.

Retorna: widget, slotClass, fields, validFields.

umg.set_parent_class (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
parentClass	string	obrigatório. New parent class; must derive from UserWidget.

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

umg.set_progress_bar (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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.

Retorna: widget, class, values.

umg.set_properties (risco 2, altera, smoke)

Writes several properties of one widget in one call.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
properties	array of UeaKeyValue	obrigatório. Property name -> value pairs.
compile	boolean	Compile after the change (default false). Padrão false.

Retorna: widget, class, values.

umg.set_property (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
property	string	obrigatório. Property name or path.
value	string	obrigatório. 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). Padrão false.

Retorna: widget, class, values.

umg.set_property_on_all (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
classFilter	string	obrigatório. Only widgets of this class (or a subclass).
property	string	obrigatório. Property name or path.
value	string	obrigatório. New value.

Retorna: widgets, count.

umg.set_render_opacity (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
value	string	obrigatório. The value to set; meaning depends on the tool (see its description).

Retorna: widget.

umg.set_render_transform (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
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}".

Retorna: widget.

umg.set_retainer_box (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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.

Retorna: widget, class, values.

umg.set_rich_text (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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.

Retorna: widget, class, values.

umg.set_root (risco 3, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
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). Padrão true.
compile	boolean	Compile after the change (default true). Padrão true.

Retorna: widget.

umg.set_safe_zone (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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.

Retorna: widget, class, values.

umg.set_scale_box (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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".

Retorna: widget, class, values.

umg.set_scroll_box (risco 2, altera, smoke)

ScrollBox: orientation, scroll bar look and scrolling behaviour.

Argumento	Tipo	Descrição
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}.

Retorna: widget, class, values.

umg.set_size_box (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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.

Retorna: widget, class, values.

umg.set_slider (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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}.

Retorna: widget, class, values.

umg.set_slider_value (risco 0, requer 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.

Argumento	Tipo	Descrição
id	string	obrigatório.
widget	string	obrigatório.
value	number	obrigatório.

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

umg.set_slot (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
fields	array of UeaKeyValue	Slot field assignments ("Padding" -> "8", "HorizontalAlignment" -> "Fill", "LayoutData.Anchors" -> "center").

Retorna: widget, slotClass, fields, validFields.

umg.set_spacer (risco 2, altera, smoke)

Spacer: fixed size.

Argumento	Tipo	Descrição
size	string	obrigatório. Size {x,y} in pixels.

Retorna: widget, class, values.

umg.set_spin_box (risco 2, altera, smoke)

SpinBox: value, ranges, delta and fractional digits.

Argumento	Tipo	Descrição
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}.

Retorna: widget, class, values.

umg.set_style_asset_property (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
style	string	obrigatório.
properties	array of UeaKeyValue	obrigatório. Property paths inside the style struct and their JSON values.

Retorna: style, properties, warnings, message.

umg.set_switcher (risco 0, requer PIE)

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

Argumento	Tipo	Descrição
id	string	obrigatório.
widget	string	obrigatório.
index	integer	obrigatório.

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

umg.set_switcher_index (risco 2, altera, smoke)

WidgetSwitcher: active child by index or by widget name.

Argumento	Tipo	Descrição
index	string	Index of the child to show.
activeWidget	string	Name of the child widget to show (overrides index).

Retorna: widget, class, values.

umg.set_text (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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).

Retorna: widget, class, values.

umg.set_text_input (risco 0, requer 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.

Argumento	Tipo	Descrição
id	string	obrigatório.
widget	string	obrigatório.
text	string	obrigatório.
commit	boolean	Fire OnTextCommitted (OnCommit) after setting the text. Default true. Padrão true.

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

umg.set_text_style_everywhere (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
font	string	Font asset path. Empty keeps the current font object.
size	integer	Font size in points. 0 keeps the current size. Padrão 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	Padrão true.

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

umg.set_throbber (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
pieces	string	Number of pieces.
animateHorizontally	string	"true"/"false".
animateVertically	string	"true"/"false".
animateOpacity	string	"true"/"false".
image	string	Piece image brush (5.x).

Retorna: widget, class, values.

umg.set_tooltip (risco 2, altera, smoke)

Sets the tooltip text of a widget.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
value	string	obrigatório. The value to set; meaning depends on the tool (see its description).

Retorna: widget.

umg.set_ui_settings (risco 4, altera)

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

Argumento	Tipo	Descrição
properties	array of UeaKeyValue	obrigatório. Properties of UUserInterfaceSettings to write ("ApplicationScale", "UIScaleRule", "RenderFocusRule"...).
saveConfig	boolean	Save to DefaultEngine.ini. Default true. Padrão true.

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

umg.set_uniform_grid (risco 2, altera, smoke)

UniformGridPanel: cell padding and minimum cell size.

Argumento	Tipo	Descrição
slotPadding	string	Padding of every cell {left,top,right,bottom}.
minSlotWidth	string
minSlotHeight	string

Retorna: widget, class, values.

umg.set_visibility (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
value	string	obrigatório. The value to set; meaning depends on the tool (see its description).

Retorna: widget.

umg.set_widget_color (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
color	string	obrigatório. 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".

Retorna: widget, class, values.

umg.set_widget_navigation_rules (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
up	string	Rule for the up direction (escape, stop, wrap, explicit:WidgetName).
down	string
left	string
right	string
next	string
previous	string

Retorna: widget.

umg.set_widget_style (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
style	string	obrigatório. JSON object written into the widget's style struct ("{'Normal':{'texture':'...'},'NormalPadding':4}").
property	string	Style property name (default "WidgetStyle").

Retorna: widget, class, values.

umg.set_widget_texts (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
texts	array of UeaKeyValue	obrigatório. Widget name -> text. Widgets without a text property are reported in warnings.

Retorna: widgets, count.

umg.set_wrap_box (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
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).

Retorna: widget, class, values.

umg.simulate_click_at (risco 2, requer PIE)

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

Argumento	Tipo	Descrição
x	number	obrigatório. Absolute screen X.
y	number	obrigatório. Absolute screen Y.
button	string	LeftMouseButton (default), RightMouseButton, MiddleMouseButton. Padrão TEXT("LeftMouseButton").

Retorna: target, handledDown, handledUp, message.

umg.simulate_key (risco 1, requer PIE, smoke)

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

Argumento	Tipo	Descrição
key	string	obrigatório. FKey name: SpaceBar, Enter, Escape, Gamepad_FaceButton_Bottom...
event	string	press, release or tap (default). Padrão TEXT("tap").
control	boolean	Padrão false.
alt	boolean	Padrão false.
shift	boolean	Padrão false.

Retorna: target, handledDown, handledUp, message.

umg.stop_animation (risco 0, requer 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).

Argumento	Tipo	Descrição
id	string	obrigatório.
animation	string	Animation name. Empty stops every animation (umg.stop_animation).

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

umg.unbind_event (risco 3, altera, destrutivo, smoke)

Removes the bound event node of a widget delegate.

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	obrigatório.
event	string	obrigatório. Delegate name: OnClicked, OnHovered, OnValueChanged, OnTextCommitted, OnCheckStateChanged...
compile	boolean	Padrão true.

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

umg.unwrap_widget (risco 3, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
widget	string	Widget name (empty = the root widget).
compile	boolean	Compile after the change (default true). Padrão true.

Retorna: widget.

umg.validate (risco 0, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name.

Retorna: issues, notes, valid.

umg.wrap_widget (risco 2, altera, smoke)

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

Argumento	Tipo	Descrição
widgetBlueprint	string	obrigatório.
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	obrigatório. Panel class that becomes their new parent ("SizeBox", "Border", "VerticalBox", ...).
name	string	Name of the wrapper.
compile	boolean	Compile after the change (default true). Padrão true.

Retorna: widget.