Saltar al contenido principal

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​

PrefixArea
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_dispatcherbindings and events
umg.create_style_asset, umg.create_font, umg.create_rich_text_style_table, umg.apply_themestyles, 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_treesbatch operations

Start here​

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

Recipe: fade a panel in​

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

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

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

property typetrackchannels
float / intfloat track1
FVector2Dfloat-vector track (UMovieSceneFloatVectorTrack on 5.x, UMovieSceneVectorTrack on 4.27)2 (x, y)
FLinearColor / FSlateColorcolour track4 (r, g, b, a)
boolbool track1
ESlateVisibilityvisibility track1 (true = visible)
FMarginmargin track4 (left, top, right, bottom)
FWidgetTransform2D transform track7 (translation x/y, angle, scale x/y, shear x/y)

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

Recipe: a health bar bound to a variable​

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

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

Recipe: wire a button​

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

Recipe: styles and theming​

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

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

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

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

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

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

Recipe: test a widget in PIE​

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

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

Gotchas​

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

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 MaxAutoRisk requieren "_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 argumento dryRun. smoke = cubierto por edit.self_test.

umg.add_dispatcher (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
namestringobligatorio.
paramsarray of UeaUmgDispatcherParam
compilebooleanValor predeterminado true.

Devuelve: widgetBlueprint, variables, message.

umg.add_override (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
functionstringobligatorio. PreConstruct, Construct, Tick, Destruct, OnMouseButtonDown, OnKeyDown, OnDrop, OnDragDetected...
graphstringEvent graph name. Empty = the main EventGraph.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
compilebooleanValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
propertystringobligatorio. Bindable property: Text, Percent, Visibility, ColorAndOpacity, IsEnabled, ToolTipText, Brush...
variablestringBlueprint variable to read the value from. Takes precedence over functionName.
functionNamestringName of the pure function to create or reuse. Default "Get__".
compilebooleanCompile 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.

ArgumentoTipoDescripción
tablestringobligatorio. Data table asset.
rowstringobligatorio. Row name (the style name used in text</> markup).
propertiesarray of UeaKeyValueField 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.

ArgumentoTipoDescripción
tablestringobligatorio. Data table asset.
rowstringobligatorio. Row name (the style name used in text</> markup).
propertiesarray of UeaKeyValueField 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.

ArgumentoTipoDescripción
fontstringobligatorio.
namestringobligatorio.
fontFacestringobligatorio. 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
userWidgetstringobligatorio. Widget blueprint to instance inside the tree (path or unique name).
namestringName of the new widget.
parentstringParent widget name; empty = the root widget.
indexintegerInsertion index, -1 appends. Valor predeterminado -1.
compilebooleanCompile 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
namestringobligatorio.
typestringobligatorio. bool, int, float, string, name, text, vector, rotator, transform, linearcolor, a struct/class name, "Actor*", "Texture2D*"...
defaultValuestringDefault value as text (ImportText form).
categorystring
instanceEditablebooleanValor predeterminado false.
exposeOnSpawnbooleanValor predeterminado false.
fieldNotifybooleanMark as Field Notify (MVVM), 5.1+. Valor predeterminado false.
compilebooleanValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
classstringobligatorio. Widget class: short name ("TextBlock"), C++ name ("UTextBlock") or another widget blueprint path.
namestringName of the new widget (a unique suffix is added when taken; default: the class name).
parentstringParent widget name; empty = the root widget (or the new widget becomes the root when the tree is empty).
indexintegerInsertion index inside the parent, -1 (default) appends. Valor predeterminado -1.
isVariablebooleanExpose the widget as a Blueprint variable (default true, like the designer). Valor predeterminado true.
slotarray of UeaKeyValueInitial slot settings ("Padding" -> "8", "LayoutData.Anchors" -> "center", ...).
propertiesarray of UeaKeyValueInitial widget properties ("Text" -> "Play", "ColorAndOpacity" -> "{'r':1,'g':0,'b':0}").
compilebooleanCompile 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetsarray of UeaUmgWidgetSpecobligatorio. Widgets to create, in order; each may parent to one created earlier in the list.
compilebooleanCompile 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio.
widgetstringobligatorio.
slotbooleanBind 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio.
widgetstringobligatorio.
propertystringobligatorio.
timenumberobligatorio. Time in seconds.
valuestringobligatorio. Value as JSON: a number, {x,y}, {r,g,b,a}, {left,top,right,bottom}, true/false or a visibility name.
interpstring"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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio.
widgetstringobligatorio.
propertystringobligatorio.
keysarray of UeaUmgAnimKeyEntryobligatorio.

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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio.
widgetstringobligatorio.
propertystringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio.
widgetstringobligatorio.
propertystringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio. Widget to animate.
animationstringobligatorio. Animation to create or extend.
fromstringStart value: opacity (fade/pulse), scale (scale) or {x,y} (slide).
tostringEnd value.
durationnumberDuration in seconds. Default 0.3. Valor predeterminado 0.3.
startTimenumberStart time in seconds. Default 0. Valor predeterminado 0.0.
interpstring"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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
namestringobligatorio.
lengthnumberLength in seconds. Default 5. Valor predeterminado 5.0.
displayRatenumberEditor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio.
newNamestringName 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio. 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio. Widget to animate.
animationstringobligatorio. Animation to create or extend.
fromstringStart value: opacity (fade/pulse), scale (scale) or {x,y} (slide).
tostringEnd value.
durationnumberDuration in seconds. Default 0.3. Valor predeterminado 0.3.
startTimenumberStart time in seconds. Default 0. Valor predeterminado 0.0.
interpstring"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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio.
widgetstringobligatorio.
propertystringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio. Animation name to create or overwrite.
jsonstringobligatorio. JSON from umg.anim_export.
replacebooleanRemove 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.

Devuelve: widget, class, properties.

umg.anim_list_tracks (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio. Widget to animate.
animationstringobligatorio. Animation to create or extend.
fromstringStart value: opacity (fade/pulse), scale (scale) or {x,y} (slide).
tostringEnd value.
durationnumberDuration in seconds. Default 0.3. Valor predeterminado 0.3.
startTimenumberStart time in seconds. Default 0. Valor predeterminado 0.0.
interpstring"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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio.
widgetstringobligatorio.
slotbooleanBind 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio.
widgetstringobligatorio.
propertystringobligatorio.
timenumberobligatorio. Time in seconds of the key to remove (matched with a small tolerance).
channelintegerChannel 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio.
widgetstringobligatorio.
propertystringobligatorio. 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio.
newNamestringobligatorio.

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

umg.anim_scale (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio. Widget to animate.
animationstringobligatorio. Animation to create or extend.
fromstringStart value: opacity (fade/pulse), scale (scale) or {x,y} (slide).
tostringEnd value.
durationnumberDuration in seconds. Default 0.3. Valor predeterminado 0.3.
startTimenumberStart time in seconds. Default 0. Valor predeterminado 0.0.
interpstring"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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio.
displayRatenumberobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio.
widgetstringobligatorio.
propertystringobligatorio.
timenumberobligatorio. Time in seconds.
valuestringobligatorio. Value as JSON: a number, {x,y}, {r,g,b,a}, {left,top,right,bottom}, true/false or a visibility name.
interpstring"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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
animationstringobligatorio.
startnumberStart in seconds. Valor predeterminado 0.0.
endnumberobligatorio. 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio. Widget to animate.
animationstringobligatorio. Animation to create or extend.
fromstringStart value: opacity (fade/pulse), scale (scale) or {x,y} (slide).
tostringEnd value.
durationnumberDuration in seconds. Default 0.3. Valor predeterminado 0.3.
startTimenumberStart time in seconds. Default 0. Valor predeterminado 0.0.
interpstring"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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
stylestringobligatorio.
propertystringStyle property of the widget. Empty = WidgetStyle.
compilebooleanValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
primarystringMain colour for buttons and progress bars ({r,g,b,a} or "r,g,b,a").
secondarystringSecondary colour for borders and backgrounds.
textstringText colour.
fontstringFont asset applied to every text block.
fontSizeintegerFont size applied to every text block. 0 keeps it. Valor predeterminado 0.
compilebooleanValor 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.

ArgumentoTipoDescripción
folderstringContent folder to walk (recursive). Empty = /Game.
nameContainsstringOnly widget blueprints whose name contains this text.
limitintegerValor 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.

ArgumentoTipoDescripción
folderstringContent folder to walk (recursive). Empty = /Game.
nameContainsstringOnly widget blueprints whose name contains this text.
limitintegerValor 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.

ArgumentoTipoDescripción
folderstring
patternstringobligatorio. Substring to look for in widget names.
replacestringobligatorio. Replacement text.
dryRunbooleanValor predeterminado false.
compilebooleanValor 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.

ArgumentoTipoDescripción
folderstring
fromClassstringobligatorio. Widget class to replace ("TextBlock").
toClassstringobligatorio. Replacement widget class ("RichTextBlock").
copyPropertiesbooleanCopy the properties both classes share. Default true. Valor predeterminado true.
dryRunbooleanValor predeterminado false.
compilebooleanValor 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.

ArgumentoTipoDescripción
folderstring
fromstringobligatorio. Asset currently referenced (texture, material, font...).
tostringobligatorio. Replacement asset.
dryRunbooleanValor predeterminado false.
compilebooleanValor 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.

ArgumentoTipoDescripción
folderstring
nameContainsstring
fontstringFont asset applied to every matching text widget. Empty keeps the font object.
sizeintegerFont size. 0 keeps it. Valor predeterminado 0.
typefacestringTypeface name. Empty keeps it.
classFilterstringWidget class filter. Default TextBlock. Valor predeterminado TEXT("TextBlock").
dryRunbooleanValor predeterminado false.
compilebooleanValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
itemsarray of UeaUmgBatchItemobligatorio. One entry per widget.
compilebooleanCompile 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.

ArgumentoTipoDescripción
folderstring
classFilterstringobligatorio. Widget class the property is written on.
propertystringobligatorio.
valuestringobligatorio. JSON value (see the umg conventions).
dryRunbooleanValor predeterminado false.
compilebooleanValor 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
eventstringobligatorio. Delegate name: OnClicked, OnHovered, OnValueChanged, OnTextCommitted, OnCheckStateChanged...
compilebooleanValor 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 node to it in one call.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
eventstringobligatorio. Widget delegate to bind (OnClicked...).
dispatcherstringobligatorio. Event dispatcher of the widget blueprint to call.
compilebooleanValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
rootWidgetstringClass of a fresh root panel to create after clearing (empty = leave the tree empty).
compilebooleanCompile 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.

ArgumentoTipoDescripción
idstringobligatorio.
widgetstringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
savebooleanSave 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
fromstringobligatorio. Source widget.
toarray of stringobligatorio. Destination widgets.
propertiesarray of stringProperty 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.

ArgumentoTipoDescripción
folderstringobligatorio. Destination content folder ("/Game/UI").
namestringobligatorio. Asset name without path or extension ("WBP_Menu").
parentClassstringParent class, must derive from UserWidget (default "UserWidget").
rootWidgetstringRoot panel class: "CanvasPanel" (default), "VerticalBox", "Overlay", ... or "none" for an empty tree.
designWidthintegerDesigner preview width in pixels (0 = engine default). Valor predeterminado 0.
designHeightintegerDesigner preview height in pixels (0 = engine default). Valor predeterminado 0.
widgetsarray of stringWidget 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.

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.
fromFontstringExisting UFont to copy the composite font from, e.g. "/Engine/EngineFonts/Roboto".
fontFacestringFont face asset to use as the default typeface (alternative to fromFont).
typefacestringName of the default typeface entry. Default "Default". Valor predeterminado TEXT("Default").
sizeintegerLegacy 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.

ArgumentoTipoDescripción
folderstringobligatorio. Destination content folder.
namestringobligatorio. Asset name.
templatestringobligatorio. One of: hud, mainMenu, pauseMenu, dialog, inventoryGrid, healthBar, loadingScreen, settingsList.
parentClassstringParent 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio. Widget blueprint to instance, or a concrete UserWidget class name.
namestringLabel the other runtime tools use to find the instance. Default: the blueprint name.
playerIndexintegerValor predeterminado 0.
addToViewportbooleanAdd it to the player viewport. Default true. Valor predeterminado true.
zOrderintegerValor 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.

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.

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.

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.

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

umg.create_style_asset (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
folderstringobligatorio. Destination content folder, e.g. "/Game/UI/Styles".
namestringobligatorio.
styleClassstringobligatorio. Button, TextBlock, CheckBox, ComboBox, ComboButton, EditableText, EditableTextBox, Progress, ScrollBar, ScrollBox, SpinBox (umg.list_style_classes lists them all).
propertiesarray of UeaKeyValueInitial 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
namestringobligatorio.
parentstringParent widget in the tree. Empty = the root panel.
widgetClassstringConcrete widget class to instance. Empty = the tool's default (a generated blueprint for abstract bases).
stylestringCommon UI style blueprint applied to the new widget.
textstringText of the button label / text block.
propertiesarray of UeaKeyValueExtra property values written on the new widget.
compilebooleanValor 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.

ArgumentoTipoDescripción
tablestringobligatorio.
rowstringobligatorio.
propertiesarray of UeaKeyValueRow 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
namestringobligatorio.
parentstringParent widget in the tree. Empty = the root panel.
widgetClassstringConcrete widget class to instance. Empty = the tool's default (a generated blueprint for abstract bases).
stylestringCommon UI style blueprint applied to the new widget.
textstringText of the button label / text block.
propertiesarray of UeaKeyValueExtra property values written on the new widget.
compilebooleanValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
namestringobligatorio.
parentstringParent widget in the tree. Empty = the root panel.
widgetClassstringConcrete widget class to instance. Empty = the tool's default (a generated blueprint for abstract bases).
stylestringCommon UI style blueprint applied to the new widget.
textstringText of the button label / text block.
propertiesarray of UeaKeyValueExtra property values written on the new widget.
compilebooleanValor 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
namestringobligatorio.
parentstringParent widget in the tree. Empty = the root panel.
widgetClassstringConcrete widget class to instance. Empty = the tool's default (a generated blueprint for abstract bases).
stylestringCommon UI style blueprint applied to the new widget.
textstringText of the button label / text block.
propertiesarray of UeaKeyValueExtra property values written on the new widget.
compilebooleanValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
namestringobligatorio.
parentstringParent widget in the tree. Empty = the root panel.
widgetClassstringConcrete widget class to instance. Empty = the tool's default (a generated blueprint for abstract bases).
stylestringCommon UI style blueprint applied to the new widget.
textstringText of the button label / text block.
propertiesarray of UeaKeyValueExtra property values written on the new widget.
compilebooleanValor 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).

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.
parentClassstringParent class. Empty = CommonActivatableWidget.
rootWidgetstringRoot panel class of the new widget tree. Empty = CanvasPanel.
propertiesarray of UeaKeyValueClass 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).

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.
propertiesarray of UeaKeyValueInitial values of the style class defaults ("NormalBase.TintColor", "MinWidth"...).
parentClassstringParent 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).

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.
propertiesarray of UeaKeyValueInitial values of the style class defaults ("NormalBase.TintColor", "MinWidth"...).
parentClassstringParent 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.

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.

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).

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.
propertiesarray of UeaKeyValueInitial values of the style class defaults ("NormalBase.TintColor", "MinWidth"...).
parentClassstringParent 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).

ArgumentoTipoDescripción
nameContainsstring
placeableOnlybooleanOnly classes that can be placed in a widget tree (skips abstract ones). Valor predeterminado false.
limitintegerValor 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.

ArgumentoTipoDescripción
stylestringobligatorio. 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.

ArgumentoTipoDescripción
tablestringobligatorio.

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.

ArgumentoTipoDescripción
nameContainsstring
placeableOnlybooleanOnly classes that can be placed in a widget tree (skips abstract ones). Valor predeterminado false.
limitintegerValor 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name; empty targets the widget blueprint's class defaults.
stylestringCommon UI style blueprint to apply (buttons and text blocks).
propertiesarray of UeaKeyValue
compilebooleanValor 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...).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name; empty targets the widget blueprint's class defaults.
stylestringCommon UI style blueprint to apply (buttons and text blocks).
propertiesarray of UeaKeyValue
compilebooleanValor 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.

ArgumentoTipoDescripción
propertiesarray of UeaKeyValueobligatorio. Properties of the Common UI input settings to write.
saveConfigbooleanValor 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.

ArgumentoTipoDescripción
stylestringobligatorio.
propertiesarray of UeaKeyValueobligatorio.
compilebooleanValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name; empty targets the widget blueprint's class defaults.
stylestringCommon UI style blueprint to apply (buttons and text blocks).
propertiesarray of UeaKeyValue
compilebooleanValor 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...).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.

