UWidgetBlueprintGeneratedClass

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

Windows
MacOS
Linux

Inheritance Hierarchy

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

Name Description

Public variable

TArray< UWidget...

 

Animations

Public variable

uint32: 1

 

bAllowDynamicCreation

Public variable

uint32: 1

 

bAllowTemplate

This indicates that we could template the class

Public variable

uint32: 1

 

bCanCallPreConstruct

Public variable

uint32: 1

 

bCookSlowConstructionWidgetTree

Public variable

TArray< FDelega...

 

Bindings

Public variable

TArray< FName >

 

NamedSlots

Public variable

UWidgetTree ...

 

WidgetTree

A tree of the widget templates to be created

Constructors

Name Description

Public function

UWidgetBlueprintGeneratedClass

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

bool

 

ClassRequiresNativeTick()

Public function

UWidgetBluep...

 

FindWidgetTreeOwningClass()

Walks up the hierarchy looking for a valid widget tree.

Public function

UUserWidget ...

 

GetTemplate()

Public function Const

bool

 

HasTemplate()

Public function Static

void

 

InitializeBindingsStatic

(
    UUserWidget* UserWidget,
    const TArray< FDelegateRuntimeBindi...
)

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,
    bool InHasTemplate,
    bool InAllowDynamicCreation,
    UWidgetTree* InWidgetTree,
    const TArray< UWidgetAnimation*...,
    const TArray< FDelegateRuntimeBindi...
)

Public function

void

 

SetClassRequiresNativeTick

(
    bool InClassRequiresNativeTick
)

Public function

void

 

SetTemplate

(
    UUserWidget* InTemplate
)

Public function Const

bool

 

WillHaveTemplate()

Overridden from UClass

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

Name Description

Public function Virtual Const

bool

 

NeedsLoadForServer()

Called during saving to determine the load flags to save with the object.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

PreSave

(
    const ITargetPlatform* TargetP...
)

Presave function.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

References

Module

UMG

Header

Runtime/UMG/Public/Blueprint/WidgetBlueprintGeneratedClass.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback