1. Epic GamesDeveloper
  3. UWidgetBlueprint

UWidgetBlueprint

The widget blueprint enables extending UUserWidget the user extensible UWidget.

API > API/Editor > API/Editor/UMGEditor

The widget blueprint enables extending UUserWidget the user extensible UWidget.

   
Name UWidgetBlueprint
Type class
Header File /Engine/Source/Editor/UMGEditor/Public/WidgetBlueprint.h
Include Path #include "WidgetBlueprint.h"

Syntax

UCLASS (BlueprintType)  
class UWidgetBlueprint : public UBaseWidgetBlueprint

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UWidgetBlueprint ( const FObjectInitializer& ObjectInitializer
)

   WidgetBlueprint.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Animations TArray< TObjectPtr< UWidgetAnimation > >   WidgetBlueprint.h  
bCanCallInitializedWithoutPlayerContext bool Determines whether this widget blueprint can be initialized without a valid player context (PlayerController, etc.). WidgetBlueprint.h
  • EditAnywhere
  • Category="Widget"
Bindings TArray< FDelegateEditorBinding >   WidgetBlueprint.h  
PaletteCategory FString Don't directly modify this property to change the palette category. WidgetBlueprint.h
  • AssetRegistrySearchable
PropertyBindings int32 The total number of property bindings. Consider this as a performance warning. WidgetBlueprint.h
  • AssetRegistrySearchable
ThumbnailCustomSize FVector2D   WidgetBlueprint.h
  • EditDefaultsOnly
  • Category=ThumbnailSettings
ThumbnailImage TObjectPtr< UTexture2D >   WidgetBlueprint.h
  • EditDefaultsOnly
  • Category=ThumbnailSettings
ThumbnailSizeMode EThumbnailPreviewSizeMode   WidgetBlueprint.h
  • EditDefaultsOnly
  • Category=ThumbnailSettings
WidgetVariableNameToGuidMap TMap< FName, FGuid > Saved Guids for variables generated by this blueprint (Widgets and Animations). WidgetBlueprint.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
TickFrequency EWidgetTickFrequency The desired tick frequency set by the user on the UserWidget's CDO. WidgetBlueprint.h
  • AssetRegistrySearchable
TickPrediction EWidgetCompileTimeTickPrediction The computed frequency that the widget will need to be ticked at. WidgetBlueprint.h
  • AssetRegistrySearchable
TickPredictionReason FString The reasons we may need to tick this widget. WidgetBlueprint.h
  • AssetRegistrySearchable

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool AllowsDynamicBinding()

   WidgetBlueprint.h  

virtual bool AlwaysCompileOnLoad()

 UWidget blueprints are never data only, should always compile on load (data only blueprints cannot declare new variables) WidgetBlueprint.h  

bool ArePropertyBindingsAllowed()

   WidgetBlueprint.h  

bool DetectSlateWidgetLeaks ( FDataValidationContext& Context
) const

   WidgetBlueprint.h  

virtual bool FindDiffs ( const UBlueprint* OtherBlueprint,
FDiffResults& Results
) const

   WidgetBlueprint.h  

virtual void GatherDependencies ( TSet< TWeakObjectPtr< UBlueprint > >& InDependencies
) const

   WidgetBlueprint.h  

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

   WidgetBlueprint.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   WidgetBlueprint.h  

virtual UClass * GetBlueprintClass()

   WidgetBlueprint.h  

TArray< FName > GetInheritedAvailableNamedSlots()

 Gets any named slots exposed by the parent generated class that can be slotted into by the subclass. WidgetBlueprint.h  

TSet< FName > GetInheritedNamedSlotsWithContentInSameTree()

 Gets named slots exposed by the parent generated class that already have content in the parent widget tree. WidgetBlueprint.h  
  WidgetBlueprint.h  
  WidgetBlueprint.h  

virtual void GetReparentingRules ( TSet< const UClass* >& AllowedChildrenOfClasses,
TSet< const UClass* >& DisallowedChildrenOfClasses
) const

   WidgetBlueprint.h  

UPackage * GetWidgetTemplatePackage()

   WidgetBlueprint.h  

TValueOrError< void, UWidget * > HasCircularReferences()

   WidgetBlueprint.h  

TValueOrError< void, TSet< UWidget * > > HasConflictingWidgetNamesFromInheritance()

   WidgetBlueprint.h  

virtual EDataValidationResult IsDataValid ( FDataValidationContext& Context
) const

   WidgetBlueprint.h  

bool IsWidgetFreeFromCircularReferences ( UUserWidget* UserWidget
) const

 Returns true if the supplied user widget will not create a circular reference when added to this blueprint WidgetBlueprint.h  

virtual void NotifyGraphRenamed ( UEdGraph* Graph,
FName OldName,
FName NewName
)

   WidgetBlueprint.h  

void OnVariableAdded ( const FName& VariableName
)

   WidgetBlueprint.h  

void OnVariableRemoved ( const FName& VariableName
)

   WidgetBlueprint.h  

void OnVariableRenamed ( const FName& OldName,
const FName& NewName
)

   WidgetBlueprint.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   WidgetBlueprint.h  

virtual void PostLoad()

 UObject interface WidgetBlueprint.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   WidgetBlueprint.h  

virtual void ReplaceDeprecatedNodes()

   WidgetBlueprint.h  

virtual void Serialize ( FArchive& Ar
)

   WidgetBlueprint.h  

virtual bool SupportedByDefaultBlueprintFactory()

   WidgetBlueprint.h  

virtual bool SupportsInputEvents()

   WidgetBlueprint.h  

void UpdateTickabilityStats ( bool& OutHasLatentActions,
bool& OutHasAnimations,
bool& OutClassRequiresNativeTick
)

   WidgetBlueprint.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void LoadModulesRequiredForCompilation()

   WidgetBlueprint.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSharedPtr< FKismetCompilerContext > GetCompilerForWidgetBP ( UBlueprint* BP,
FCompilerResultsLog& InMessageLog,
const FKismetCompilerOptions& InCompileOptions
)

   WidgetBlueprint.h  

static bool ValidateGeneratedClass ( const UClass* InClass
)

   WidgetBlueprint.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page