Devuelve: widgetBlueprint, issues, commonWidgets, message.

umg.delete (riesgo 3, modifica, destructivo, smoke)​

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

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
newNamestringobligatorio. Name of the copy.
folderstringDestination 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio. Widget to copy (its subtree is copied too).
newNamestringName of the copy.
parentstringParent of the copy; empty = the same parent as the source.
compilebooleanCompile 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.

ArgumentoTipoDescripción
folderstring
outFolderstringOutput folder relative to the project directory. Default "Saved/UeaSmoke". Valor predeterminado TEXT("Saved/UmgTrees").
limitintegerValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
withPropertiesbooleanInclude 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.

ArgumentoTipoDescripción
folderstring
classstringobligatorio. Widget class to look for ("Button", "CommonButtonBase").
includeSubclassesbooleanInclude subclasses of the class. Default true. Valor predeterminado true.
limitintegerValor 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).

ArgumentoTipoDescripción
idstringobligatorio.
namestringWidget name (exact or substring).
classstringWidget 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_*").

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
patternstringobligatorio. 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.

ArgumentoTipoDescripción
assetstringobligatorio. Asset to look for (texture, material, font, widget blueprint...).
folderstring
limitintegerValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
nameContainsstringCase-insensitive substring filter on the property name (read tools only).
propertiesarray of UeaKeyValueProperty assignments on the class default object ("PropertyName" -> JSON or text value).
limitintegerMaximum 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget 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.

ArgumentoTipoDescripción
fontstringobligatorio.

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).

ArgumentoTipoDescripción
idstringobligatorio.
widgetstring
propertystringobligatorio.

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).

