1. Epic GamesDeveloper
  3. UWidgetBlueprintGeneratedClass

UWidgetBlueprintGeneratedClass

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

API > API/Runtime > API/Runtime/UMG

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.

   
Name UWidgetBlueprintGeneratedClass
Type class
Header File /Engine/Source/Runtime/UMG/Public/Blueprint/WidgetBlueprintGeneratedClass.h
Include Path #include "Blueprint/WidgetBlueprintGeneratedClass.h"

Syntax

UCLASS (MinimalAPI)  
class UWidgetBlueprintGeneratedClass : public UBlueprintGeneratedClass

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UWidgetBlueprintGeneratedClass()

   Blueprint/WidgetBlueprintGeneratedClass.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Animations TArray< TObjectPtr< UWidgetAnimation > >   Blueprint/WidgetBlueprintGeneratedClass.h  
AvailableNamedSlots TArray< FName > Available Named Slots for content in a subclass. Blueprint/WidgetBlueprintGeneratedClass.h
  • AssetRegistrySearchable
bCanCallInitializedWithoutPlayerContext uint32 Determines whether this widget blueprint can be initialized without a valid player context (PlayerController, etc.). Blueprint/WidgetBlueprintGeneratedClass.h  
bCanCallPreConstruct uint32   Blueprint/WidgetBlueprintGeneratedClass.h
  • Transient
Bindings TArray< FDelegateRuntimeBinding >   Blueprint/WidgetBlueprintGeneratedClass.h  
InstanceNamedSlots TArray< FName > These are the set of named slots that can be used on an instance of the widget. Blueprint/WidgetBlueprintGeneratedClass.h  
NameClashingInHierarchy TSet< FName >   Blueprint/WidgetBlueprintGeneratedClass.h
  • Transient
NamedSlots TArray< FName > All named slots, even the ones that have content already filled into them by a parent class and are not available for extension. Blueprint/WidgetBlueprintGeneratedClass.h  
NamedSlotsWithContentInSameTree TSet< FName >   Blueprint/WidgetBlueprintGeneratedClass.h
  • Transient
NamedSlotsWithID TMap< FName, FGuid > All named slots mapped the assigned GUID of their UNamedSlot widget. Blueprint/WidgetBlueprintGeneratedClass.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bClassRequiresNativeTick uint32 The classes native parent requires a native tick Blueprint/WidgetBlueprintGeneratedClass.h  
Extensions TArray< TObjectPtr< UWidgetBlueprintGeneratedClassExtension > > The extension that are considered static to the class Blueprint/WidgetBlueprintGeneratedClass.h  
WidgetTree TObjectPtr< UWidgetTree > A tree of the widget templates to be created Blueprint/WidgetBlueprintGeneratedClass.h
  • DuplicateTransient

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ClassRequiresNativeTick()

   Blueprint/WidgetBlueprintGeneratedClass.h  

UWidgetBlueprintGeneratedClass * FindWidgetTreeOwningClass()

 Walks up the hierarchy looking for a valid widget tree. Blueprint/WidgetBlueprintGeneratedClass.h  

void ForEachExtension ( Predicate Pred,
bool bIncludeSuper
) const

   Blueprint/WidgetBlueprintGeneratedClass.h  
Find the first extension of the requested type. Blueprint/WidgetBlueprintGeneratedClass.h  

ExtensionType * GetExtension ( bool bIncludeSuper
)

 Find the first extension of the requested type. Blueprint/WidgetBlueprintGeneratedClass.h  
Find the extensions of the requested type. Blueprint/WidgetBlueprintGeneratedClass.h  

void GetNamedSlotArchetypeContent ( TFunctionRef< void(FName, UWidget*)> Predicate
) const

   Blueprint/WidgetBlueprintGeneratedClass.h  

UWidgetTree * GetWidgetTreeArchetype()

   Blueprint/WidgetBlueprintGeneratedClass.h  

void InitializeWidget ( UUserWidget* UserWidget
) const

 This is the function that makes UMG work. Blueprint/WidgetBlueprintGeneratedClass.h  

void SetClassRequiresNativeTick ( bool InClassRequiresNativeTick
)

   Blueprint/WidgetBlueprintGeneratedClass.h  

void SetWidgetTreeArchetype ( UWidgetTree* InWidgetTree
)

   Blueprint/WidgetBlueprintGeneratedClass.h  

Overridden from UClass

Name Remarks Include Path Unreal Specifiers

virtual void PurgeClass ( bool bRecompilingOnLoad
)

   Blueprint/WidgetBlueprintGeneratedClass.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void CollectSaveOverrides ( FObjectCollectSaveOverridesContext SaveContext
)

   Blueprint/WidgetBlueprintGeneratedClass.h  

virtual void GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
) const

   Blueprint/WidgetBlueprintGeneratedClass.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   Blueprint/WidgetBlueprintGeneratedClass.h  

virtual bool NeedsLoadForServer()

   Blueprint/WidgetBlueprintGeneratedClass.h  

virtual void PostLoad()

   Blueprint/WidgetBlueprintGeneratedClass.h  

virtual void Serialize ( FArchive& Ar
)

   Blueprint/WidgetBlueprintGeneratedClass.h  

Static

Name Remarks Include Path Unreal Specifiers

static void BindAnimationsStatic ( UUserWidget* Instance,
const TArrayView< UWidgetAnimation* > InAnimations,
const TMap< FName, FObjectPropertyBase* >& InPropertyMap
)

   Blueprint/WidgetBlueprintGeneratedClass.h  

static void InitializeBindingsStatic ( UUserWidget* UserWidget,
const TArrayView< const FDelegateRuntimeBinding > InBindings,
const TMap< FName, FObjectPropertyBase* >& InPropertyMap
)

   Blueprint/WidgetBlueprintGeneratedClass.h  

static void InitializeWidgetStatic ( UUserWidget* UserWidget,
const UClass* InClass,
UWidgetTree* InWidgetTree,
const UClass* InWidgetTreeWidgetClass,
const TArrayView< UWidgetAnimation* > InAnimations,
const TArrayView< const FDelegateRuntimeBinding > InBindings
)

   Blueprint/WidgetBlueprintGeneratedClass.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page