RealDocs UE 5.6

UMG

1 views

100 entries in this module.

class Classes (19)

UBorder BP A single-child container that renders a configurable background brush (solid color, texture, or material) with padding. UButton BP A clickable container widget that holds a single child widget. UCanvasPanel BP A panel that positions children at arbitrary locations using anchor-based layout with Z-ordering support. UCheckBox BP A widget that toggles between Unchecked, Checked, and Undetermined states. UComboBoxString BP A dropdown widget that displays a list of string options for the user to select one. UEditableTextBox BP A single-line text input widget. UHorizontalBox BP A layout panel that stacks child widgets left-to-right. UImage BP Displays a Slate brush, texture, or material in the UI. UOverlay BP Stacks multiple child widgets on top of each other, each using simple flow layout within its layer. UProgressBar BP A bar that fills left-to-right (or other directions) proportionally to a 0–1 float value. UScrollBox BP A scrollable container that stacks child widgets vertically (or horizontally) with an optional scrollbar. USizeBox BP A single-child wrapper that overrides or constrains the desired size reported by its child widget. USlateBlueprintLibrary BP Blueprint function library exposing Slate geometry and coordinate conversion utilities to Blueprints and C++. UTextBlock BP A static text display widget. UUserWidget BP The base class for all Blueprint UI widgets. UVerticalBox BP A layout panel that automatically stacks child widgets top-to-bottom. UWidget BP The abstract base class for all UMG widgets. UWidgetComponent BP A component that renders a UUserWidget in the 3D world. UWidgetLayoutLibrary BP A Blueprint function library providing utility functions for querying viewport size, DPI scale, mouse position, and for projecting world-space locations into widget space.

function Global Functions (67)

UBorder::GetBrushColor Returns the color and opacity multiplier applied to the border's background brush image. UBorder::GetContentColorAndOpacity Returns the current color and opacity multiplier applied to the border's content. UBorder::GetDesiredSizeScale Returns the current desired-size scale multiplier previously set with SetDesiredSizeScale. UBorder::GetDynamicMaterial BP Returns a dynamic material instance for the border's background brush, creating one from the brush's current material if it isn't already a UMaterialInstanceDynamic. UBorder::GetHorizontalAlignment Returns how the border's content is aligned horizontally within the available space. UBorder::GetPadding Returns the padding applied between the border's edge and its content. UBorder::GetShowEffectWhenDisabled Returns whether the border darkens/desaturates itself using the standard disabled-widget effect when its enabled state is false. UBorder::GetVerticalAlignment Returns how the border's content is aligned vertically within the available space. UBorder::SetBrush BP Replaces the border's entire background brush with a new FSlateBrush, overriding the image, tiling, and margin settings in one call. UBorder::SetBrushColor BP Sets the tint color applied to the border's background brush image. UBorder::SetBrushFromAsset BP Sets the border's background brush by copying the brush definition from a USlateBrushAsset. UBorder::SetBrushFromMaterial BP Sets the border's background brush to render the given material instead of a texture. UBorder::SetBrushFromTexture BP Sets the border's background brush to display the given 2D texture, keeping the brush's other settings unchanged. UBorder::SetContentColorAndOpacity BP Sets the color and opacity multiplier applied to the border's child content, without affecting the border's own background brush. UBorder::SetDesiredSizeScale BP Scales the border's computed desired size, useful for animating things like slide-open panels without hard-coding their target size. UBorder::SetHorizontalAlignment BP Sets how the border's content is aligned horizontally within the space allotted to it. UBorder::SetPadding BP Sets the padding between the border's edge and the content it contains. UBorder::SetShowEffectWhenDisabled BP Sets whether the border applies the standard disabled-widget visual effect when its IsEnabled state is false. UBorder::SetVerticalAlignment BP Sets how the border's content is aligned vertically within the space allotted to it. UButton::GetBackgroundColor Returns the color multiplier currently applied to the button's background brush. UButton::GetClickMethod Returns the mouse action currently required to trigger the button's click — down, up, or precise-click. UButton::GetColorAndOpacity Returns the color multiplier currently applied to the button's content (the widget placed inside it), including its alpha. UButton::GetIsFocusable Returns whether the button can receive keyboard/gamepad focus, or is restricted to mouse-click only interaction. UButton::GetPressMethod Returns the keyboard or gamepad button-press action currently required to trigger the button's click. UButton::GetStyle Returns the button's current visual style, including the brushes used for its normal, hovered, pressed, and disabled states. UButton::GetTouchMethod Returns the touch action currently required to trigger the button's click on touch input devices. UButton::IsPressed BP Returns true while the user is actively holding the button down. UButton::SetAllowDragDrop BP Enables or disables drag-and-drop detection on the button so it can respond to OnButtonDragDetected and related drag events. UButton::SetBackgroundColor BP Sets the color and opacity multiplier applied to the button's background brush across all its visual states. UButton::SetClickMethod BP Sets which mouse interaction pattern triggers the button's OnClicked event. UButton::SetColorAndOpacity BP Sets the color and opacity multiplier applied to the button's child content, not its background. UButton::SetPressMethod BP Sets which keyboard or gamepad interaction pattern triggers the button's OnClicked event when it has focus. UButton::SetStyle BP Replaces the button's entire visual style, including its per-state brushes and click/hover sounds. UButton::SetTouchMethod BP Sets which touch interaction pattern triggers the button's OnClicked event on touch-input platforms. UCanvasPanel::AddChildToCanvas BP Adds a widget as a new child of the canvas panel and returns its slot so you can set its position, size, and anchors. UCanvasPanel::GetCanvasWidget Returns the underlying native Slate widget (SConstraintCanvas) backing this canvas panel, if it has been constructed. UCanvasPanel::GetGeometryForSlot Computes the on-screen geometry (position and size) of a child slot based on the canvas panel's current arranged layout. USlateBlueprintLibrary::AbsoluteToLocal BP Transforms a point from absolute Slate space into a widget's local space. USlateBlueprintLibrary::AbsoluteToViewport BP Converts an absolute desktop-space coordinate into both viewport pixel space and UMG viewport widget space. USlateBlueprintLibrary::LocalToAbsolute BP Transforms a point from a widget's local space into absolute Slate space using the widget's accumulated render transform. USlateBlueprintLibrary::LocalToViewport BP Converts a local widget coordinate into both game-viewport pixel space and UMG viewport widget space in a single call. USlateBlueprintLibrary::Scalar_AbsoluteToLocal BP Converts a scalar value from absolute space to local space by dividing by the geometry's accumulated layout scale. USlateBlueprintLibrary::ScreenToViewport BP Converts a screen-pixel coordinate directly into UMG viewport widget space, suitable for positioning widgets added via AddToViewport at the same logical location. USlateBlueprintLibrary::ScreenToWidgetAbsolute BP Converts a screen-pixel position into absolute Slate application coordinates without knowing the target widget's geometry. USlateBlueprintLibrary::ScreenToWidgetLocal BP Converts a screen-pixel position (as obtained from OS input or GetMousePosition) into the local space of the given widget's geometry. USlateBlueprintLibrary::Vector_LocalToAbsolute BP Transforms a direction vector from a widget's local space into absolute (desktop or window) space. UUserWidget::AddToPlayerScreen BP Adds the widget to the player-owned screen layer rather than the global viewport. UUserWidget::AddToViewport BP Adds this widget to the game's main viewport so it is visible on screen. UUserWidget::GetOwningPlayer BP Returns the APlayerController that owns this widget. UUserWidget::RemoveFromParent BP Removes this widget from its parent — either the viewport or a containing panel widget. UUserWidget::SetDesiredSizeInViewport BP Overrides the size of the widget when it is placed in the viewport via AddToViewport. UUserWidget::SetPositionInViewport BP Sets the position of this widget within the viewport. UUserWidget::SetVisibility BP Sets the visibility of the widget, controlling both rendering and hit-test behaviour. UWidget::GetCachedGeometry BP Returns the geometry from the last time this widget was ticked. UWidget::GetPaintSpaceGeometry BP Returns the geometry from the last paint pass, which reflects the widget's rendered position and size. UWidget::GetTickSpaceGeometry BP Returns the geometry used during the last Tick. UWidget::SetRenderScale BP Sets only the scale component of the widget's render transform, leaving angle, shear, and translation unchanged. UWidget::SetRenderTransform BP Applies a 2D render transform (translation, rotation, scale, shear) to the widget. UWidget::SetRenderTransformAngle BP Sets only the rotation component of the widget's render transform in degrees, leaving translation, scale, and shear unchanged. UWidgetLayoutLibrary::GetMousePositionOnPlatform BP Returns the platform mouse cursor position in absolute desktop coordinates, independent of the game window. UWidgetLayoutLibrary::GetMousePositionOnViewport BP Returns the current mouse cursor position in the local coordinate space of the viewport widget. UWidgetLayoutLibrary::GetMousePositionScaledByDPI BP Returns the player controller's mouse cursor position scaled by (1/DPI). UWidgetLayoutLibrary::GetPlayerScreenWidgetGeometry BP Returns the FGeometry of the player-screen widget container for a specific player. UWidgetLayoutLibrary::GetViewportScale BP Returns the DPI scale factor currently applied to the game viewport. UWidgetLayoutLibrary::GetViewportSize BP Returns the current size of the game viewport in pixels. UWidgetLayoutLibrary::GetViewportWidgetGeometry BP Returns the FGeometry of the root viewport widget — the container that holds all widgets added via AddToViewport. UWidgetLayoutLibrary::ProjectWorldLocationToWidgetPosition BP Projects a world-space 3D location into 2D widget screen space for a specific player, accounting for DPI scaling and optional quality scaling.