ArgumentoTipoDescripción
idstringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
slotstringobligatorio. Named slot widget of the tree.
widgetClassstringWidget class to create inside the slot (exclusive with widget).
widgetstringExisting widget to move into the slot (exclusive with widgetClass).
compilebooleanCompile 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
withPropertiesbooleanInclude 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
categorystringDetails-panel category filter ("Appearance", "Content", ...).
nameContainsstringCase-insensitive substring of the property name.
includeInheritedbooleanInclude properties declared by the base classes (default true). Valor predeterminado true.
limitintegerMaximum 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
propertystringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
fieldsarray of UeaKeyValueSlot 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.

ArgumentoTipoDescripción
stylestringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
depthintegerMaximum depth reported (0 = no limit). Valor predeterminado 0.
withPropertiesbooleanInclude 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio. 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.

ArgumentoTipoDescripción
folderstringContent folder. Empty = /Game.
nameContainsstring
limitintegerValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
withPropertiesbooleanInclude 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.

ArgumentoTipoDescripción
classstringobligatorio. Widget class short name ("Button"), C++ name ("UButton") or widget blueprint path.
includeInheritedbooleanInclude 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget 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.

ArgumentoTipoDescripción
idstringobligatorio.
widgetstringobligatorio. 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.

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.
filestringobligatorio. Absolute path to a .ttf/.otf file on disk.
hintingstringDefault, 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
jsonstringobligatorio. Tree JSON as produced by umg.export_tree, or the path of another widget blueprint whose tree is copied.
replacebooleanReplace the existing tree (default true). When false the imported root is added under the current root. Valor predeterminado true.
compilebooleanCompile 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".

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
classstringobligatorio. Widget class to create.
targetstringobligatorio. Existing widget the new one is positioned against.
positionstring"before" (default), "after" or "into" (as a child of the target panel).
namestringName of the new widget.
compilebooleanCompile 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.

ArgumentoTipoDescripción
idstringobligatorio.
animationstringAnimation 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.

ArgumentoTipoDescripción
folderstringContent folder to search (default "/Game").
parentClassstringOnly blueprints deriving from this class.
nameContainsstringCase-insensitive substring of the asset name.
limitintegerMaximum 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.

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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.

Devuelve: widgetBlueprint, bindings, compileErrors, message.

umg.list_bound_events (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.

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

umg.list_children (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
withPropertiesbooleanInclude 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).

ArgumentoTipoDescripción
folderstringContent folder. Empty = /Game.
nameContainsstring
limitintegerValor predeterminado 200.

Devuelve: fonts, count.

umg.list_field_notify (riesgo 0, UE 5.1+, smoke)​

Variables of the widget blueprint marked as Field Notify.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.

Devuelve: widgetBlueprint, variables, message.

umg.list_fonts (riesgo 0, smoke)​

Font assets under a content folder.

ArgumentoTipoDescripción
folderstringContent folder. Empty = /Game.
nameContainsstring
limitintegerValor 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.

ArgumentoTipoDescripción
playerIndexintegerLocal 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio. 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).

ArgumentoTipoDescripción
nameContainsstringOptional type name filter ("brush", "color", "font").

Devuelve: types, count.

umg.list_style_assets (riesgo 0, smoke)​

Slate widget style assets under a content folder.

ArgumentoTipoDescripción
folderstringContent folder. Empty = /Game.
nameContainsstring
limitintegerValor 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.

ArgumentoTipoDescripción
folderstringContent folder. Empty = /Game.
nameContainsstring
limitintegerValor predeterminado 200.

Devuelve: classes.

umg.list_variables (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.

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.

ArgumentoTipoDescripción
nameContainsstringCase-insensitive substring of the class name.
categorystringPalette category filter ("Common", "Panel", "Input", ...).
includeUserWidgetsbooleanInclude widget blueprint classes found in the content browser (default false). Valor predeterminado false.
limitintegerMaximum 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
classFilterstringOnly widgets of this class (or a subclass of it).
nameContainsstringCase-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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio. Widget to move.
newParentstringNew parent panel; empty = the root widget.
indexintegerInsertion index in the new parent, -1 appends. Valor predeterminado -1.
keepSlotbooleanCopy the compatible slot values to the new slot (default true). Valor predeterminado true.
compilebooleanCompile 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
viewModelstringobligatorio. View model name inside the view (umg.mvvm_list_viewmodels).
viewModelPropertystringobligatorio. Property of the view model to read.
widgetstringobligatorio. Widget of the tree to write to.
widgetPropertystringobligatorio. Widget property to write ("Text", "Percent", "ToolTipText"...).
modestringoneWayToDestination (default), oneWayToSource, twoWay, oneTimeToDestination. Valor predeterminado TEXT("oneWayToDestination").
executionModestringImmediate, Delayed, Tick or DelayedWhenSharedElseImmediate. Empty keeps the default.
enabledbooleanValor predeterminado true.
compilebooleanValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio. Widget whose delegate fires the event.
eventstringobligatorio. Delegate name ("OnClicked").
viewModelstringobligatorio. View model name inside the view.
functionstringobligatorio. View model function to call.
compilebooleanValor 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
viewModelClassstringobligatorio. View model class or blueprint.
namestringName of the view model inside the view. Empty = the class name without prefix.
creationTypestringmanual, createInstance, globalCollection, propertyPath or resolver. Valor predeterminado TEXT("createInstance").
globalIdentifierstringIdentifier used by the global view model collection.
propertyPathstringProperty path used by the propertyPath creation type.
createSetterbooleanGenerate a public setter for the view model. Valor predeterminado false.
compilebooleanValor 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.

ArgumentoTipoDescripción
viewModelstringobligatorio.
namestringobligatorio.
typestringobligatorio.
fieldNotifybooleanValor predeterminado true.
defaultValuestring
compilebooleanValor 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.

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.
parentClassstringParent class. Empty = MVVMViewModelBase.
propertiesarray 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.

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.

ArgumentoTipoDescripción
viewModelstringobligatorio. 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).

ArgumentoTipoDescripción
sourceTypestringSource type name filter ("float", "int", "Text"...).
destinationTypestringDestination type name filter.
nameContainsstring
limitintegerValor 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.

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.

ArgumentoTipoDescripción
sourceTypestringSource type name filter ("float", "int", "Text"...).
destinationTypestringDestination type name filter.
nameContainsstring
limitintegerValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.

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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
indexintegerBinding index from umg.mvvm_list_bindings. -1 uses widget + widgetProperty. Valor predeterminado -1.
widgetstring
widgetPropertystring
compilebooleanValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
namestringobligatorio. View model name inside the view.
compilebooleanValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
namestringobligatorio.
newNamestringobligatorio.
compilebooleanValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
indexintegerobligatorio.
modestringoneWayToDestination, oneWayToSource, twoWay, oneTimeToDestination. Empty keeps it.
enabledbooleanValor predeterminado true.
compileBindingbooleanValor predeterminado true.
compilebooleanValor 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.

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.

ArgumentoTipoDescripción
idstringobligatorio.
animationstringobligatorio.
startTimenumberStart time in seconds. Valor predeterminado 0.0.
loopsinteger0 loops forever. Default 1. Valor predeterminado 1.
modestringforward, reverse, pingpong, pingpongreverse. Valor predeterminado TEXT("forward").
speednumberValor predeterminado 1.0.
restoreStatebooleanRestore 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.

ArgumentoTipoDescripción
playerIndexintegerLocal 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
propertystringobligatorio.
deleteFunctionbooleanAlso delete the generated binding function. Default false. Valor predeterminado false.
compilebooleanValor 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).

ArgumentoTipoDescripción
idstringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
functionstringobligatorio.
compilebooleanValor 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio. Widget to remove.
keepChildrenbooleanRe-parent the children to the removed widget's parent instead of deleting them (default false). Valor predeterminado false.
compilebooleanCompile 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetsarray of stringobligatorio. Widgets to remove.
keepChildrenbooleanRe-parent the children instead of deleting them. Valor predeterminado false.
compilebooleanCompile 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
newNamestringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio. Widget to rename.
newNamestringobligatorio. New name (must be unique in the tree).
compilebooleanCompile 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio. Widget blueprint to render.
filestringobligatorio. Output file, relative to the project directory (e.g. "Saved/UeaSmoke/wbp.png").
widthintegerValor predeterminado 512.
heightintegerValor predeterminado 512.
scalenumberRender scale. Default 1. Valor predeterminado 1.0.
deltaTimenumberDelta 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).

ArgumentoTipoDescripción
classstringobligatorio. UserWidget class: a widget blueprint path or a C++ class name.
filestringobligatorio.
widthintegerValor predeterminado 512.
heightintegerValor predeterminado 512.
scalenumberValor predeterminado 1.0.
deltaTimenumberValor 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio. Widget to reorder inside its parent.
indexstringAbsolute index; leave empty to use shift.
shiftstringRelative move ("-1" up, "2" down).
compilebooleanCompile 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio. Widget to replace.
newClassstringobligatorio. Class of the replacement (a widget blueprint path also works).
keepChildrenbooleanMove the children of the old widget into the new one when both are panels (default true). Valor predeterminado true.
keepNamebooleanKeep the old widget's name for the replacement (default true). Valor predeterminado true.
compilebooleanCompile 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
compilebooleanCompile 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio. Widget to replace with a NamedSlot.
namestringName of the created NamedSlot (default: the widget name with a "Slot_" prefix).
compilebooleanCompile 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
propertystringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
parentstringParent panel the created widgets are added to. Empty = the root panel.
compilebooleanValor predeterminado true.

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

umg.save (riesgo 2, modifica, smoke)​

Saves the widget blueprint package to disk.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio. 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.

ArgumentoTipoDescripción
filestringobligatorio. Output file relative to the project directory.
showUibooleanInclude 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.

ArgumentoTipoDescripción
idstringobligatorio.
widgetstringobligatorio.
optionstringOption text. Use index when empty.
indexintegerValor 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
hAlignstringFill, Left, Center, Right.
vAlignstringFill, 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.

ArgumentoTipoDescripción
strengthstringBlur strength.
radiusstringBlur radius in pixels (needs overrideAutoRadius).
overrideAutoRadiusstring"true"/"false": use radius instead of the computed one (5.x).
applyAlphaToBlurstring"true"/"false".
lowQualityFallbackstringBrush used when blur is unsupported.
paddingstringContent padding {left,top,right,bottom}.
hAlignstring
vAlignstring

Devuelve: widget, class, values.

