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

Light Theme

Dark Theme

UWidgetBlueprint

The widget blueprint enables extending [UUserWidget](API\Runtime\UMG\Blueprint\UUserWidget) the user extensible [UWidget](API\Runtime\UMG\Components\UWidget).

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBlueprintCore

UBlueprint

UBaseWidgetBlueprint

UWidgetBlueprint

UEditorUtilityWidgetBlueprint

References

Module	UMGEditor
Header	/Engine/Source/Editor/UMGEditor/Public/WidgetBlueprint.h
Include	#include "WidgetBlueprint.h"

Syntax

class UWidgetBlueprint : public UBaseWidgetBlueprint

Remarks

The widget blueprint enables extending UUserWidget the user extensible UWidget.

Variables

	Name	Description
TArray< UWidget...	Animations
TArray< FDelega...	Bindings
FString	PaletteCategory	Don't directly modify this property to change the palette category.
int32	PropertyBindings	The total number of property bindings. Consider this as a performance warning.

Constructors

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

Functions

	Name	Description
bool	AllowEditorWidget()	Does the editor support widget from an editor package.
bool	ArePropertyBindingsAllowed()
bool	DetectSlateWidgetLeaks ( TArray< FText >& ValidationErrors )
TSharedPtr< ...	GetCompilerForWidgetBP ( UBlueprint* BP, FCompilerResultsLog& InMessageLog, const FKismetCompilerOptions& InCo... )
UPackage ...	GetWidgetTemplatePackage()
bool	IsWidgetFreeFromCircularReferences ( UUserWidget* UserWidget )	Returns true if the supplied user widget will not create a circular reference when added to this blueprint
void	UpdateTickabilityStats ( bool& OutHasLatentActions, bool& OutHasAnimations, bool& OutClassRequiresNativeTick )
bool	ValidateGeneratedClass ( const UClass* InClass )

Overridden from UBlueprint

	Name	Description
bool	AllowsDynamicBinding()
bool	AlwaysCompileOnLoad()	UWidget blueprints are never data only, should always compile on load (data only blueprints cannot declare new variables)
bool	FindDiffs ( const UBlueprint* OtherBluepri..., FDiffResults& Results )	Fills in a list of differences between this blueprint and another blueprint.
void	GatherDependencies ( TSet< TWeakObjectPtr< UBlueprint >>... )	Collect blueprints that depend on this blueprint.
UClass *	GetBlueprintClass()	Gets the class generated when this blueprint is compiled.
void	GetReparentingRules ( TSet< const UClass* >& Allowe..., TSet< const UClass* >& Disall... )
void	LoadModulesRequiredForCompilation()	Blueprint can choose to load specific modules for compilation.
void	NotifyGraphRenamed ( UEdGraph* Graph, FName OldName, FName NewName )	Notify the blueprint when a graph is renamed to allow for additional fixups.
void	ReplaceDeprecatedNodes()	Checks all nodes in all graphs to see if they should be replaced by other nodes
bool	SupportedByDefaultBlueprintFactory()	Should the generic blueprint factory work for this blueprint?

Overridden from UObject

	Name	Description
void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
EDataValidat...	IsDataValid ( TArray< FText >& ValidationErrors )	Returns Valid if this object has data validation rules set up for it and the data for this object is valid.
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostLoad()	UObject interface
void	PreSave ( const ITargetPlatform* TargetP... )	Presave function.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

		Name	Description
	TArray< FWidget...	AnimationData_DEPRECATED

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

Take our survey

Dismiss