Kit umg
252 herramientas. Generado a partir del código fuente del plugin; no lo edites a mano.
Las descripciones de las herramientas y de los argumentos se muestran en inglés porque reflejan el schema de las herramientas (el mismo texto que el agente recibe en
tools/list).
Guía
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
umg.create{folder:"/Game/UI", name:"WBP_Menu", rootWidget:"CanvasPanel"}umg.get_tree{widgetBlueprint:"WBP_Menu"}— always read the tree before editing it.umg.add_widgetsto add several widgets in one transaction.umg.set_canvas_slot/umg.set_box_slotfor layout,umg.set_text/umg.set_imagefor content.umg.compile(most mutating tools compile by default; passcompile:falseto batch first).
Recipe: fade a panel in
umg.anim_create{widgetBlueprint:"WBP_Menu", name:"Anim_Intro", length:0.5}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, theRenderOpacitytrack, the section and both keys.umg.anim_get{widgetBlueprint:"WBP_Menu", animation:"Anim_Intro"}to check the range and the key count.- At runtime:
umg.create_instancethenumg.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
umg.add_variable{widgetBlueprint:"WBP_HUD", name:"Health", type:"float", defaultValue:"1.0"}umg.add_property_binding{widgetBlueprint:"WBP_HUD", widget:"Bar_Health", property:"Percent", variable:"Health"}— binds the widget property straight to the blueprint variable.- Without
variable, the same call creates a pure functionGet_<Widget>_<Property>with the right return type and binds to it; fill its graph with thebpkit. umg.list_bindingsreports 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
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.umg.add_dispatcher{widgetBlueprint:"WBP_Menu", name:"OnPlayPressed"}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.umg.add_override{widgetBlueprint:"WBP_Menu", function:"PreConstruct"}for construct/tick/input overrides.
Recipe: styles and theming
umg.list_style_classes→umg.create_style_asset{folder:"/Game/UI", name:"Style_Button", styleClass:"Button"}umg.set_style_asset_property{style:"Style_Button", properties:[{key:"NormalPadding", value:"8"}]}(a single number fills all four margin sides).umg.apply_style_asset{widgetBlueprint:"WBP_Menu", widget:"Btn_Play", style:"Style_Button"}copies the Slate struct into the widget'sWidgetStyle.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_everywheredoes fonts.- Fonts:
umg.create_font{folder, name, fromFont:"/Engine/EngineFonts/Roboto"}(orumg.import_font_facewith a.ttfon disk, thenumg.create_fontwithfontFace).
Recipe: a Common UI screen (5.0+, plugin CommonUI)
umg.cui_create_button_styleandumg.cui_create_text_style(they create blueprints ofUCommonButtonStyle/UCommonTextStyle;umg.cui_set_style_propertyedits their class defaults).umg.cui_create_activatable_widget{folder, name:"WBP_Settings", properties:[{key:"bAutoActivate", value:"true"}]}umg.cui_add_button{widgetBlueprint:"WBP_Settings", name:"Btn_Apply", style:"CBS_Main"}—UCommonButtonBaseis abstract, so the tool generates a concreteWBP_<Host>_<Name>blueprint for it and reports it ingeneratedClass(passwidgetClassto use your own).umg.cui_add_stack/umg.cui_add_switcher/umg.cui_add_tab_listfor navigation containers.umg.cui_create_input_action_table+umg.cui_add_input_actionfor the action data table.umg.cui_validateflags buttons without a style and activatable screens without a back handler.
Recipe: MVVM health binding (5.1+ / 5.5+, plugin ModelViewViewModel)
umg.mvvm_create_viewmodel{folder, name:"VM_Player", properties:[{name:"Health", type:"float", fieldNotify:true}]}umg.mvvm_add_viewmodel{widgetBlueprint:"WBP_HUD", viewModelClass:"VM_Player", name:"PlayerVM", creationType:"createInstance"}umg.mvvm_add_binding{widgetBlueprint:"WBP_HUD", viewModel:"PlayerVM", viewModelProperty:"Health", widget:"Bar_Health", widgetProperty:"Percent", mode:"oneWayToDestination"}umg.mvvm_list_bindings/umg.mvvm_validateto 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
- Start PIE (
edit.playin the edit kit), thenumg.create_instance{widgetBlueprint:"WBP_Menu", name:"Menu", addToViewport:true}—namebecomes theidevery other runtime tool takes. umg.get_instance_tree{id:"Menu"}to see the live widget names.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.umg.get_widget_geometry{id:"Menu", widget:"Btn_Play"}for the absolute screen rect (only after one frame has been rendered).umg.set_input_mode{mode:"uiOnly", id:"Menu"}before sendingumg.simulate_key.umg.remove_instance/umg.remove_all_widgetswhen 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, passcompile:falseand finish withumg.compile. - The widget must be a variable for
umg.bind_eventto work; the tool setsbIsVariableand 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_createnames both the object and the designer label;umg.anim_listshows both. - New animations default to 20 fps on 4.27 (hardcoded by the UMG editor) and to
UMGEditorProjectSettings::DefaultWidgetAnimationFrameRateon 5.x (also 20 by default). PassdisplayRateto 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 passslot:truetoumg.anim_add_binding(the track tools do it for you). - Plugin gating.
umg.cui_*needsCommonUIenabled and 5.0+;umg.mvvm_*needsModelViewViewModel. Tools of a missing plugin are hidden fromtools/listand refused bytools/callwith the plugin name, they never fail silently. - 4.27 differences: no Common UI, no MVVM, no
UStackBox/UDynamicEntryBox, no Field Notify.umg.set_field_notifyandumg.list_field_notifycarryMinEngine 5.1. - Config writers (
umg.set_ui_settings,umg.cui_set_input_settings) writeDefaultEngine.iniand areRisk 4: they need_confirmunlessMaxAutoRiskallows them. umg.batch_*tools honourdryRun— always do a dry run first on a real project; they walk every widget blueprint under a folder.umg.anim_importtakes the JSON produced byumg.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_testskips{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) areSmokeSkip. Drive them by hand: create a widget blueprint, start PIE,umg.create_instance, then call them.umg.create_instancealso accepts a plain UserWidget class name, which is what the self-test uses.
Herramientas
Leyenda. riesgo 0 = solo lectura, 1 = operación inofensiva del editor, 2 = modifica un asset, 3 = elimina/reemplaza un asset, 4 = proyecto/configuración/build, 5 = potencialmente destructivo (las llamadas por encima de
MaxAutoRiskrequieren"_confirm": true). modifica = se ejecuta en una transacción (edit.undo la revierte). requiere PIE / requiere mundo = se rechaza sin una sesión PIE / sin un nivel abierto. requiere el plugin = no disponible cuando el plugin está desactivado. dryRun = acepta el argumentodryRun. smoke = cubierto poredit.self_test.
umg.add_dispatcher (riesgo 2, modifica, smoke)
Adds an event dispatcher (multicast delegate) to the widget blueprint, for menu -> game communication.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
name | string | obligatorio. |
params | array of UeaUmgDispatcherParam | |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, variables, message.
umg.add_override (riesgo 2, modifica, smoke)
Adds a UserWidget override event node (PreConstruct, Construct, Tick, Destruct, OnKeyDown...).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
function | string | obligatorio. PreConstruct, Construct, Tick, Destruct, OnMouseButtonDown, OnKeyDown, OnDrop, OnDragDetected... |
graph | string | Event graph name. Empty = the main EventGraph. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 0. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, node, existing, boundEvents, compileErrors, message.
umg.add_property_binding (riesgo 2, modifica, smoke)
Binds a widget property to a blueprint variable, or to a pure function created with the right return type.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
property | string | obligatorio. 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. Valor predeterminado true. |
Devuelve: widgetBlueprint, bindings, compileErrors, message.
umg.add_rich_image (riesgo 2, modifica, smoke)
Adds or replaces an image row in a rich image table.
| Argumento | Tipo | Descripción |
|---|---|---|
table | string | obligatorio. Data table asset. |
row | string | obligatorio. Row name (the style name used in |
properties | array of UeaKeyValue | Field paths of the row struct and their JSON values ("TextStyle.Font.Size" -> "18"). |
Devuelve: table, rowStruct, rows, warnings, message.
umg.add_rich_text_style (riesgo 2, modifica, smoke)
Adds or replaces a style row in a rich text style table.
| Argumento | Tipo | Descripción |
|---|---|---|
table | string | obligatorio. Data table asset. |
row | string | obligatorio. Row name (the style name used in |
properties | array of UeaKeyValue | Field paths of the row struct and their JSON values ("TextStyle.Font.Size" -> "18"). |
Devuelve: table, rowStruct, rows, warnings, message.
umg.add_typeface (riesgo 2, modifica)
Adds a typeface entry (name + font face) to a runtime font. SmokeSkip: needs an imported font face.
| Argumento | Tipo | Descripción |
|---|---|---|
font | string | obligatorio. |
name | string | obligatorio. |
fontFace | string | obligatorio. Font face asset for this typeface entry. |
Devuelve: font, typefaces, message.
umg.add_user_widget (riesgo 2, modifica, smoke)
Instances another widget blueprint inside the tree (a user widget child).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
userWidget | string | obligatorio. 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. Valor predeterminado -1. |
compile | boolean | Compile after the change (default true). Valor predeterminado true. |
Devuelve: widget.
umg.add_variable (riesgo 2, modifica, smoke)
Adds a variable to a widget blueprint (optionally Field Notify for MVVM).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
name | string | obligatorio. |
type | string | obligatorio. 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 | Valor predeterminado false. |
exposeOnSpawn | boolean | Valor predeterminado false. |
fieldNotify | boolean | Mark as Field Notify (MVVM), 5.1+. Valor predeterminado false. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, variables, message.
umg.add_widget (riesgo 2, modifica, 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 | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
class | string | obligatorio. 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. Valor predeterminado -1. |
isVariable | boolean | Expose the widget as a Blueprint variable (default true, like the designer). Valor predeterminado 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). Valor predeterminado true. |
Devuelve: widget.
umg.add_widgets (riesgo 2, modifica, 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 | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widgets | array of UeaUmgWidgetSpec | obligatorio. Widgets to create, in order; each may parent to one created earlier in the list. |
compile | boolean | Compile once at the end (default true). Valor predeterminado true. |
Devuelve: widgets, count.
umg.anim_add_binding (riesgo 2, modifica, smoke)
Binds a widget (or its slot) to the animation, creating the possessable the tracks hang from.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. |
widget | string | obligatorio. |
slot | boolean | Bind the widget's slot (for Slot.* properties) instead of the widget itself. Valor predeterminado false. |
Devuelve: widgetBlueprint, animation, bindings, tracks, compileErrors, message.
umg.anim_add_key (riesgo 2, modifica, smoke)
Adds or replaces a key at Time, creating the binding, track and section on demand.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. |
widget | string | obligatorio. |
property | string | obligatorio. |
time | number | obligatorio. Time in seconds. |
value | string | obligatorio. 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". Valor predeterminado TEXT("cubic"). |
Devuelve: animation, widget, property, kind, keys, message.
umg.anim_add_keys (riesgo 2, modifica, smoke)
Adds several keys to one track in a single call.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. |
widget | string | obligatorio. |
property | string | obligatorio. |
keys | array of UeaUmgAnimKeyEntry | obligatorio. |
Devuelve: animation, widget, property, kind, keys, message.
umg.anim_add_track (riesgo 2, modifica, smoke)
Adds a property track (track type chosen from the property type) and its section.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. |
widget | string | obligatorio. |
property | string | obligatorio. Property path: "RenderOpacity", "ColorAndOpacity", "Visibility", "RenderTransform", "Slot.Offsets"... |
Devuelve: animation, tracks, message.
umg.anim_clear_keys (riesgo 3, modifica, destructivo, smoke)
Removes every key of a track, keeping the track and its section.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. |
widget | string | obligatorio. |
property | string | obligatorio. Property path: "RenderOpacity", "ColorAndOpacity", "Visibility", "RenderTransform", "Slot.Offsets"... |
Devuelve: animation, widget, property, kind, keys, message.
umg.anim_color (riesgo 2, modifica, smoke)
Colour animation between two {r,g,b,a} values on the widget's colour property.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. Widget to animate. |
animation | string | obligatorio. 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. Valor predeterminado 0.3. |
startTime | number | Start time in seconds. Default 0. Valor predeterminado 0.0. |
interp | string | "cubic" (default), "linear" or "constant". Valor predeterminado TEXT("cubic"). |
Devuelve: widgetBlueprint, animation, bindings, tracks, compileErrors, message.
umg.anim_create (riesgo 2, modifica, smoke)
Creates a widget animation (movie scene + playback range) on the blueprint. Length is in seconds.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
name | string | obligatorio. |
length | number | Length in seconds. Default 5. Valor predeterminado 5.0. |
displayRate | number | Editor display rate in fps. 0 = the engine default (20 on 4.27, project setting on 5.x). Valor predeterminado 0.0. |
Devuelve: widgetBlueprint, animation, bindings, tracks, compileErrors, message.
umg.anim_duplicate (riesgo 2, modifica, smoke)
Duplicates an animation with all its bindings, tracks and keys.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. |
newName | string | Name of the copy. Empty appends "_Copy". |
Devuelve: widgetBlueprint, animation, bindings, tracks, compileErrors, message.
umg.anim_export (riesgo 0, smoke)
Exports an animation (bindings, tracks and keys) as JSON.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. Animation object name or display label. Empty picks the only animation of the blueprint. |
Devuelve: animation, json.
umg.anim_fade (riesgo 2, modifica, smoke)
Opacity animation from From to To over Duration seconds (RenderOpacity track).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. Widget to animate. |
animation | string | obligatorio. 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. Valor predeterminado 0.3. |
startTime | number | Start time in seconds. Default 0. Valor predeterminado 0.0. |
interp | string | "cubic" (default), "linear" or "constant". Valor predeterminado TEXT("cubic"). |
Devuelve: widgetBlueprint, animation, bindings, tracks, compileErrors, message.
umg.anim_get (riesgo 0, smoke)
Full description of one animation: range, display rate, bindings and every track with its key count.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. Animation object name or display label. Empty picks the only animation of the blueprint. |
Devuelve: widgetBlueprint, animation, bindings, tracks, compileErrors, message.
umg.anim_get_keys (riesgo 0, smoke)
Keys of a track: time, channel, value and interpolation.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. |
widget | string | obligatorio. |
property | string | obligatorio. Property path: "RenderOpacity", "ColorAndOpacity", "Visibility", "RenderTransform", "Slot.Offsets"... |
Devuelve: animation, widget, property, kind, keys, message.
umg.anim_import (riesgo 2, modifica)
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 | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. Animation name to create or overwrite. |
json | string | obligatorio. JSON from umg.anim_export. |
replace | boolean | Remove the existing tracks of the animation first. Default true. Valor predeterminado true. |
Devuelve: widgetBlueprint, animation, bindings, tracks, compileErrors, message.
umg.anim_list (riesgo 0, smoke)
Animations of a widget blueprint with their range, display rate, binding and track counts.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. Widget blueprint: object path, package path or unique asset name. |
Devuelve: widgetBlueprint, animations.
umg.anim_list_properties (riesgo 0, smoke)
Property paths of a widget (and its slot) that can be animated.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
Devuelve: widget, class, properties.
umg.anim_list_tracks (riesgo 0, smoke)
Tracks of an animation with their widget, property, kind, channel and key counts.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. Animation object name or display label. Empty picks the only animation of the blueprint. |
Devuelve: animation, tracks, message.
umg.anim_pulse (riesgo 2, modifica, smoke)
Opacity pulse (From -> To -> From) meant to be played looping.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. Widget to animate. |
animation | string | obligatorio. 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. Valor predeterminado 0.3. |
startTime | number | Start time in seconds. Default 0. Valor predeterminado 0.0. |
interp | string | "cubic" (default), "linear" or "constant". Valor predeterminado TEXT("cubic"). |
Devuelve: widgetBlueprint, animation, bindings, tracks, compileErrors, message.
umg.anim_remove (riesgo 3, modifica, destructivo, smoke)
Removes an animation from the widget blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. Animation object name or display label. Empty picks the only animation of the blueprint. |
Devuelve: widgetBlueprint, animations.
umg.anim_remove_binding (riesgo 3, modifica, destructivo, smoke)
Removes a widget binding and every track attached to it.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. |
widget | string | obligatorio. |
slot | boolean | Bind the widget's slot (for Slot.* properties) instead of the widget itself. Valor predeterminado false. |
Devuelve: widgetBlueprint, animation, bindings, tracks, compileErrors, message.
umg.anim_remove_key (riesgo 2, modifica, smoke)
Removes the key at Time (on one channel or on all of them).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. |
widget | string | obligatorio. |
property | string | obligatorio. |
time | number | obligatorio. 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. Valor predeterminado -1. |
Devuelve: animation, widget, property, kind, keys, message.
umg.anim_remove_track (riesgo 3, modifica, destructivo, smoke)
Removes a property track from an animation.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. |
widget | string | obligatorio. |
property | string | obligatorio. Property path: "RenderOpacity", "ColorAndOpacity", "Visibility", "RenderTransform", "Slot.Offsets"... |
Devuelve: animation, tracks, message.
umg.anim_rename (riesgo 2, modifica, smoke)
Renames an animation (object name and designer display label).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. |
newName | string | obligatorio. |
Devuelve: widgetBlueprint, animation, bindings, tracks, compileErrors, message.
umg.anim_scale (riesgo 2, modifica, smoke)
Uniform scale animation between two factors (RenderTransform.Scale track).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. Widget to animate. |
animation | string | obligatorio. 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. Valor predeterminado 0.3. |
startTime | number | Start time in seconds. Default 0. Valor predeterminado 0.0. |
interp | string | "cubic" (default), "linear" or "constant". Valor predeterminado TEXT("cubic"). |
Devuelve: widgetBlueprint, animation, bindings, tracks, compileErrors, message.
umg.anim_set_display_rate (riesgo 2, modifica, smoke)
Sets the editor display rate (fps) of an animation.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. |
displayRate | number | obligatorio. Frames per second shown in the Sequencer timeline. |
Devuelve: widgetBlueprint, animation, bindings, tracks, compileErrors, message.
umg.anim_set_key (riesgo 2, modifica, smoke)
Replaces the value (and interpolation) of the key at Time. Fails when there is no key there.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. |
widget | string | obligatorio. |
property | string | obligatorio. |
time | number | obligatorio. Time in seconds. |
value | string | obligatorio. 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". Valor predeterminado TEXT("cubic"). |
Devuelve: animation, widget, property, kind, keys, message.
umg.anim_set_range (riesgo 2, modifica, smoke)
Sets the playback range of an animation in seconds.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
animation | string | obligatorio. |
start | number | Start in seconds. Valor predeterminado 0.0. |
end | number | obligatorio. End in seconds. |
Devuelve: widgetBlueprint, animation, bindings, tracks, compileErrors, message.
umg.anim_slide (riesgo 2, modifica, smoke)
Translation animation between two {x,y} offsets (RenderTransform.Translation track).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. Widget to animate. |
animation | string | obligatorio. 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. Valor predeterminado 0.3. |
startTime | number | Start time in seconds. Default 0. Valor predeterminado 0.0. |
interp | string | "cubic" (default), "linear" or "constant". Valor predeterminado TEXT("cubic"). |
Devuelve: widgetBlueprint, animation, bindings, tracks, compileErrors, message.
umg.apply_style_asset (riesgo 2, modifica, smoke)
Copies a style asset's struct into a widget's style property (WidgetStyle by default).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
style | string | obligatorio. |
property | string | Style property of the widget. Empty = WidgetStyle. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, applied, warnings, compileErrors, message.
umg.apply_theme (riesgo 2, modifica, smoke)
Applies a colour theme (buttons, progress bars, borders, texts) to a whole widget blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
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. Valor predeterminado 0. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, applied, warnings, compileErrors, message.
umg.audit (riesgo 0, smoke)
Audits every widget blueprint of a folder: widget count, depth, animations, bindings, compile status, missing references.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to walk (recursive). Empty = /Game. |
nameContains | string | Only widget blueprints whose name contains this text. |
limit | integer | Valor predeterminado 200. |
Devuelve: folder, blueprints, count, totalWidgets, totalIssues, message.
umg.batch_compile (riesgo 2, modifica, smoke)
Compiles every widget blueprint of a folder and reports the errors per asset.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to walk (recursive). Empty = /Game. |
nameContains | string | Only widget blueprints whose name contains this text. |
limit | integer | Valor predeterminado 200. |
Devuelve: folder, results, blueprintsTouched, totalChanges, warnings, dryRun, message.
umg.batch_rename_widgets (riesgo 2, modifica, dryRun, smoke)
Renames widgets whose name contains a pattern, across every widget blueprint of a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | |
pattern | string | obligatorio. Substring to look for in widget names. |
replace | string | obligatorio. Replacement text. |
dryRun | boolean | Valor predeterminado false. |
compile | boolean | Valor predeterminado true. |
Devuelve: folder, results, blueprintsTouched, totalChanges, warnings, dryRun, message.
umg.batch_replace_class (riesgo 3, modifica, dryRun, smoke)
Replaces every widget of one class with another class, keeping names, slots and shared properties.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | |
fromClass | string | obligatorio. Widget class to replace ("TextBlock"). |
toClass | string | obligatorio. Replacement widget class ("RichTextBlock"). |
copyProperties | boolean | Copy the properties both classes share. Default true. Valor predeterminado true. |
dryRun | boolean | Valor predeterminado false. |
compile | boolean | Valor predeterminado true. |
Devuelve: folder, results, blueprintsTouched, totalChanges, warnings, dryRun, message.
umg.batch_replace_texture (riesgo 2, modifica, dryRun, smoke)
Replaces every reference to an asset (texture, material, font) with another one across a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | |
from | string | obligatorio. Asset currently referenced (texture, material, font...). |
to | string | obligatorio. Replacement asset. |
dryRun | boolean | Valor predeterminado false. |
compile | boolean | Valor predeterminado true. |
Devuelve: folder, results, blueprintsTouched, totalChanges, warnings, dryRun, message.
umg.batch_set_font (riesgo 2, modifica, dryRun, smoke)
Applies one font (asset, size and typeface) to every matching text widget of a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
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. Valor predeterminado 0. |
typeface | string | Typeface name. Empty keeps it. |
classFilter | string | Widget class filter. Default TextBlock. Valor predeterminado TEXT("TextBlock"). |
dryRun | boolean | Valor predeterminado false. |
compile | boolean | Valor predeterminado true. |
Devuelve: folder, results, blueprintsTouched, totalChanges, warnings, dryRun, message.
umg.batch_set_properties (riesgo 2, modifica, smoke)
Writes properties on several widgets of the same blueprint in one transaction.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
items | array of UeaUmgBatchItem | obligatorio. One entry per widget. |
compile | boolean | Compile once at the end (default false). Valor predeterminado false. |
Devuelve: widgets, count.
umg.batch_set_property (riesgo 2, modifica, dryRun, smoke)
Writes one property on every widget of a class across a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | |
classFilter | string | obligatorio. Widget class the property is written on. |
property | string | obligatorio. |
value | string | obligatorio. JSON value (see the umg conventions). |
dryRun | boolean | Valor predeterminado false. |
compile | boolean | Valor predeterminado true. |
Devuelve: folder, results, blueprintsTouched, totalChanges, warnings, dryRun, message.
umg.bind_event (riesgo 2, modifica, smoke)
Creates the bound event node for a widget delegate in the event graph (exposes the widget as a variable).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
event | string | obligatorio. Delegate name: OnClicked, OnHovered, OnValueChanged, OnTextCommitted, OnCheckStateChanged... |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, node, existing, boundEvents, compileErrors, message.
umg.call_dispatcher_on_event (riesgo 2, modifica, smoke)
Binds a widget delegate and wires a Call
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
event | string | obligatorio. Widget delegate to bind (OnClicked...). |
dispatcher | string | obligatorio. Event dispatcher of the widget blueprint to call. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, node, existing, boundEvents, compileErrors, message.
umg.clear_tree (riesgo 5, modifica, destructivo, smoke)
Deletes every widget of the tree, optionally creating a fresh root panel.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
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). Valor predeterminado true. |
Devuelve: widgetBlueprint, compileErrors, applied, warnings.
umg.click_button (riesgo 0, requiere 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 | Descripción |
|---|---|---|
id | string | obligatorio. |
widget | string | obligatorio. Sub-widget inside the instance. |
Devuelve: id, widget, class, value, message.
umg.compile (riesgo 2, modifica, smoke)
Compiles the widget blueprint and returns errors, warnings and the resulting status.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
save | boolean | Save the asset after a successful compile (default false). Valor predeterminado false. |
Devuelve: compileWarnings, status.
umg.copy_properties (riesgo 2, modifica, smoke)
Copies properties from one widget to others (empty list = every editable property they share).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
from | string | obligatorio. Source widget. |
to | array of string | obligatorio. Destination widgets. |
properties | array of string | Property names to copy; empty copies every editable property the classes share. |
Devuelve: widgets, count.
umg.create (riesgo 2, modifica, 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 | Descripción |
|---|---|---|
folder | string | obligatorio. Destination content folder ("/Game/UI"). |
name | string | obligatorio. 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). Valor predeterminado 0. |
designHeight | integer | Designer preview height in pixels (0 = engine default). Valor predeterminado 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). |
Devuelve: name, parentClass, rootWidget, rootWidgetClass, widgetCount, createdWidgets.
umg.create_font (riesgo 2, modifica, smoke)
Creates a runtime UFont, copying an existing font's composite font or using a font face asset.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
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". Valor predeterminado TEXT("Default"). |
size | integer | Legacy font size stored on the asset. Default 24. Valor predeterminado 24. |
Devuelve: font, typefaces, message.
umg.create_from_template (riesgo 2, modifica, 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 | Descripción |
|---|---|---|
folder | string | obligatorio. Destination content folder. |
name | string | obligatorio. Asset name. |
template | string | obligatorio. One of: hud, mainMenu, pauseMenu, dialog, inventoryGrid, healthBar, loadingScreen, settingsList. |
parentClass | string | Parent class (default "UserWidget"). |
Devuelve: widgets, template.
umg.create_instance (riesgo 0, requiere 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 | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. 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 | Valor predeterminado 0. |
addToViewport | boolean | Add it to the player viewport. Default true. Valor predeterminado true. |
zOrder | integer | Valor predeterminado 0. |
Devuelve: instance, message.
umg.create_rich_image_table (riesgo 2, modifica, smoke)
Creates a data table of FRichImageRow for a Rich Text Block image decorator.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
Devuelve: table, rowStruct, rows, warnings, message.
umg.create_rich_text_style_table (riesgo 2, modifica, smoke)
Creates a data table of FRichTextStyleRow for a Rich Text Block's style set.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
Devuelve: table, rowStruct, rows, warnings, message.
umg.create_style_asset (riesgo 2, modifica, smoke)
Creates a Slate widget style asset (USlateWidgetStyleAsset + its style container).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Destination content folder, e.g. "/Game/UI/Styles". |
name | string | obligatorio. |
styleClass | string | obligatorio. 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}"). |
Devuelve: style, properties, warnings, message.
umg.cui_add_button (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Adds a Common UI button to a widget tree (generating a CommonButtonBase blueprint when no class is given).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
name | string | obligatorio. |
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 | Valor predeterminado true. |
Devuelve: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.
umg.cui_add_input_action (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Adds or replaces a row in a Common UI input action table.
| Argumento | Tipo | Descripción |
|---|---|---|
table | string | obligatorio. |
row | string | obligatorio. |
properties | array of UeaKeyValue | Row fields ("DisplayName", "KeyboardInputTypeInfo.Key", "bActionRequiresHold"...). |
Devuelve: table, rowStruct, rows, warnings, message.
umg.cui_add_stack (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Adds a CommonActivatableWidgetStack (push/pop screen container) to a widget tree.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
name | string | obligatorio. |
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 | Valor predeterminado true. |
Devuelve: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.
umg.cui_add_switcher (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Adds a CommonActivatableWidgetSwitcher to a widget tree.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
name | string | obligatorio. |
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 | Valor predeterminado true. |
Devuelve: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.
umg.cui_add_tab_list (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Adds a Common UI tab list (generating a CommonTabListWidgetBase blueprint when no class is given).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
name | string | obligatorio. |
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 | Valor predeterminado true. |
Devuelve: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.
umg.cui_add_text (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Adds a CommonTextBlock to a widget tree, optionally with a Common UI text style.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
name | string | obligatorio. |
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 | Valor predeterminado true. |
Devuelve: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.
umg.cui_create_activatable_widget (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Creates a widget blueprint deriving from CommonActivatableWidget (menus, screens, layers).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
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...). |
Devuelve: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.
umg.cui_create_border_style (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Creates a CommonBorderStyle blueprint (background brush and tint).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
properties | array of UeaKeyValue | Initial values of the style class defaults ("NormalBase.TintColor", "MinWidth"...). |
parentClass | string | Parent class override (a CommonButtonStyle/CommonTextStyle/CommonBorderStyle subclass). |
Devuelve: style, path, parentClass, properties, warnings, compileErrors, message.
umg.cui_create_button_style (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Creates a CommonButtonStyle blueprint (brushes per state, paddings, min size, text styles).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
properties | array of UeaKeyValue | Initial values of the style class defaults ("NormalBase.TintColor", "MinWidth"...). |
parentClass | string | Parent class override (a CommonButtonStyle/CommonTextStyle/CommonBorderStyle subclass). |
Devuelve: style, path, parentClass, properties, warnings, compileErrors, message.
umg.cui_create_input_action_table (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Creates a data table of Common UI input action rows.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
Devuelve: table, rowStruct, rows, warnings, message.
umg.cui_create_text_style (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Creates a CommonTextStyle blueprint (font, colour, shadow).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
properties | array of UeaKeyValue | Initial values of the style class defaults ("NormalBase.TintColor", "MinWidth"...). |
parentClass | string | Parent class override (a CommonButtonStyle/CommonTextStyle/CommonBorderStyle subclass). |
Devuelve: style, path, parentClass, properties, warnings, compileErrors, message.
umg.cui_get_input_settings (riesgo 0, UE 5.0+, requiere el plugin CommonUI, smoke)
Common UI input settings of the project (input data class, platform settings).
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | |
placeableOnly | boolean | Only classes that can be placed in a widget tree (skips abstract ones). Valor predeterminado false. |
limit | integer | Valor predeterminado 200. |
Devuelve: settingsClass, values, message.
umg.cui_get_style (riesgo 0, UE 5.0+, requiere el plugin CommonUI, smoke)
Class defaults of a Common UI style blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
style | string | obligatorio. Style blueprint created by umg.cui_create_*_style. |
Devuelve: style, path, parentClass, properties, warnings, compileErrors, message.
umg.cui_list_input_actions (riesgo 0, UE 5.0+, requiere el plugin CommonUI, smoke)
Rows of a Common UI input action table.
| Argumento | Tipo | Descripción |
|---|---|---|
table | string | obligatorio. |
Devuelve: table, rowStruct, rows, warnings, message.
umg.cui_list_widget_classes (riesgo 0, UE 5.0+, requiere el plugin CommonUI, smoke)
Common UI widget and style classes available in the project.
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | |
placeableOnly | boolean | Only classes that can be placed in a widget tree (skips abstract ones). Valor predeterminado false. |
limit | integer | Valor predeterminado 200. |
Devuelve: classes, count, message.
umg.cui_set_activatable (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Writes the activatable settings of a CommonActivatableWidget blueprint (class defaults).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
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 | Valor predeterminado true. |
Devuelve: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.
umg.cui_set_button (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Writes Common UI button settings (style, selectable, toggleable, min size, input action...).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
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 | Valor predeterminado true. |
Devuelve: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.
umg.cui_set_input_settings (riesgo 4, modifica, UE 5.0+, requiere el plugin CommonUI)
Writes the Common UI input settings. SmokeSkip: writes project config.
| Argumento | Tipo | Descripción |
|---|---|---|
properties | array of UeaKeyValue | obligatorio. Properties of the Common UI input settings to write. |
saveConfig | boolean | Valor predeterminado true. |
Devuelve: settingsClass, values, message.
umg.cui_set_style_property (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Writes class defaults on a Common UI style blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
style | string | obligatorio. |
properties | array of UeaKeyValue | obligatorio. |
compile | boolean | Valor predeterminado true. |
Devuelve: style, path, parentClass, properties, warnings, compileErrors, message.
umg.cui_set_text_block_style (riesgo 2, modifica, UE 5.0+, requiere el plugin CommonUI, smoke)
Applies a Common UI text style to a CommonTextBlock.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
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 | Valor predeterminado true. |
Devuelve: widgetBlueprint, widget, class, generatedClass, applied, warnings, compileErrors, message.
umg.cui_validate (riesgo 0, UE 5.0+, requiere el plugin CommonUI, smoke)
Checks a widget blueprint for common Common UI mistakes (buttons without style, activatable without back handler...).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
Devuelve: widgetBlueprint, issues, commonWidgets, message.
umg.delete (riesgo 3, modifica, destructivo, smoke)
Deletes the widget blueprint asset. Fails when other assets still reference it.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name. |
Devuelve: widgetBlueprint, compileErrors, applied, warnings.
umg.duplicate (riesgo 2, modifica, smoke)
Duplicates the widget blueprint (tree, animations and graphs included) into Folder under NewName.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
newName | string | obligatorio. Name of the copy. |
folder | string | Destination folder (default: the source folder). |
Devuelve: name, parentClass, rootWidget, rootWidgetClass, widgetCount, createdWidgets.
umg.duplicate_widget (riesgo 2, modifica, smoke)
Copies a widget and its subtree under the same (or another) parent.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. 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). Valor predeterminado true. |
Devuelve: widget.
umg.export_all_trees (riesgo 0, smoke)
Exports the widget tree of every widget blueprint of a folder as one JSON file each.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | |
outFolder | string | Output folder relative to the project directory. Default "Saved/UeaSmoke". Valor predeterminado TEXT("Saved/UmgTrees"). |
limit | integer | Valor predeterminado 200. |
Devuelve: outFolder, files, count, message.
umg.export_tree (riesgo 0, smoke)
Exports the whole widget tree (classes, slots, properties, children) as JSON text; feed it back to umg.import_tree.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
withProperties | boolean | Include every editable property of each widget (default false: only the non-default ones the kit tracks). Valor predeterminado false. |
Devuelve: json, widgetCount.
umg.find_by_widget_class (riesgo 0, smoke)
Widgets of a given class across every widget blueprint of a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | |
class | string | obligatorio. Widget class to look for ("Button", "CommonButtonBase"). |
includeSubclasses | boolean | Include subclasses of the class. Default true. Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: hits, count, blueprintsScanned, message.
umg.find_instance_widget (riesgo 0, requiere PIE)
Finds widgets of a live instance by name and/or class. SmokeSkip: needs a live instance (see umg.create_instance).
| Argumento | Tipo | Descripción |
|---|---|---|
id | string | obligatorio. |
name | string | Widget name (exact or substring). |
class | string | Widget class filter ("Button", "TextBlock"). |
Devuelve: id, widgets, count.
umg.find_widgets (riesgo 0, smoke)
Finds widgets whose name or designer label matches a wildcard pattern ("Btn_*").
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
pattern | string | obligatorio. Wildcard pattern matched against the widget name and label ("Btn_*", "Health"). |
Devuelve: widgets, count.
umg.find_widgets_using (riesgo 0, smoke)
Widget blueprints (and widgets) referencing an asset: texture, material, font, style or widget class.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Asset to look for (texture, material, font, widget blueprint...). |
folder | string | |
limit | integer | Valor predeterminado 200. |
Devuelve: hits, count, blueprintsScanned, message.
umg.get (riesgo 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 | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name. |
Devuelve: name, parentClass, rootWidget, rootWidgetClass, widgetCount, depth, animations, bindings, namedSlots, variables, designSize, status.
umg.get_class_defaults (riesgo 0, smoke)
Lists the class default object properties of the generated widget class as JSON values.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
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). Valor predeterminado 0. |
Devuelve: properties, count.
umg.get_compile_errors (riesgo 0, smoke)
Returns the errors and warnings of the last compile without recompiling.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name. |
Devuelve: compileWarnings, status.
umg.get_desired_size (riesgo 0, smoke)
Desired size of a widget blueprint (or one of its widgets) after a layout prepass.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget inside the tree. Empty = the root widget. |
Devuelve: widget, width, height, message.
umg.get_font (riesgo 0, smoke)
Font asset details: cache type, legacy size and typeface entries.
| Argumento | Tipo | Descripción |
|---|---|---|
font | string | obligatorio. |
Devuelve: font, typefaces, message.
umg.get_instance_property (riesgo 0, requiere 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 | Descripción |
|---|---|---|
id | string | obligatorio. |
widget | string | |
property | string | obligatorio. |
Devuelve: id, widget, property, value, message.
umg.get_instance_tree (riesgo 0, requiere PIE)
Widget tree of a live instance (name, class, parent, depth, visibility). SmokeSkip: needs a live instance (see umg.create_instance).
| Argumento | Tipo | Descripción |
|---|---|---|
id | string | obligatorio. Instance label from umg.create_instance (or a live widget's object/class name). |
Devuelve: id, widgets, count.
umg.get_named_slot_content (riesgo 0, smoke)
Widget currently filling a NamedSlot.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
slot | string | obligatorio. 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). Valor predeterminado true. |
Devuelve: slot, content, contentClass.
umg.get_parent (riesgo 0, smoke)
Parent widget of a widget, with its class and the child index.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
withProperties | boolean | Include the non-default property values. Valor predeterminado false. |
Devuelve: widget.
umg.get_properties (riesgo 0, smoke)
Lists the editable properties of a widget with type, category and current value as JSON.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
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). Valor predeterminado true. |
limit | integer | Maximum number of properties returned (default 100). Valor predeterminado 0. |
Devuelve: widget, class, properties, count.
umg.get_property (riesgo 0, smoke)
Reads one property of a widget as JSON text (paths like "Brush.ImageSize" work).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
property | string | obligatorio. Property name or path ("Text", "Brush.ImageSize", "Slot.Padding"). |
Devuelve: widget, class, properties, count.
umg.get_slot (riesgo 0, smoke)
Current slot class and values of a widget, plus the field names the slot class accepts.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
fields | array of UeaKeyValue | Slot field assignments ("Padding" -> "8", "HorizontalAlignment" -> "Fill", "LayoutData.Anchors" -> "center"). |
Devuelve: widget, slotClass, fields, validFields.
umg.get_style_asset (riesgo 0, smoke)
Reads a style asset: container class, Slate struct and every field as JSON.
| Argumento | Tipo | Descripción |
|---|---|---|
style | string | obligatorio. Slate widget style asset (path or unique name). |
Devuelve: style, properties, warnings, message.
umg.get_text (riesgo 0, smoke)
Reads the text of a widget with its localization namespace and key when it has one.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. Widget name. |
Devuelve: widget, class, text, namespace, key, property.
umg.get_tree (riesgo 0, smoke)
The whole widget hierarchy in order: name, class, parent, slot class, children, variable flag.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
depth | integer | Maximum depth reported (0 = no limit). Valor predeterminado 0. |
withProperties | boolean | Include the non-default property values of each widget. Valor predeterminado false. |
Devuelve: widgets, count, root, depth.
umg.get_tree_depth (riesgo 0, smoke)
Deepest nesting level of the tree and the path down to it.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name. |
Devuelve: depth, widgetCount, deepestPath.
umg.get_ui_settings (riesgo 0, smoke)
Project User Interface settings: application scale, DPI curve, scale rule, focus rule, default cursors.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder. Empty = /Game. |
nameContains | string | |
limit | integer | Valor predeterminado 200. |
Devuelve: applicationScale, uiScaleRule, customScalingRuleClass, renderFocusRule, defaultCursor, dpiCurve, values, message.
umg.get_widget (riesgo 0, smoke)
Class, parent, slot, children, variable flag, visibility and (optionally) the non-default properties of one widget.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
withProperties | boolean | Include the non-default property values. Valor predeterminado false. |
Devuelve: widget.
umg.get_widget_class_info (riesgo 0, smoke)
Editable properties (type, category, default), BlueprintAssignable delegates, named slots and slot class of a widget class.
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | obligatorio. Widget class short name ("Button"), C++ name ("UButton") or widget blueprint path. |
includeInherited | boolean | Include properties inherited from UWidget/UVisual (default false). Valor predeterminado false. |
Devuelve: class, parentClass, category, description, isPanel, isContent, slotClass, properties, delegates, namedSlots.
umg.get_widget_description (riesgo 0, smoke)
Class, label, tooltip, slot summary and children of one widget, as a readable paragraph.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name inside the tree (empty = the root widget). |
Devuelve: widget, description, toolTip, slotSummary.
umg.get_widget_geometry (riesgo 0, requiere 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 | Descripción |
|---|---|---|
id | string | obligatorio. |
widget | string | obligatorio. Sub-widget inside the instance. |
Devuelve: widget, x, y, width, height, scale, message.
umg.import_font_face (riesgo 2, modifica)
Imports a .ttf/.otf file as a UFontFace asset. SmokeSkip: needs a font file on disk.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
file | string | obligatorio. Absolute path to a .ttf/.otf file on disk. |
hinting | string | Default, AutoHinting, DefaultHinting, Monochrome or None. Valor predeterminado TEXT("Default"). |
Devuelve: name, path, sourceFile, bytes, message.
umg.import_tree (riesgo 3, modifica, 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 | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
json | string | obligatorio. 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. Valor predeterminado true. |
compile | boolean | Compile after the import (default true). Valor predeterminado true. |
Devuelve: json, widgetCount.
umg.insert_widget (riesgo 2, modifica, smoke)
Creates a widget positioned before/after a target widget, or inside it when position="into".
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
class | string | obligatorio. Widget class to create. |
target | string | obligatorio. 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). Valor predeterminado true. |
Devuelve: widget.
umg.is_animation_playing (riesgo 0, requiere 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 | Descripción |
|---|---|---|
id | string | obligatorio. |
animation | string | Animation name. Empty stops every animation (umg.stop_animation). |
Devuelve: id, animation, playing, currentTime, message.
umg.list (riesgo 0, smoke)
Finds widget blueprint assets by folder, parent class and name substring.
| Argumento | Tipo | Descripción |
|---|---|---|
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). Valor predeterminado 0. |
Devuelve: assets, count.
umg.list_bind_widget_requirements (riesgo 0, smoke)
Widgets (and animations) the C++ parent class requires through BindWidget / BindWidgetOptional / BindWidgetAnim.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
Devuelve: widgetBlueprint, parentClass, requirements, created, compileErrors, message.
umg.list_bindings (riesgo 0, smoke)
Property bindings of a widget blueprint (widget, property, function or variable, broken flag).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
Devuelve: widgetBlueprint, bindings, compileErrors, message.
umg.list_bound_events (riesgo 0, smoke)
Bound widget-delegate event nodes present in the blueprint's graphs.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
Devuelve: widgetBlueprint, node, existing, boundEvents, compileErrors, message.
umg.list_children (riesgo 0, smoke)
Direct children of a widget (empty widget = the root widget).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
withProperties | boolean | Include the non-default property values. Valor predeterminado false. |
Devuelve: widgets, count.
umg.list_engine_fonts (riesgo 0, smoke)
Font assets shipped with the engine (/Engine/EngineFonts).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder. Empty = /Game. |
nameContains | string | |
limit | integer | Valor predeterminado 200. |
Devuelve: fonts, count.
umg.list_field_notify (riesgo 0, UE 5.1+, smoke)
Variables of the widget blueprint marked as Field Notify.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
Devuelve: widgetBlueprint, variables, message.
umg.list_fonts (riesgo 0, smoke)
Font assets under a content folder.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder. Empty = /Game. |
nameContains | string | |
limit | integer | Valor predeterminado 200. |
Devuelve: fonts, count.
umg.list_instances (riesgo 0, requiere PIE, smoke)
Live user widgets of the PIE world with their class, viewport state and widget count.
| Argumento | Tipo | Descripción |
|---|---|---|
playerIndex | integer | Local player index of the PIE session. Default 0. Valor predeterminado 0. |
Devuelve: instances, count, message.
umg.list_named_slots (riesgo 0, smoke)
Lists the named slots of the tree with the widget currently filling each one.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name. |
Devuelve: slots, count.
umg.list_property_types (riesgo 0, smoke)
The JSON shapes accepted for Slate structs (colors, margins, anchors, fonts, brushes, child size).
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | Optional type name filter ("brush", "color", "font"). |
Devuelve: types, count.
umg.list_style_assets (riesgo 0, smoke)
Slate widget style assets under a content folder.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder. Empty = /Game. |
nameContains | string | |
limit | integer | Valor predeterminado 200. |
Devuelve: styles, count.
umg.list_style_classes (riesgo 0, smoke)
Style container classes accepted by umg.create_style_asset, with the Slate struct each one carries.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder. Empty = /Game. |
nameContains | string | |
limit | integer | Valor predeterminado 200. |
Devuelve: classes.
umg.list_variables (riesgo 0, smoke)
Variables of a widget blueprint, including the widgets exposed as variables.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
Devuelve: widgetBlueprint, variables, message.
umg.list_widget_classes (riesgo 0, smoke)
Lists the widget classes usable with umg.add_widget, with palette category, description and whether they accept children.
| Argumento | Tipo | Descripción |
|---|---|---|
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). Valor predeterminado false. |
limit | integer | Maximum number of results (default 200). Valor predeterminado 0. |
Devuelve: classes, count.
umg.list_widget_delegates (riesgo 0, smoke)
Assignable delegates of a widget (event names accepted by umg.bind_event) with their parameters.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name. Empty lists the delegates of every widget of the tree. |
Devuelve: widget, class, delegates.
umg.list_widgets (riesgo 0, smoke)
Flat list of the widgets of a blueprint, optionally filtered by class and name substring.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
classFilter | string | Only widgets of this class (or a subclass of it). |
nameContains | string | Case-insensitive substring of the widget name. |
Devuelve: widgets, count.
umg.move_widget (riesgo 2, modifica, smoke)
Moves a widget to another parent, keeping the compatible slot values.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. Widget to move. |
newParent | string | New parent panel; empty = the root widget. |
index | integer | Insertion index in the new parent, -1 appends. Valor predeterminado -1. |
keepSlot | boolean | Copy the compatible slot values to the new slot (default true). Valor predeterminado true. |
compile | boolean | Compile after the change (default true). Valor predeterminado true. |
Devuelve: widget.
umg.mvvm_add_binding (riesgo 2, modifica, UE 5.5+, requiere el plugin ModelViewViewModel, smoke)
Binds a view model property to a widget property.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
viewModel | string | obligatorio. View model name inside the view (umg.mvvm_list_viewmodels). |
viewModelProperty | string | obligatorio. Property of the view model to read. |
widget | string | obligatorio. Widget of the tree to write to. |
widgetProperty | string | obligatorio. Widget property to write ("Text", "Percent", "ToolTipText"...). |
mode | string | oneWayToDestination (default), oneWayToSource, twoWay, oneTimeToDestination. Valor predeterminado TEXT("oneWayToDestination"). |
executionMode | string | Immediate, Delayed, Tick or DelayedWhenSharedElseImmediate. Empty keeps the default. |
enabled | boolean | Valor predeterminado true. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, bindings, compileErrors, message.
umg.mvvm_add_event (riesgo 2, modifica, UE 5.5+, requiere el 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 | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. Widget whose delegate fires the event. |
event | string | obligatorio. Delegate name ("OnClicked"). |
viewModel | string | obligatorio. View model name inside the view. |
function | string | obligatorio. View model function to call. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, bindings, compileErrors, message.
umg.mvvm_add_viewmodel (riesgo 2, modifica, UE 5.5+, requiere el plugin ModelViewViewModel, smoke)
Adds a view model context to a widget blueprint (creation type, global identifier, property path).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
viewModelClass | string | obligatorio. 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. Valor predeterminado 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. Valor predeterminado false. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, viewModels, bindings, compileErrors, message.
umg.mvvm_add_viewmodel_property (riesgo 2, modifica, UE 5.1+, requiere el plugin ModelViewViewModel, smoke)
Adds a Field Notify property to a view model blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
viewModel | string | obligatorio. |
name | string | obligatorio. |
type | string | obligatorio. |
fieldNotify | boolean | Valor predeterminado true. |
defaultValue | string | |
compile | boolean | Valor predeterminado true. |
Devuelve: viewModel, path, parentClass, properties, compileErrors, message.
umg.mvvm_create_viewmodel (riesgo 2, modifica, UE 5.1+, requiere el plugin ModelViewViewModel, smoke)
Creates a view model blueprint (MVVMViewModelBase) with Field Notify properties.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
parentClass | string | Parent class. Empty = MVVMViewModelBase. |
properties | array of UeaUmgMvvmPropertySpec |
Devuelve: viewModel, path, parentClass, properties, compileErrors, message.
umg.mvvm_get_view (riesgo 0, UE 5.5+, requiere el plugin ModelViewViewModel, smoke)
Summary of a widget blueprint's MVVM view (contexts + binding count).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
Devuelve: widgetBlueprint, viewModels, bindings, compileErrors, message.
umg.mvvm_get_viewmodel (riesgo 0, UE 5.1+, requiere el plugin ModelViewViewModel, smoke)
Properties of a view model blueprint with their Field Notify flag.
| Argumento | Tipo | Descripción |
|---|---|---|
viewModel | string | obligatorio. View model blueprint (path or unique name). |
Devuelve: viewModel, path, parentClass, properties, compileErrors, message.
umg.mvvm_list_available_viewmodels (riesgo 0, UE 5.1+, requiere el plugin ModelViewViewModel, smoke)
View model classes available in the project (Field Notify sources usable by MVVM).
| Argumento | Tipo | Descripción |
|---|---|---|
sourceType | string | Source type name filter ("float", "int", "Text"...). |
destinationType | string | Destination type name filter. |
nameContains | string | |
limit | integer | Valor predeterminado 100. |
Devuelve: viewModels, count, message.
umg.mvvm_list_bindings (riesgo 0, UE 5.5+, requiere el plugin ModelViewViewModel, smoke)
View bindings of a widget blueprint (source path, destination path, mode, enabled).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
Devuelve: widgetBlueprint, bindings, compileErrors, message.
umg.mvvm_list_conversion_functions (riesgo 0, UE 5.1+, requiere el plugin ModelViewViewModel, smoke)
Blueprint functions usable as MVVM conversion functions, filtered by argument and return type.
| Argumento | Tipo | Descripción |
|---|---|---|
sourceType | string | Source type name filter ("float", "int", "Text"...). |
destinationType | string | Destination type name filter. |
nameContains | string | |
limit | integer | Valor predeterminado 100. |
Devuelve: functions, count.
umg.mvvm_list_viewmodels (riesgo 0, UE 5.5+, requiere el plugin ModelViewViewModel, smoke)
View model contexts declared on a widget blueprint's MVVM view.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
Devuelve: widgetBlueprint, viewModels, bindings, compileErrors, message.
umg.mvvm_remove_binding (riesgo 3, modifica, destructivo, UE 5.5+, requiere el plugin ModelViewViewModel, smoke)
Removes a view binding by index, or by widget + property.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
index | integer | Binding index from umg.mvvm_list_bindings. -1 uses widget + widgetProperty. Valor predeterminado -1. |
widget | string | |
widgetProperty | string | |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, bindings, compileErrors, message.
umg.mvvm_remove_viewmodel (riesgo 3, modifica, destructivo, UE 5.5+, requiere el plugin ModelViewViewModel, smoke)
Removes a view model context from a widget blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
name | string | obligatorio. View model name inside the view. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, viewModels, bindings, compileErrors, message.
umg.mvvm_rename_viewmodel (riesgo 2, modifica, UE 5.5+, requiere el plugin ModelViewViewModel, smoke)
Renames a view model context of a widget blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
name | string | obligatorio. |
newName | string | obligatorio. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, viewModels, bindings, compileErrors, message.
umg.mvvm_set_binding (riesgo 2, modifica, UE 5.5+, requiere el plugin ModelViewViewModel, smoke)
Changes the mode, enabled and compile flags of an existing view binding.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
index | integer | obligatorio. |
mode | string | oneWayToDestination, oneWayToSource, twoWay, oneTimeToDestination. Empty keeps it. |
enabled | boolean | Valor predeterminado true. |
compileBinding | boolean | Valor predeterminado true. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, bindings, compileErrors, message.
umg.mvvm_validate (riesgo 0, UE 5.5+, requiere el plugin ModelViewViewModel, smoke)
Checks the MVVM setup of a widget blueprint (unused view models, disabled or broken bindings).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
Devuelve: widgetBlueprint, issues, viewModels, bindings, message.
umg.play_animation (riesgo 0, requiere PIE)
Plays an animation on a live instance. SmokeSkip: needs a widget blueprint with an animation live in the PIE session.
| Argumento | Tipo | Descripción |
|---|---|---|
id | string | obligatorio. |
animation | string | obligatorio. |
startTime | number | Start time in seconds. Valor predeterminado 0.0. |
loops | integer | 0 loops forever. Default 1. Valor predeterminado 1. |
mode | string | forward, reverse, pingpong, pingpongreverse. Valor predeterminado TEXT("forward"). |
speed | number | Valor predeterminado 1.0. |
restoreState | boolean | Restore the animated properties when the animation finishes. Valor predeterminado false. |
Devuelve: id, animation, playing, currentTime, message.
umg.remove_all_widgets (riesgo 2, requiere PIE, smoke)
Removes every user widget from the PIE viewport.
| Argumento | Tipo | Descripción |
|---|---|---|
playerIndex | integer | Local player index of the PIE session. Default 0. Valor predeterminado 0. |
Devuelve: instances, count, message.
umg.remove_binding (riesgo 2, modifica, smoke)
Removes a property binding (and optionally the generated function).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
property | string | obligatorio. |
deleteFunction | boolean | Also delete the generated binding function. Default false. Valor predeterminado false. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, bindings, compileErrors, message.
umg.remove_instance (riesgo 1, requiere PIE)
Removes a live instance from the viewport and forgets its label. SmokeSkip: needs a live instance (see umg.create_instance).
| Argumento | Tipo | Descripción |
|---|---|---|
id | string | obligatorio. Instance label from umg.create_instance (or a live widget's object/class name). |
Devuelve: instances, count, message.
umg.remove_override (riesgo 3, modifica, destructivo, smoke)
Removes an override event node from the blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
function | string | obligatorio. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, node, existing, boundEvents, compileErrors, message.
umg.remove_widget (riesgo 3, modifica, destructivo, smoke)
Removes a widget (and its subtree unless keepChildren is set).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. Widget to remove. |
keepChildren | boolean | Re-parent the children to the removed widget's parent instead of deleting them (default false). Valor predeterminado false. |
compile | boolean | Compile after the change (default true). Valor predeterminado true. |
Devuelve: widgetBlueprint, compileErrors, applied, warnings.
umg.remove_widgets (riesgo 3, modifica, destructivo, smoke)
Removes several widgets in one transaction.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widgets | array of string | obligatorio. Widgets to remove. |
keepChildren | boolean | Re-parent the children instead of deleting them. Valor predeterminado false. |
compile | boolean | Compile after the change (default true). Valor predeterminado true. |
Devuelve: widgetBlueprint, compileErrors, applied, warnings.
umg.rename (riesgo 2, modifica, smoke)
Renames the widget blueprint asset (references are fixed up).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
newName | string | obligatorio. New asset name (no path). |
Devuelve: name, parentClass, rootWidget, rootWidgetClass, widgetCount, createdWidgets.
umg.rename_widget (riesgo 2, modifica, smoke)
Renames a widget; the Blueprint variable of the generated class follows.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. Widget to rename. |
newName | string | obligatorio. New name (must be unique in the tree). |
compile | boolean | Compile after the change (default true). Valor predeterminado true. |
Devuelve: widget.
umg.render_to_png (riesgo 0, smoke)
Renders a widget blueprint to a PNG file (project-relative path) with FWidgetRenderer.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. Widget blueprint to render. |
file | string | obligatorio. Output file, relative to the project directory (e.g. "Saved/UeaSmoke/wbp.png"). |
width | integer | Valor predeterminado 512. |
height | integer | Valor predeterminado 512. |
scale | number | Render scale. Default 1. Valor predeterminado 1.0. |
deltaTime | number | Delta time given to the widget before the capture (lets one construct/tick pass run). Valor predeterminado 0.0. |
Devuelve: file, absolutePath, width, height, bytes, message.
umg.render_widget_class (riesgo 0, smoke)
Same as umg.render_to_png for any UserWidget class (C++ class or widget blueprint).
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | obligatorio. UserWidget class: a widget blueprint path or a C++ class name. |
file | string | obligatorio. |
width | integer | Valor predeterminado 512. |
height | integer | Valor predeterminado 512. |
scale | number | Valor predeterminado 1.0. |
deltaTime | number | Valor predeterminado 0.0. |
Devuelve: file, absolutePath, width, height, bytes, message.
umg.reorder_widget (riesgo 2, modifica, smoke)
Changes the position of a widget inside its parent (absolute index or relative shift).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. 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). Valor predeterminado true. |
Devuelve: widget.
umg.replace_widget (riesgo 3, modifica, smoke)
Replaces a widget by a new one of another class, keeping its name, slot and (for panels) its children.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. Widget to replace. |
newClass | string | obligatorio. 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). Valor predeterminado true. |
keepName | boolean | Keep the old widget's name for the replacement (default true). Valor predeterminado true. |
compile | boolean | Compile after the change (default true). Valor predeterminado true. |
Devuelve: widget.
umg.replace_with_child (riesgo 3, modifica, smoke)
Replaces a widget by its first child, deleting the widget (ReplaceWidgetWithChild semantics).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
compile | boolean | Compile after the change (default true). Valor predeterminado true. |
Devuelve: widget.
umg.replace_with_named_slot (riesgo 3, modifica, smoke)
Replaces a widget by a NamedSlot of the same name, so a child blueprint can fill it.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. 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). Valor predeterminado true. |
Devuelve: widget.
umg.reset_property (riesgo 2, modifica, smoke)
Resets a property to the value of the widget class default object.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
property | string | obligatorio. Property name or path ("Text", "Brush.ImageSize", "Slot.Padding"). |
Devuelve: widget, class, values.
umg.satisfy_bind_widgets (riesgo 2, modifica, smoke)
Creates the widgets a BindWidget parent class requires but the tree does not have yet.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
parent | string | Parent panel the created widgets are added to. Empty = the root panel. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, parentClass, requirements, created, compileErrors, message.
umg.save (riesgo 2, modifica, smoke)
Saves the widget blueprint package to disk.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name. |
Devuelve: saved.
umg.screenshot_viewport (riesgo 1, requiere PIE)
Requests a viewport screenshot (with or without UI). SmokeSkip: needs a rendered game frame to land on disk.
| Argumento | Tipo | Descripción |
|---|---|---|
file | string | obligatorio. Output file relative to the project directory. |
showUi | boolean | Include the UI in the capture. Default true. Valor predeterminado true. |
Devuelve: file, absolutePath, width, height, bytes, message.
umg.select_option (riesgo 0, requiere 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 | Descripción |
|---|---|---|
id | string | obligatorio. |
widget | string | obligatorio. |
option | string | Option text. Use index when empty. |
index | integer | Valor predeterminado -1. |
Devuelve: id, widget, class, value, message.
umg.set_alignment (riesgo 2, modifica, smoke)
Sets the horizontal/vertical alignment of any slot class that has them.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
hAlign | string | Fill, Left, Center, Right. |
vAlign | string | Fill, Top, Center, Bottom. |
Devuelve: widget, slotClass, fields, validFields.
umg.set_background_blur (riesgo 2, modifica, smoke)
BackgroundBlur: strength, radius, alpha handling, fallback brush, padding and alignments.
| Argumento | Tipo | Descripción |
|---|---|---|
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 |
Devuelve: widget, class, values.
umg.set_border (riesgo 2, modifica, smoke)
Border: background brush and color, padding, content color and alignments.
| Argumento | Tipo | Descripción |
|---|---|---|
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}. |
Devuelve: widget, class, values.
umg.set_box_slot (riesgo 2, modifica, smoke)
Horizontal/vertical box (and stack box) slot: padding, size rule and weight, alignments.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
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. |
Devuelve: widget, slotClass, fields, validFields.
umg.set_brush (riesgo 2, modifica, smoke)
Writes any FSlateBrush property of a widget ("Brush", "Background", "WidgetStyle.Normal", ...).
| Argumento | Tipo | Descripción |
|---|---|---|
property | string | obligatorio. Brush property to write ("Brush", "Background", "WidgetStyle.Normal", ...). |
brush | string | obligatorio. Brush as {texture |
Devuelve: widget, class, values.
umg.set_button (riesgo 2, modifica, smoke)
Button: colors, click/touch/press methods and focusability.
| Argumento | Tipo | Descripción |
|---|---|---|
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. |
Devuelve: widget, class, values.
umg.set_button_style (riesgo 2, modifica, smoke)
Button style: the four state brushes, paddings and (5.x) state foreground colors.
| Argumento | Tipo | Descripción |
|---|---|---|
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). |
Devuelve: widget, class, values.
umg.set_canvas_slot (riesgo 2, modifica, smoke)
Canvas panel slot: position, size, anchors (preset or explicit), offsets, alignment, auto size, z-order.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
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. |
Devuelve: widget, slotClass, fields, validFields.
umg.set_check (riesgo 0, requiere 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 | Descripción |
|---|---|---|
id | string | obligatorio. |
widget | string | obligatorio. |
checked | boolean | Valor predeterminado true. |
Devuelve: id, widget, class, value, message.
umg.set_check_box (riesgo 2, modifica, smoke)
CheckBox: checked state, padding, state brushes and click method.
| Argumento | Tipo | Descripción |
|---|---|---|
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. |
Devuelve: widget, class, values.
umg.set_circular_throbber (riesgo 2, modifica, smoke)
CircularThrobber: number of pieces, period and radius.
| Argumento | Tipo | Descripción |
|---|---|---|
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). |
Devuelve: widget, class, values.
umg.set_class_defaults (riesgo 2, modifica, smoke)
Writes properties on the class default object of the generated widget class (values are JSON or plain text).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
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). Valor predeterminado 0. |
Devuelve: properties, count.
umg.set_class_settings (riesgo 2, modifica, smoke)
Sets class-level settings of the generated widget class: palette category, dynamic creation, PreConstruct, tick frequency, focusable, volatile.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
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. |
Devuelve: widgetBlueprint, compileErrors, applied, warnings.
umg.set_clipping (riesgo 2, modifica, smoke)
Sets the clipping mode: Inherit, ClipToBounds, ClipToBoundsWithoutIntersecting, ClipToBoundsAlways, OnDemand.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
value | string | obligatorio. The value to set; meaning depends on the tool (see its description). |
Devuelve: widget.
umg.set_combo_box (riesgo 2, modifica, smoke)
ComboBoxString: option list, selected option, padding, list height and arrow.
| Argumento | Tipo | Descripción |
|---|---|---|
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}. |
Devuelve: widget, class, values.
umg.set_cursor (riesgo 2, modifica, smoke)
Sets the mouse cursor shown over the widget (Default, Hand, Crosshairs, TextEditBeam, ...).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
value | string | obligatorio. The value to set; meaning depends on the tool (see its description). |
Devuelve: widget.
umg.set_design_size (riesgo 2, modifica, smoke)
Sets the designer preview size (mode custom/desired/fillScreen). Affects the designer only.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
width | integer | Preview width in pixels. Valor predeterminado 0. |
height | integer | Preview height in pixels. Valor predeterminado 0. |
mode | string | Size mode: "custom" (use width/height), "desired" or "fillScreen". |
Devuelve: widgetBlueprint, compileErrors, applied, warnings.
umg.set_display_label (riesgo 2, modifica, smoke)
Sets the designer display label of a widget (the name stays unchanged).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
value | string | obligatorio. The value to set; meaning depends on the tool (see its description). |
Devuelve: widget.
umg.set_dynamic_entry_box (riesgo 2, modifica, 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 | Descripción |
|---|---|---|
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. |
Devuelve: widget, class, values.
umg.set_editable_text (riesgo 2, modifica, smoke)
EditableText(Box): text, hint, password/read-only flags, justification, font size and focus behaviour.
| Argumento | Tipo | Descripción |
|---|---|---|
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}. |
Devuelve: widget, class, values.
umg.set_enabled (riesgo 2, modifica, smoke)
Enables or disables a widget ("true"/"false").
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
value | string | obligatorio. The value to set; meaning depends on the tool (see its description). |
Devuelve: widget.
umg.set_expandable_area (riesgo 2, modifica, smoke)
ExpandableArea: expanded state, paddings, max height and border color.
| Argumento | Tipo | Descripción |
|---|---|---|
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). |
Devuelve: widget, class, values.
umg.set_field_notify (riesgo 2, modifica, UE 5.1+, smoke)
Turns Field Notify (MVVM change notification) on or off for a variable.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
variable | string | obligatorio. |
enabled | boolean | Turn Field Notify on (default) or off. Valor predeterminado true. |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, variables, message.
umg.set_font (riesgo 2, modifica, smoke)
Sets a font (asset, typeface, size, outline, letter spacing) on any widget that has one.
| Argumento | Tipo | Descripción |
|---|---|---|
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). |
Devuelve: widget, class, values.
umg.set_grid_panel (riesgo 2, modifica, smoke)
GridPanel: per-column and per-row fill weights.
| Argumento | Tipo | Descripción |
|---|---|---|
columnFills | array of UeaKeyValue | Column index -> fill weight ("0" -> "1"). |
rowFills | array of UeaKeyValue | Row index -> fill weight. |
Devuelve: widget, class, values.
umg.set_grid_slot (riesgo 2, modifica, smoke)
Grid (and uniform grid) slot: row, column, spans, layer, nudge, padding, alignments.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
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 |
Devuelve: widget, slotClass, fields, validFields.
umg.set_image (riesgo 2, modifica, smoke)
Image: texture or material, draw size, tint, draw mode and nine-slice margin.
| Argumento | Tipo | Descripción |
|---|---|---|
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). |
Devuelve: widget, class, values.
umg.set_input_key_selector (riesgo 2, modifica, smoke)
InputKeySelector: bound key, modifier/gamepad flags, escape keys and prompt texts.
| Argumento | Tipo | Descripción |
|---|---|---|
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. |
Devuelve: widget, class, values.
umg.set_input_mode (riesgo 0, requiere PIE, smoke)
Sets the PIE player's input mode (game only / UI only / game and UI) and cursor visibility.
| Argumento | Tipo | Descripción |
|---|---|---|
mode | string | obligatorio. gameOnly, uiOnly or gameAndUi. |
playerIndex | integer | Valor predeterminado 0. |
showCursor | boolean | Valor predeterminado true. |
id | string | Instance to focus (uiOnly / gameAndUi). |
mouseLock | string | Mouse lock: doNotLock, lockOnCapture, lockAlways, lockInFullscreen. Valor predeterminado TEXT("doNotLock"). |
Devuelve: target, handledDown, handledUp, message.
umg.set_instance_position (riesgo 0, requiere 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 | Descripción |
|---|---|---|
id | string | obligatorio. |
x | number | Valor predeterminado 0.0. |
y | number | Valor predeterminado 0.0. |
width | number | Desired size in the viewport. 0,0 leaves it unset. Valor predeterminado 0.0. |
height | number | Valor predeterminado 0.0. |
removeDpiScale | boolean | Remove the DPI scale from the position. Default true. Valor predeterminado true. |
Devuelve: instance, message.
umg.set_instance_property (riesgo 0, requiere 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 | Descripción |
|---|---|---|
id | string | obligatorio. |
widget | string | Sub-widget of the instance. Empty = the instance itself. |
property | string | obligatorio. |
value | string | obligatorio. JSON value (see the umg conventions: colours, margins, brushes, fonts). |
Devuelve: id, widget, property, value, message.
umg.set_instance_visibility (riesgo 0, requiere 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 | Descripción |
|---|---|---|
id | string | obligatorio. |
visibility | string | obligatorio. Visible, Collapsed, Hidden, HitTestInvisible, SelfHitTestInvisible. |
widget | string | Sub-widget inside the instance. Empty = the instance itself. |
Devuelve: instance, message.
umg.set_invalidation_box (riesgo 2, modifica, smoke)
InvalidationBox: caching on or off.
| Argumento | Tipo | Descripción |
|---|---|---|
canCache | string | obligatorio. "true"/"false": cache the children's geometry and draw elements. |
Devuelve: widget, class, values.
umg.set_is_variable (riesgo 2, modifica, smoke)
Exposes (or hides) the widget as a Blueprint variable of the generated class.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
isVariable | boolean | True exposes the widget as a Blueprint variable of the generated class. Valor predeterminado true. |
compile | boolean | Compile after the change (default true). Valor predeterminado true. |
Devuelve: widget.
umg.set_list_view (riesgo 2, modifica)
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 | Descripción |
|---|---|---|
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). |
Devuelve: widget, class, values.
umg.set_localized_text (riesgo 2, modifica, smoke)
Sets a localized FText (namespace + key + source string) on a text property.
| Argumento | Tipo | Descripción |
|---|---|---|
namespace | string | obligatorio. Localization namespace. |
key | string | obligatorio. Localization key. |
source | string | obligatorio. Source (native language) string. |
property | string | Text property to write (default "Text"). |
Devuelve: widget, class, values.
umg.set_menu_anchor (riesgo 2, modifica, smoke)
MenuAnchor: menu widget class, placement and window fitting.
| Argumento | Tipo | Descripción |
|---|---|---|
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. |
Devuelve: widget, class, values.
umg.set_multi_line_text (riesgo 2, modifica, smoke)
MultiLineEditableText(Box): text, hint, read-only, justification, wrapping.
| Argumento | Tipo | Descripción |
|---|---|---|
text | string | |
hintText | string | |
readOnly | string | "true"/"false". |
justification | string | Left, Center, Right. |
autoWrap | string | "true"/"false": auto-wrap the text. |
Devuelve: widget, class, values.
umg.set_named_slot_content (riesgo 2, modifica, smoke)
Fills a NamedSlot with a new widget of widgetClass, or moves an existing widget into it.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
slot | string | obligatorio. 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). Valor predeterminado true. |
Devuelve: slot, content, contentClass.
umg.set_navigation (riesgo 2, modifica, smoke)
Sets one navigation rule of a widget (direction up/down/left/right/next/previous or "all").
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
direction | string | obligatorio. up, down, left, right, next, previous, or "all" for every direction. |
rule | string | obligatorio. escape, stop, wrap, explicit, custom, customBoundary. |
target | string | Target widget name for the "explicit" rule. |
Devuelve: widget.
umg.set_padding (riesgo 2, modifica, smoke)
Sets the padding of any slot class that has one.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
padding | string | obligatorio. Padding "{'left':8,'top':4,'right':8,'bottom':4}", "8,4" or a single number. |
Devuelve: widget, slotClass, fields, validFields.
umg.set_parent_class (riesgo 2, modifica, smoke)
Reparents the widget blueprint to another UserWidget-derived class and recompiles.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
parentClass | string | obligatorio. New parent class; must derive from UserWidget. |
Devuelve: name, parentClass, rootWidget, rootWidgetClass, widgetCount, createdWidgets.
umg.set_progress_bar (riesgo 2, modifica, smoke)
ProgressBar: percent, fill color, fill type, marquee and the two brushes.
| Argumento | Tipo | Descripción |
|---|---|---|
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. |
Devuelve: widget, class, values.
umg.set_properties (riesgo 2, modifica, smoke)
Writes several properties of one widget in one call.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
properties | array of UeaKeyValue | obligatorio. Property name -> value pairs. |
compile | boolean | Compile after the change (default false). Valor predeterminado false. |
Devuelve: widget, class, values.
umg.set_property (riesgo 2, modifica, smoke)
Writes one property of a widget from text or a JSON fragment.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
property | string | obligatorio. Property name or path. |
value | string | obligatorio. 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). Valor predeterminado false. |
Devuelve: widget, class, values.
umg.set_property_on_all (riesgo 2, modifica, smoke)
Writes one property on every widget of a class inside the blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
classFilter | string | obligatorio. Only widgets of this class (or a subclass). |
property | string | obligatorio. Property name or path. |
value | string | obligatorio. New value. |
Devuelve: widgets, count.
umg.set_render_opacity (riesgo 2, modifica, smoke)
Sets the render opacity of a widget (0..1).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
value | string | obligatorio. The value to set; meaning depends on the tool (see its description). |
Devuelve: widget.
umg.set_render_transform (riesgo 2, modifica, smoke)
Sets the render transform: translation, scale, shear, angle (degrees) and pivot.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
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}". |
Devuelve: widget.
umg.set_retainer_box (riesgo 2, modifica, smoke)
RetainerBox: effect material, texture parameter, render phase and retain flag.
| Argumento | Tipo | Descripción |
|---|---|---|
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. |
Devuelve: widget, class, values.
umg.set_rich_text (riesgo 2, modifica, smoke)
RichTextBlock: text with markup, style set data table and decorators.
| Argumento | Tipo | Descripción |
|---|---|---|
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. |
Devuelve: widget, class, values.
umg.set_root (riesgo 3, modifica, smoke)
Sets the root widget of the tree: a new widget of Class, or an existing widget promoted to root.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
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). Valor predeterminado true. |
compile | boolean | Compile after the change (default true). Valor predeterminado true. |
Devuelve: widget.
umg.set_safe_zone (riesgo 2, modifica, smoke)
SafeZone: which sides to pad and the title-safe flag.
| Argumento | Tipo | Descripción |
|---|---|---|
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. |
Devuelve: widget, class, values.
umg.set_scale_box (riesgo 2, modifica, smoke)
ScaleBox: stretch mode, direction, user scale and inherited-scale flag.
| Argumento | Tipo | Descripción |
|---|---|---|
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". |
Devuelve: widget, class, values.
umg.set_scroll_box (riesgo 2, modifica, smoke)
ScrollBox: orientation, scroll bar look and scrolling behaviour.
| Argumento | Tipo | Descripción |
|---|---|---|
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}. |
Devuelve: widget, class, values.
umg.set_size_box (riesgo 2, modifica, smoke)
SizeBox: width/height overrides, min/max sizes and aspect ratios; clear removes overrides.
| Argumento | Tipo | Descripción |
|---|---|---|
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. |
Devuelve: widget, class, values.
umg.set_slider (riesgo 2, modifica, smoke)
Slider: value, range, step, orientation, locked/indent and colors.
| Argumento | Tipo | Descripción |
|---|---|---|
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}. |
Devuelve: widget, class, values.
umg.set_slider_value (riesgo 0, requiere 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 | Descripción |
|---|---|---|
id | string | obligatorio. |
widget | string | obligatorio. |
value | number | obligatorio. |
Devuelve: id, widget, class, value, message.
umg.set_slot (riesgo 2, modifica, smoke)
Writes any field of a widget's slot by name; unknown fields are reported with the valid list.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
fields | array of UeaKeyValue | Slot field assignments ("Padding" -> "8", "HorizontalAlignment" -> "Fill", "LayoutData.Anchors" -> "center"). |
Devuelve: widget, slotClass, fields, validFields.
umg.set_spacer (riesgo 2, modifica, smoke)
Spacer: fixed size.
| Argumento | Tipo | Descripción |
|---|---|---|
size | string | obligatorio. Size {x,y} in pixels. |
Devuelve: widget, class, values.
umg.set_spin_box (riesgo 2, modifica, smoke)
SpinBox: value, ranges, delta and fractional digits.
| Argumento | Tipo | Descripción |
|---|---|---|
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}. |
Devuelve: widget, class, values.
umg.set_style_asset_property (riesgo 2, modifica, smoke)
Writes fields of the style struct inside a style asset ("Normal.TintColor", "NormalPadding"...).
| Argumento | Tipo | Descripción |
|---|---|---|
style | string | obligatorio. |
properties | array of UeaKeyValue | obligatorio. Property paths inside the style struct and their JSON values. |
Devuelve: style, properties, warnings, message.
umg.set_switcher (riesgo 0, requiere 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 | Descripción |
|---|---|---|
id | string | obligatorio. |
widget | string | obligatorio. |
index | integer | obligatorio. |
Devuelve: id, widget, class, value, message.
umg.set_switcher_index (riesgo 2, modifica, smoke)
WidgetSwitcher: active child by index or by widget name.
| Argumento | Tipo | Descripción |
|---|---|---|
index | string | Index of the child to show. |
activeWidget | string | Name of the child widget to show (overrides index). |
Devuelve: widget, class, values.
umg.set_text (riesgo 2, modifica, smoke)
TextBlock: text, wrapping, justification, color, font and shadow in one call.
| Argumento | Tipo | Descripción |
|---|---|---|
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). |
Devuelve: widget, class, values.
umg.set_text_input (riesgo 0, requiere 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 | Descripción |
|---|---|---|
id | string | obligatorio. |
widget | string | obligatorio. |
text | string | obligatorio. |
commit | boolean | Fire OnTextCommitted (OnCommit) after setting the text. Default true. Valor predeterminado true. |
Devuelve: id, widget, class, value, message.
umg.set_text_style_everywhere (riesgo 2, modifica, smoke)
Applies one font/size/typeface/colour to every text block of a widget blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
font | string | Font asset path. Empty keeps the current font object. |
size | integer | Font size in points. 0 keeps the current size. Valor predeterminado 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 | Valor predeterminado true. |
Devuelve: widgetBlueprint, applied, warnings, compileErrors, message.
umg.set_throbber (riesgo 2, modifica, smoke)
Throbber: number of pieces, animation axes and (5.x) the piece image.
| Argumento | Tipo | Descripción |
|---|---|---|
pieces | string | Number of pieces. |
animateHorizontally | string | "true"/"false". |
animateVertically | string | "true"/"false". |
animateOpacity | string | "true"/"false". |
image | string | Piece image brush (5.x). |
Devuelve: widget, class, values.
umg.set_tooltip (riesgo 2, modifica, smoke)
Sets the tooltip text of a widget.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
value | string | obligatorio. The value to set; meaning depends on the tool (see its description). |
Devuelve: widget.
umg.set_ui_settings (riesgo 4, modifica)
Writes the project's User Interface settings. SmokeSkip: writes project config (DefaultEngine.ini).
| Argumento | Tipo | Descripción |
|---|---|---|
properties | array of UeaKeyValue | obligatorio. Properties of UUserInterfaceSettings to write ("ApplicationScale", "UIScaleRule", "RenderFocusRule"...). |
saveConfig | boolean | Save to DefaultEngine.ini. Default true. Valor predeterminado true. |
Devuelve: applicationScale, uiScaleRule, customScalingRuleClass, renderFocusRule, defaultCursor, dpiCurve, values, message.
umg.set_uniform_grid (riesgo 2, modifica, smoke)
UniformGridPanel: cell padding and minimum cell size.
| Argumento | Tipo | Descripción |
|---|---|---|
slotPadding | string | Padding of every cell {left,top,right,bottom}. |
minSlotWidth | string | |
minSlotHeight | string |
Devuelve: widget, class, values.
umg.set_visibility (riesgo 2, modifica, smoke)
Sets the visibility: Visible, Collapsed, Hidden, HitTestInvisible, SelfHitTestInvisible.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
value | string | obligatorio. The value to set; meaning depends on the tool (see its description). |
Devuelve: widget.
umg.set_widget_color (riesgo 2, modifica, smoke)
Sets the main color of a widget, choosing the right property for its class (text, image, border, progress bar...).
| Argumento | Tipo | Descripción |
|---|---|---|
color | string | obligatorio. 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". |
Devuelve: widget, class, values.
umg.set_widget_navigation_rules (riesgo 2, modifica, smoke)
Sets every navigation direction of a widget at once ("stop", "wrap", "escape" or "explicit:WidgetName").
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
up | string | Rule for the up direction (escape, stop, wrap, explicit:WidgetName). |
down | string | |
left | string | |
right | string | |
next | string | |
previous | string |
Devuelve: widget.
umg.set_widget_style (riesgo 2, modifica, smoke)
Writes a whole widget style struct (WidgetStyle by default) from a JSON object.
| Argumento | Tipo | Descripción |
|---|---|---|
style | string | obligatorio. JSON object written into the widget's style struct ("{'Normal':{'texture':'...'},'NormalPadding':4}"). |
property | string | Style property name (default "WidgetStyle"). |
Devuelve: widget, class, values.
umg.set_widget_texts (riesgo 2, modifica, smoke)
Sets the text of several widgets at once (widget name -> text).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
texts | array of UeaKeyValue | obligatorio. Widget name -> text. Widgets without a text property are reported in warnings. |
Devuelve: widgets, count.
umg.set_wrap_box (riesgo 2, modifica, smoke)
WrapBox: inner padding and (5.x) wrap size, orientation and alignment.
| Argumento | Tipo | Descripción |
|---|---|---|
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). |
Devuelve: widget, class, values.
umg.simulate_click_at (riesgo 2, requiere PIE)
Sends a raw mouse press+release at an absolute screen position. SmokeSkip: moves the real cursor.
| Argumento | Tipo | Descripción |
|---|---|---|
x | number | obligatorio. Absolute screen X. |
y | number | obligatorio. Absolute screen Y. |
button | string | LeftMouseButton (default), RightMouseButton, MiddleMouseButton. Valor predeterminado TEXT("LeftMouseButton"). |
Devuelve: target, handledDown, handledUp, message.
umg.simulate_key (riesgo 1, requiere PIE, smoke)
Sends a raw key event to Slate (the focused widget handles it).
| Argumento | Tipo | Descripción |
|---|---|---|
key | string | obligatorio. FKey name: SpaceBar, Enter, Escape, Gamepad_FaceButton_Bottom... |
event | string | press, release or tap (default). Valor predeterminado TEXT("tap"). |
control | boolean | Valor predeterminado false. |
alt | boolean | Valor predeterminado false. |
shift | boolean | Valor predeterminado false. |
Devuelve: target, handledDown, handledUp, message.
umg.stop_animation (riesgo 0, requiere 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 | Descripción |
|---|---|---|
id | string | obligatorio. |
animation | string | Animation name. Empty stops every animation (umg.stop_animation). |
Devuelve: id, animation, playing, currentTime, message.
umg.unbind_event (riesgo 3, modifica, destructivo, smoke)
Removes the bound event node of a widget delegate.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | obligatorio. |
event | string | obligatorio. Delegate name: OnClicked, OnHovered, OnValueChanged, OnTextCommitted, OnCheckStateChanged... |
compile | boolean | Valor predeterminado true. |
Devuelve: widgetBlueprint, node, existing, boundEvents, compileErrors, message.
umg.unwrap_widget (riesgo 3, modifica, smoke)
Replaces a widget by its single child (the inverse of umg.wrap_widget).
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
widget | string | Widget name (empty = the root widget). |
compile | boolean | Compile after the change (default true). Valor predeterminado true. |
Devuelve: widget.
umg.validate (riesgo 0, smoke)
Audits a widget blueprint: unfilled BindWidget requirements, empty panels, widgets outside the design area, broken bindings, unused variable widgets.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. Widget blueprint asset path ("/Game/UI/WBP_Menu") or its unique asset name. |
Devuelve: issues, notes, valid.
umg.wrap_widget (riesgo 2, modifica, smoke)
Wraps one or several sibling widgets into a new panel of WrapperClass.
| Argumento | Tipo | Descripción |
|---|---|---|
widgetBlueprint | string | obligatorio. |
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 | obligatorio. Panel class that becomes their new parent ("SizeBox", "Border", "VerticalBox", ...). |
name | string | Name of the wrapper. |
compile | boolean | Compile after the change (default true). Valor predeterminado true. |
Devuelve: widget.