umg.set_border (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
brushstringBackground brush.
brushColorstringBackground tint {r,g,b,a}.
paddingstringContent padding {left,top,right,bottom}.
contentColorstringContent tint {r,g,b,a}.
hAlignstringFill, Left, Center, Right.
vAlignstringFill, Top, Center, Bottom.
showEffectWhenDisabledstring"true"/"false" (5.x).
desiredSizeScalestringDesired 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
paddingstringPadding "{'left':4,'top':4,'right':4,'bottom':4}" or a single number.
sizeRulestring"auto" or "fill".
sizeValuestringFill weight used with sizeRule=fill.
hAlignstringFill, Left, Center, Right.
vAlignstringFill, 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", ...).

ArgumentoTipoDescripción
propertystringobligatorio. Brush property to write ("Brush", "Background", "WidgetStyle.Normal", ...).
brushstringobligatorio. Brush as {texture

Devuelve: widget, class, values.

umg.set_button (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
backgroundColorstringBackground tint {r,g,b,a}.
colorAndOpacitystringContent tint {r,g,b,a}.
clickMethodstringDownAndUp, MouseDown, PreciseClick.
touchMethodstringDown, DownAndUp, PreciseTap.
pressMethodstringDownAndUp, ButtonPress.
isFocusablestring"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.

ArgumentoTipoDescripción
normalstringNormal state brush.
hoveredstringHovered state brush.
pressedstringPressed state brush.
disabledstringDisabled state brush.
normalPaddingstringPadding in the normal state {left,top,right,bottom}.
pressedPaddingstringPadding in the pressed state.
normalForegroundstringNormal foreground color {r,g,b,a} (5.x).
hoveredForegroundstringHovered foreground color (5.x).
pressedForegroundstringPressed 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
positionstringPosition relative to the anchors, "{'x':40,'y':40}".
sizestringSize in pixels, "{'x':200,'y':50}".
anchorsstringAnchor preset (topLeft, top, topRight, left, center, right, bottomLeft, bottom, bottomRight, fill, fillTop, fillBottom, fillLeft, fillRight) or "{'minX':0,'minY':0,'maxX':1,'maxY':1}".
offsetsstringRaw offsets "{'left':0,'top':0,'right':0,'bottom':0}" (overrides position/size when both are given).
alignmentstringAlignment/pivot inside the slot, "{'x':0.5,'y':0.5}".
autoSizestring"true" sizes the slot to the widget's desired size.
zOrderstringDraw 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.

ArgumentoTipoDescripción
idstringobligatorio.
widgetstringobligatorio.
checkedbooleanValor 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.

ArgumentoTipoDescripción
checkedstring"true"/"false".
statestringUnchecked, Checked, Undetermined (overrides checked).
paddingstringContent padding {left,top,right,bottom}.
checkedImagestringChecked-state image brush.
uncheckedImagestringUnchecked-state image brush.
clickMethodstringDownAndUp, MouseDown, PreciseClick.

Devuelve: widget, class, values.

umg.set_circular_throbber (riesgo 2, modifica, smoke)​

CircularThrobber: number of pieces, period and radius.

ArgumentoTipoDescripción
piecesstringNumber of pieces.
periodstringSeconds for a full turn.
radiusstringCircle radius in pixels.
imagestringPiece 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
nameContainsstringCase-insensitive substring filter on the property name (read tools only).
propertiesarray of UeaKeyValueProperty assignments on the class default object ("PropertyName" -> JSON or text value).
limitintegerMaximum 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
paletteCategorystringPalette category of the generated widget class.
supportsDynamicCreationstring"true"/"false": the widget may be created dynamically at runtime.
canCallPreConstructstring"true"/"false": run PreConstruct in the designer and at runtime.
tickFrequencystringTick frequency: "auto", "never" or "enabled".
isFocusablestring"true"/"false": the widget can receive keyboard focus.
isVolatilestring"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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
valuestringobligatorio. 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.

ArgumentoTipoDescripción
optionsarray of stringReplaces the option list.
selectedstringOption selected by default.
contentPaddingstringContent padding {left,top,right,bottom}.
maxListHeightstringMaximum height of the drop-down in pixels.
hasDownArrowstring"true"/"false": show the drop-down arrow.
fontSizestringFont size in points.
foregroundColorstringText 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, ...).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
valuestringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widthintegerPreview width in pixels. Valor predeterminado 0.
heightintegerPreview height in pixels. Valor predeterminado 0.
modestringSize 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
valuestringobligatorio. 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.

ArgumentoTipoDescripción
entryClassstringWidget blueprint used for each entry.
boxTypestringHorizontal, Vertical, Wrap, Overlay, Radial (engine dependent).
spacingstringSpace between entries {x,y}.
maxDisplayedstringMaximum 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.

ArgumentoTipoDescripción
textstring
hintTextstringPlaceholder shown when empty.
isPasswordstring"true"/"false": show dots instead of characters.
readOnlystring"true"/"false".
justificationstringLeft, Center, Right.
fontSizestringFont size in points.
minDesiredWidthstringMinimum desired width in pixels.
clearKeyboardFocusOnCommitstring"true"/"false".
selectAllTextWhenFocusedstring"true"/"false".
foregroundColorstringText color {r,g,b,a}.

Devuelve: widget, class, values.

umg.set_enabled (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
valuestringobligatorio. 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.

ArgumentoTipoDescripción
expandedstring"true"/"false": start expanded.
headerPaddingstringHeader padding {left,top,right,bottom} (5.x).
areaPaddingstringBody padding {left,top,right,bottom} (5.x).
maxHeightstringMaximum body height in pixels (5.x).
borderColorstringBorder 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
variablestringobligatorio.
enabledbooleanTurn Field Notify on (default) or off. Valor predeterminado true.
compilebooleanValor 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.

ArgumentoTipoDescripción
fontstringFont asset path (UFont or composite font).
typefacestringTypeface name inside the font.
sizestringSize in points.
outlineSizestringOutline thickness in pixels.
outlineColorstringOutline color {r,g,b,a}.
letterSpacingstringExtra letter spacing.
propertystringFont 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.

ArgumentoTipoDescripción
columnFillsarray of UeaKeyValueColumn index -> fill weight ("0" -> "1").
rowFillsarray of UeaKeyValueRow 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
rowstring
columnstring
rowSpanstring
columnSpanstring
layerstringDraw layer inside the grid.
nudgestringPixel nudge "{'x':0,'y':0}".
paddingstring
hAlignstring
vAlignstring

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.

ArgumentoTipoDescripción
texturestringTexture asset path.
materialstringMaterial asset path (exclusive with texture).
sizestringDraw size {x,y}.
tintstringBrush tint {r,g,b,a}.
drawAsstringBox, Border, Image, RoundedBox (5.x), None.
matchSizestring"true" sets the draw size from the texture resolution.
colorAndOpacitystringWidget-level tint {r,g,b,a} multiplied with the brush.
marginstringNine-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.

ArgumentoTipoDescripción
keystringKey name ("SpaceBar", "Gamepad_FaceButton_Bottom").
allowModifiersstring"true"/"false".
allowGamepadstring"true"/"false".
escapeKeysarray of stringKeys that cancel the selection.
keySelectionTextstringText shown while waiting for a key.
noKeySpecifiedTextstringText 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.

ArgumentoTipoDescripción
modestringobligatorio. gameOnly, uiOnly or gameAndUi.
playerIndexintegerValor predeterminado 0.
showCursorbooleanValor predeterminado true.
idstringInstance to focus (uiOnly / gameAndUi).
mouseLockstringMouse 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).

ArgumentoTipoDescripción
idstringobligatorio.
xnumberValor predeterminado 0.0.
ynumberValor predeterminado 0.0.
widthnumberDesired size in the viewport. 0,0 leaves it unset. Valor predeterminado 0.0.
heightnumberValor predeterminado 0.0.
removeDpiScalebooleanRemove 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).

ArgumentoTipoDescripción
idstringobligatorio.
widgetstringSub-widget of the instance. Empty = the instance itself.
propertystringobligatorio.
valuestringobligatorio. 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).

