Extend UserWidget for UMG Widgets

From Epic Wiki
Jump to: navigation, search


Author: WCode (talk)

Some months back i did a tutorial on how to extend a User Widget for UMG Widgets. Now that UMG is more mature and have gotten scientifically better. I realize that the process of extending the User Widget class is much simpler.

1: We start of by creating a new Blank Project from the launcher.

UMGExtedUserWidget 1a.png

2: After compiling

After compiling the new project and launching your new project you should have something like this in your new project folder.

UMGExtedUserWidget 2a.png

3: In your new project

In your new project in the top left corner Press on the Option «File» File >Add Code to Project

UMGExtedUserWidget 3a.png

4: Add new class

In the new Window that opens up check «Show All Classes» in the top right corner. And enter UserWidget in the search field at the top of the class list. And Select UserWidget.

UMGExtedUserWidget 4a.png

Note: I got a «Error» when making this tutorial related to the editor was unable to hot-reload. Closing the Editor and compiling manualy was the solution.

5: Add the Dependency Module

Now in you IDE (I am using MS Visual Studio) you need to edit your Build file for your project. You need to add the Dependency Module «UMG» to the project.

The edited line in you ProjectName.Build.cs file should be.

PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "UMG" });

Also you need to uncomment the modules for Slate as shown.

// Uncomment if you are using Slate UI
PrivateDependencyModuleNames.AddRange(new string[] { "Slate", "SlateCore" });

Here is a image showing the edited Build file.

UMGExtedUserWidget 5a.png

6: Extending the User Widget

In order to see the difference and for the sake of this tutorial we now open the MyUserWidget.h file in your IDE. And we add the following member to our new UserWidget class.

	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "My New User Widget")
		FString MyNewWidgetName;
UMGExtedUserWidget 6a.png

7: Re-compile your project

Now re-compile your project and open up your project in the editor. And create a new Widget Blueprint.

UMGExtedUserWidget 7a.png

8: Set Parent Class

Open up the new Widget Blueprint and select the Graph in the top right corner. And press on the Class Settings button at the top left. (To the right of the compile button.) In the Details panel (To the bottom left in my Editor) find the category «Class Options» Press on the dropdown menu for Parent Class and select your new User Widget class. (MyUserWidget in this case).

UMGExtedUserWidget 8a.png

9: Compiling Widget and Notes

Compile the Widget and you are done. If you can not see the new member we added earlier make sure you have checked. «Show Inherited Variabels»

UMGExtedUserWidget 9a.png

And you will see the new member in your Blueprint Tab.

UMGExtedUserWidget 9b.png

Notes: That is it this is got alot simpler then before. But i like to list some headers that may come in handy down the road.



You are done, now you have a simple and fast way to extend the user widget. From everything from Data Storage to picking up "events" delegates and so on.

Hope this was helpfull.


Project Download

Here is a link to a Project Download it contains all the information displayed here.
As well as a copy of the finished tutorial.

Related Tutorials

Epic's UMG Documentation

UMG, Create Scrollable List of Clickable Buttons From Dynamic Array, by Rama!

[Tutorial/ Snippet] Creating a UMG Widget in C++, and delegate example by WCode.

[Tutorial] UMG, How to extend a UUserWidget:: for UMG in C++.