Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > UMG > Blueprint > UWidgetBlueprintGeneratedClass

Light Theme

Dark Theme

UWidgetBlueprintGeneratedClass

The widget blueprint generated class allows us to create blueprint-able widgets for UMG at runtime.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UField

UStruct

UClass

UBlueprintGeneratedClass

UWidgetBlueprintGeneratedClass

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Blueprint/WidgetBlueprintGeneratedClass.h
Include	#include "Blueprint/WidgetBlueprintGeneratedClass.h"

Syntax

class UWidgetBlueprintGeneratedClass : public UBlueprintGeneratedClass

Remarks

The widget blueprint generated class allows us to create blueprint-able widgets for UMG at runtime. All WBPGC's are of UUserWidget classes, and they perform special post initialization using this class to give themselves many of the same capabilities as AActor blueprints, like dynamic delegate binding for widgets.

Variables

	Name	Description
TArray< UWidget...	Animations
uint32: 1	bAllowDynamicCreation
uint32: 1	bAllowTemplate	This indicates that we could template the class
uint32: 1	bCanCallPreConstruct
uint32: 1	bCookSlowConstructionWidgetTree
TArray< FDelega...	Bindings
TArray< FName >	NamedSlots
UWidgetTree ...	WidgetTree	A tree of the widget templates to be created

Constructors

	Name	Description
	UWidgetBlueprintGeneratedClass ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	ClassRequiresNativeTick()
UWidgetBluep...	FindWidgetTreeOwningClass()	Walks up the hierarchy looking for a valid widget tree.
UUserWidget ...	GetTemplate()
bool	HasTemplate()
void	InitializeBindingsStatic ( UUserWidget* UserWidget, const TArray< FDelegateRuntimeBindi... )
void	InitializeWidget ( UUserWidget* UserWidget )	This is the function that makes UMG work.
void	InitializeWidgetStatic ( UUserWidget* UserWidget, const UClass* InClass, bool InHasTemplate, bool InAllowDynamicCreation, UWidgetTree* InWidgetTree, const TArray< UWidgetAnimation*..., const TArray< FDelegateRuntimeBindi... )
void	SetClassRequiresNativeTick ( bool InClassRequiresNativeTick )
void	SetTemplate ( UUserWidget* InTemplate )
bool	WillHaveTemplate()

Overridden from UClass

		Name	Description
	void	PurgeClass ( bool bRecompilingOnLoad )	Purges out the properties of this class in preparation for it to be regenerated

Overridden from UObject

	Name	Description
bool	NeedsLoadForServer()	Called during saving to determine the load flags to save with the object.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreSave ( const ITargetPlatform* TargetP... )	Presave function.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

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

Take our survey

Dismiss