RealDocs UE 5.6

UMG

1 views

49 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 (30)

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.