property Properties (14)

UBorder::Background BP The brush drawn as the border's background — controls the image, tiling, margins, and tint used to render the border. UBorder::BackgroundDelegate Bindable delegate backing the Background brush property binding in the UMG Designer, letting the brush be driven from a bound function each frame. UBorder::bFlipForRightToLeftFlowDirection Controls whether the border's background image is horizontally flipped when the active culture's localization flow direction is right-to-left. UBorder::BrushColorDelegate Bindable delegate backing the border's BrushColor property binding in the UMG Designer, letting the background tint be driven from a bound function. UBorder::ContentColorAndOpacityDelegate Bindable delegate backing the border's ContentColorAndOpacity property binding in the UMG Designer, letting the content tint be driven from a bound function instead of a static value. UBorder::OnMouseButtonDownEvent BP Bindable event fired when a mouse button is pressed while the pointer is over the border, letting a bound handler consume the input and control the resulting FEventReply. UBorder::OnMouseButtonUpEvent BP Bindable event fired when a mouse button is released while the pointer is over the border, letting a bound handler consume the input and control the resulting FEventReply. UBorder::OnMouseDoubleClickEvent BP Bindable event fired when the border receives a mouse double-click. UBorder::OnMouseMoveEvent BP Bindable event fired when the mouse moves over the border. UButton::OnClicked BP Multicast event broadcast when the user completes a click on the button, per the button's configured ClickMethod. UButton::OnHovered BP Multicast event broadcast when the pointer begins hovering over the button. UButton::OnPressed BP Multicast event broadcast the moment the button is pressed down, before it's released. UButton::OnReleased BP Multicast event broadcast when the button is released after having been pressed. UButton::OnUnhovered BP Multicast delegate broadcast when the pointer stops hovering over the button after having hovered it.