ArgumentoTipoDescripción
idstringobligatorio.
visibilitystringobligatorio. Visible, Collapsed, Hidden, HitTestInvisible, SelfHitTestInvisible.
widgetstringSub-widget inside the instance. Empty = the instance itself.

Devuelve: instance, message.

umg.set_invalidation_box (riesgo 2, modifica, smoke)​

InvalidationBox: caching on or off.

ArgumentoTipoDescripción
canCachestringobligatorio. "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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
isVariablebooleanTrue exposes the widget as a Blueprint variable of the generated class. Valor predeterminado true.
compilebooleanCompile 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.

ArgumentoTipoDescripción
entryClassstringWidget blueprint used for each entry (must implement IUserObjectListEntry).
orientationstringHorizontal, Vertical.
selectionModestringNone, Single, SingleToggle, Multi.
entrySpacingstringSpace between entries in pixels.
scrollbarVisibilitystringVisible, Collapsed, ...
clearSelectionOnClickstring"true"/"false".
itemAlignmentstringEvenlyDistributed, EvenlySize, EvenlyWide, LeftAligned, Fill (tile view, 5.x).
tileWidthstringTile width in pixels (tile view).
tileHeightstringTile 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.

ArgumentoTipoDescripción
namespacestringobligatorio. Localization namespace.
keystringobligatorio. Localization key.
sourcestringobligatorio. Source (native language) string.
propertystringText 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.

ArgumentoTipoDescripción
menuClassstringWidget blueprint opened as the menu.
placementstringComboBox, ComboBoxRight, BelowAnchor, CenteredBelowAnchor, MenuRight, AboveAnchor, ...
fitInWindowstring"true"/"false": keep the menu inside the window.
useApplicationMenuStackstring"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.

ArgumentoTipoDescripción
textstring
hintTextstring
readOnlystring"true"/"false".
justificationstringLeft, Center, Right.
autoWrapstring"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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
slotstringobligatorio. Named slot widget of the tree.
widgetClassstringWidget class to create inside the slot (exclusive with widget).
widgetstringExisting widget to move into the slot (exclusive with widgetClass).
compilebooleanCompile 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").

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
directionstringobligatorio. up, down, left, right, next, previous, or "all" for every direction.
rulestringobligatorio. escape, stop, wrap, explicit, custom, customBoundary.
targetstringTarget 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
paddingstringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
parentClassstringobligatorio. 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.

ArgumentoTipoDescripción
percentstringFill amount 0..1.
fillColorstringFill color {r,g,b,a}.
fillTypestringLeftToRight, RightToLeft, FillFromCenter, TopToBottom, BottomToTop.
marqueestring"true"/"false": indeterminate marquee animation.
barFillStylestringMask, Scale (5.x).
backgroundImagestringBackground image brush.
fillImagestringFill image brush.

Devuelve: widget, class, values.

umg.set_properties (riesgo 2, modifica, smoke)​

Writes several properties of one widget in one call.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
propertiesarray of UeaKeyValueobligatorio. Property name -> value pairs.
compilebooleanCompile 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
propertystringobligatorio. Property name or path.
valuestringobligatorio. New value: plain text or a JSON fragment (see the struct conventions in the kit guide).
compilebooleanCompile 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
classFilterstringobligatorio. Only widgets of this class (or a subclass).
propertystringobligatorio. Property name or path.
valuestringobligatorio. New value.

Devuelve: widgets, count.

umg.set_render_opacity (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
valuestringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
translationstringTranslation as "{'x':0,'y':0}" or "0,0".
scalestringScale as "{'x':1,'y':1}" or a single number.
shearstringShear as "{'x':0,'y':0}".
anglestringRotation angle in degrees.
pivotstringTransform 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.

ArgumentoTipoDescripción
materialstringEffect material applied to the retained render.
textureParameterstringTexture parameter of the material receiving the render target.
phasestringPhase index (renders every phaseCount frames).
phaseCountstringNumber of phases.
retainRenderingstring"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.

ArgumentoTipoDescripción
textstringThe rich text, with
styleSetstringData table of FRichTextStyleRow rows.
decoratorsarray of stringDecorator classes to use.
autoWrapstring"true"/"false": wrap long lines.
minDesiredWidthstringMinimum 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
classstringWidget class to create as the new root (exclusive with widget).
widgetstringExisting widget of the tree to promote to root (exclusive with class).
keepExistingbooleanMove the current root under the new root when it is a panel (default true). Valor predeterminado true.
compilebooleanCompile 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.

ArgumentoTipoDescripción
padLeftstring"true"/"false": pad the left side.
padRightstring
padTopstring
padBottomstring
isTitleSafestring"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.

ArgumentoTipoDescripción
stretchstringNone, Fill, ScaleToFit, ScaleToFitX, ScaleToFitY, ScaleToFill, ScaleBySafeZone, UserSpecified.
stretchDirectionstringBoth, DownOnly, UpOnly.
userScalestringScale used with stretch=UserSpecified.
ignoreInheritedScalestring"true"/"false".

Devuelve: widget, class, values.

umg.set_scroll_box (riesgo 2, modifica, smoke)​

ScrollBox: orientation, scroll bar look and scrolling behaviour.

ArgumentoTipoDescripción
orientationstringHorizontal, Vertical.
barVisibilitystringVisible, Collapsed, Hidden, HitTestInvisible, SelfHitTestInvisible.
barThicknessstringScroll bar thickness {x,y}.
animateWheelstring"true"/"false": smooth wheel scrolling.
allowOverscrollstring"true"/"false": rubber-band past the ends.
scrollWhenFocusChangesstringNoScroll, IntoView.
consumeMouseWheelstring"true"/"false": the box consumes the mouse wheel.
alwaysShowScrollbarstring"true"/"false".
barPaddingstringScroll 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.

ArgumentoTipoDescripción
widthstringFixed width override.
heightstringFixed height override.
minWidthstring
minHeightstring
maxWidthstring
maxHeightstring
minAspectstringMinimum width/height ratio.
maxAspectstringMaximum width/height ratio.
cleararray of stringOverrides 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.

ArgumentoTipoDescripción
valuestring
minValuestring
maxValuestring
stepSizestringKeyboard/controller step size.
orientationstringHorizontal, Vertical.
lockedstring"true"/"false": the handle cannot be moved.
indentHandlestring"true"/"false": the handle is indented into the bar.
barColorstringBar color {r,g,b,a}.
handleColorstringHandle 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.

ArgumentoTipoDescripción
idstringobligatorio.
widgetstringobligatorio.
valuenumberobligatorio.

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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
fieldsarray of UeaKeyValueSlot field assignments ("Padding" -> "8", "HorizontalAlignment" -> "Fill", "LayoutData.Anchors" -> "center").

Devuelve: widget, slotClass, fields, validFields.

umg.set_spacer (riesgo 2, modifica, smoke)​

Spacer: fixed size.

ArgumentoTipoDescripción
sizestringobligatorio. Size {x,y} in pixels.

Devuelve: widget, class, values.

umg.set_spin_box (riesgo 2, modifica, smoke)​

SpinBox: value, ranges, delta and fractional digits.

ArgumentoTipoDescripción
valuestring
minValuestring
maxValuestring
minSliderValuestringLower bound of the slider part.
maxSliderValuestringUpper bound of the slider part.
deltastringIncrement per drag unit (0 = continuous).
minFractionalDigitsstring
maxFractionalDigitsstring
foregroundColorstringText 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"...).

ArgumentoTipoDescripción
stylestringobligatorio.
propertiesarray of UeaKeyValueobligatorio. 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.

ArgumentoTipoDescripción
idstringobligatorio.
widgetstringobligatorio.
indexintegerobligatorio.

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

umg.set_switcher_index (riesgo 2, modifica, smoke)​

WidgetSwitcher: active child by index or by widget name.

ArgumentoTipoDescripción
indexstringIndex of the child to show.
activeWidgetstringName 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.

ArgumentoTipoDescripción
textstringThe text to display.
autoWrapstring"true"/"false": wrap long lines automatically.
justificationstringLeft, Center, Right, InvariantLeft...
colorstringText color {r,g,b,a}.
fontSizestringFont size in points.
fontstringFont asset path.
typefacestringTypeface inside the font ("Bold", "Italic").
shadowOffsetstringShadow offset {x,y}.
shadowColorstringShadow color {r,g,b,a}.
letterSpacingstringExtra spacing between letters (1/1000 em).
minDesiredWidthstringMinimum desired width in pixels.
transformPolicystringNone, ToLower, ToUpper (5.x).
overflowPolicystringClip, Ellipsis (5.x).
wrapTextAtstringWrap 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.

ArgumentoTipoDescripción
idstringobligatorio.
widgetstringobligatorio.
textstringobligatorio.
commitbooleanFire 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
fontstringFont asset path. Empty keeps the current font object.
sizeintegerFont size in points. 0 keeps the current size. Valor predeterminado 0.
typefacestringTypeface name ("Regular", "Bold"...). Empty keeps the current one.
colorstringColour as {r,g,b,a} or a comma list. Empty keeps the current colour.
nameContainsstringOnly widgets whose name contains this text.
compilebooleanValor 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.

ArgumentoTipoDescripción
piecesstringNumber of pieces.
animateHorizontallystring"true"/"false".
animateVerticallystring"true"/"false".
animateOpacitystring"true"/"false".
imagestringPiece image brush (5.x).

Devuelve: widget, class, values.

umg.set_tooltip (riesgo 2, modifica, smoke)​

Sets the tooltip text of a widget.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
valuestringobligatorio. 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).

ArgumentoTipoDescripción
propertiesarray of UeaKeyValueobligatorio. Properties of UUserInterfaceSettings to write ("ApplicationScale", "UIScaleRule", "RenderFocusRule"...).
saveConfigbooleanSave 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.

ArgumentoTipoDescripción
slotPaddingstringPadding of every cell {left,top,right,bottom}.
minSlotWidthstring
minSlotHeightstring

Devuelve: widget, class, values.

umg.set_visibility (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
valuestringobligatorio. 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...).

ArgumentoTipoDescripción
colorstringobligatorio. Color {r,g,b,a} written to the first matching color property of the widget.
slotstringWhich 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").

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
upstringRule for the up direction (escape, stop, wrap, explicit:WidgetName).
downstring
leftstring
rightstring
nextstring
previousstring

Devuelve: widget.

umg.set_widget_style (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
stylestringobligatorio. JSON object written into the widget's style struct ("{'Normal':{'texture':'...'},'NormalPadding':4}").
propertystringStyle 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
textsarray of UeaKeyValueobligatorio. 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.

ArgumentoTipoDescripción
innerSlotPaddingstringPadding between items {x,y}.
wrapSizestringWrap width in pixels (5.x).
explicitWrapSizestring"true"/"false": use wrapSize instead of the available size (5.x).
orientationstringHorizontal, Vertical (5.x).
hAlignstringFill, 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.

ArgumentoTipoDescripción
xnumberobligatorio. Absolute screen X.
ynumberobligatorio. Absolute screen Y.
buttonstringLeftMouseButton (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).

ArgumentoTipoDescripción
keystringobligatorio. FKey name: SpaceBar, Enter, Escape, Gamepad_FaceButton_Bottom...
eventstringpress, release or tap (default). Valor predeterminado TEXT("tap").
controlbooleanValor predeterminado false.
altbooleanValor predeterminado false.
shiftbooleanValor 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).

ArgumentoTipoDescripción
idstringobligatorio.
animationstringAnimation 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringobligatorio.
eventstringobligatorio. Delegate name: OnClicked, OnHovered, OnValueChanged, OnTextCommitted, OnCheckStateChanged...
compilebooleanValor 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).

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget name (empty = the root widget).
compilebooleanCompile 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio. 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.

ArgumentoTipoDescripción
widgetBlueprintstringobligatorio.
widgetstringWidget to wrap (use widgets for several).
widgetsarray of stringWidgets to wrap into a single new panel (they must share a parent).
wrapperClassstringobligatorio. Panel class that becomes their new parent ("SizeBox", "Border", "VerticalBox", ...).
namestringName of the wrapper.
compilebooleanCompile after the change (default true). Valor predeterminado true.

Devuelve: widget.