Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → UBlueprintCore → UBlueprint → UUserWidgetBlueprint → UBaseWidgetBlueprint → UWidgetBlueprint
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 |
|
| Bindings | TArray< FDelegateEditorBinding > | WidgetBlueprint.h | ||
| PaletteCategory | FString | Don't directly modify this property to change the palette category. | WidgetBlueprint.h |
|
| PropertyBindings | int32 | The total number of property bindings. Consider this as a performance warning. | WidgetBlueprint.h |
|
| ThumbnailCustomSize | FVector2D | WidgetBlueprint.h |
|
|
| ThumbnailImage | TObjectPtr< UTexture2D > | WidgetBlueprint.h |
|
|
| ThumbnailSizeMode | EThumbnailPreviewSizeMode | WidgetBlueprint.h |
|
|
| 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 |
|
| TickPrediction | EWidgetCompileTimeTickPrediction | The computed frequency that the widget will need to be ticked at. | WidgetBlueprint.h |
|
| TickPredictionReason | FString | The reasons we may need to tick this widget. | WidgetBlueprint.h |
|
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 |
WidgetBlueprint.h | ||
virtual bool FindDiffs
(
const UBlueprint* OtherBlueprint, |
WidgetBlueprint.h | ||
virtual void GatherDependencies
(
TSet< TWeakObjectPtr< UBlueprint > >& InDependencies |
WidgetBlueprint.h | ||
virtual void GetAssetRegistryTags
(
TArray< FAssetRegistryTag >& OutTags |
WidgetBlueprint.h | ||
virtual void GetAssetRegistryTags
(
FAssetRegistryTagsContext Context |
WidgetBlueprint.h | ||
virtual UClass * GetBlueprintClass() |
WidgetBlueprint.h | ||
| Gets any named slots exposed by the parent generated class that can be slotted into by the subclass. | WidgetBlueprint.h | ||
| Gets named slots exposed by the parent generated class that already have content in the parent widget tree. | WidgetBlueprint.h | ||
virtual UWidgetEditingProjectSettings * GetRelevantSettings () |
WidgetBlueprint.h | ||
virtual const UWidgetEditingProjectSettings * GetRelevantSettings () |
WidgetBlueprint.h | ||
| WidgetBlueprint.h | |||
UPackage * GetWidgetTemplatePackage() |
WidgetBlueprint.h | ||
TValueOrError< void, UWidget * > HasCircularReferences() |
WidgetBlueprint.h | ||
TValueOrError< void, TSet< UWidget * > > HasConflictingWidgetNamesFromInheritance() |
WidgetBlueprint.h | ||
virtual EDataValidationResult IsDataValid
(
FDataValidationContext& Context |
WidgetBlueprint.h | ||
bool IsWidgetFreeFromCircularReferences
(
UUserWidget* UserWidget |
Returns true if the supplied user widget will not create a circular reference when added to this blueprint | WidgetBlueprint.h | |
| WidgetBlueprint.h | |||
void OnVariableAdded
(
const FName& VariableName |
WidgetBlueprint.h | ||
void OnVariableRemoved
(
const FName& VariableName |
WidgetBlueprint.h | ||
| 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, |
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, |
WidgetBlueprint.h | ||
static bool ValidateGeneratedClass
(
const UClass* InClass |
WidgetBlueprint.h |