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 > API/Runtime/UMG/Blueprint

Inheritance Hierarchy

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

  Type Name Description
Public variable TArray< TObjectPtr< UWidgetAnimation > > Animations  
Public variable TArray< FName > AvailableNamedSlots Available Named Slots for content in a subclass.
Public variable uint32: 1 bCanCallPreConstruct  
Public variable TArray< FDelegateRuntimeBinding > Bindings  
Public variable TArray< FName > InstanceNamedSlots These are the set of named slots that can be used on an instance of the widget.
Public variable TArray< FName > NamedSlots All named slots, even the ones that have content already filled into them by a parent class and are not available for extension.
Public variable TMap< FName, FGuid > NamedSlotsWithID All named slots mapped the assigned GUID of their UNamedSlot widget.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const bool  
Public function Const UWidgetBlueprintGeneratedClass * Walks up the hierarchy looking for a valid widget tree.
Public function Const void

ForEachExtension ( Predicate Pred,
bool bIncludeSuper
)

  
Public function ExtensionType *

GetExtension ( bool bIncludeSuper
)

 Find the first extension of the requested type.
Public function UWidgetBlueprintGeneratedClassExtension *

GetExtension ( TSubclassOf< UWidgetBlueprintGeneratedClassExtension > InExtensionType,
bool bIncludeSuper
)

 Find the first extension of the requested type.
Public function TArray< UWidgetBlueprintGeneratedClassExtension * >

GetExtensions ( TSubclassOf< UWidgetBlueprintGeneratedClassExtension > InExtensionType,
bool bIncludeSuper
)

 Find the extensions of the requested type.
Public function Const void  
Public function Const UWidgetTree *  
Public function Const void

InitializeWidget ( UUserWidget* UserWidget
)

 This is the function that makes UMG work.
Public function Static void

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

  
Public function void

SetClassRequiresNativeTick ( bool InClassRequiresNativeTick
)

  
Public function void  

Overridden from UClass

  Type Name Description
Public function Virtual void

PurgeClass ( bool bRecompilingOnLoad
)

 Purges out the properties of this class in preparation for it to be regenerated

Overridden from UObject

  Type Name Description
Public function Virtual Const void 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
Public function Virtual Const bool Called during saving to determine the load flags to save with the object.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page