Unreal Engine 5 Documentation has been moved to the Epic Developer Community

Widget Components

Describes the Widget Component which is a 3D instance of a Widget Blueprint that can be interacted with in the world.

Choose your operating system:

Windows

macOS

Linux

Widget Components allow you to manifest 3D UI elements created through Unreal Motion Graphics in your game world.

Widget Component

The Widget Component itself is a 3D instance of a Widget Blueprint that you can interact with in your game world.

In the example below, we have added a Widget Component which will now allow us to specify a Widget Class Blueprint.

UMG_3D_21.png

This example uses a Widget Blueprint to display a interactive menu that appears in the game world.

You can change the size of the WidgetComponent in the world by changing the Draw Size or using Draw at Desired Size .

UMG_3D_22.png

Once you place the Actor that contains the WidgetComponent in your level, the Widget Class Blueprint is displayed in the world.

UMG_3D_30.png

Here we have an interactive keypad that sits on a wall.

Widget Component Property Reference

Here are the properties that can be adjusted via the Details panel for the Widget Component.

Option

Description

Space

The coordinate space in which to render the widget (World or Screen). With World the widget is rendered in the world as a mesh while and can be occluded while Screen renders the widget on the screen completely outside of the world and is never occluded.

Widget Class

The class of User Widget to create and display an instance of.

Draw Size

The size of the displayed quad.

Manually Redraw

Should the Widget wait to be told to redraw to actually draw or not.

Redraw Time

The time in between draws, if 0 - redraw every frame. If 1, we would redraw every second. This will work with the Manually Redraw as well. So you can say, manually redraw, but only redraw at this maximum rate.

Window Focusable

Is the virtual window created to host the widget focusable? Should this take focus from the user.

Draw at Desired Size

Causes the render target to automatically match the desired size specified by the Widget Class. Expensive if is done every frame.

Pivot

The alignment/pivot point that the widget is placed at relative to the position.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss