FUserWidgetPool

Pools UUserWidget instances to minimize UObject and SWidget allocations for UMG elements with dynamic entries.

Note that if underlying Slate instances are released when a UserWidget instance becomes inactive, NativeConstruct & NativeDestruct will be called when UUserWidget instances are made active or inactive, respectively, provided the widget isn't actively referenced in the Slate hierarchy (i.e. if the shared reference count on the widget goes from/to 0).

WARNING: Be sure to release the pool's Slate widgets within the owning widget's ReleaseSlateResources call to prevent leaking due to circular references Otherwise the cached references to SObjectWidgets will keep the UUserWidgets - and all that they reference - alive


Name	FUserWidgetPool
Type	struct
Header File	/Engine/Source/Runtime/UMG/Public/Blueprint/UserWidgetPool.h
Include Path	#include "Blueprint/UserWidgetPool.h"

Syntax

USTRUCT ()  
struct FUserWidgetPool

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FUserWidgetPool ( UWidget& InOwningWidget )		Blueprint/UserWidgetPool.h
FUserWidgetPool ()		Blueprint/UserWidgetPool.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
~FUserWidgetPool()		Blueprint/UserWidgetPool.h

Typedefs

Name	Type	Remarks	Include Path
WidgetConstructFunc	TFunctionRef< TSharedPtr< SObjectWidget >(UUserWidget *, TSharedRef< SWidget >)>		Blueprint/UserWidgetPool.h

Variables

Protected

Name	Type	Include Path	Unreal Specifiers
ActiveWidgets	TArray< TObjectPtr< UUserWidget > >	Blueprint/UserWidgetPool.h	Transient
CachedSlateByWidgetObject	TMap< UUserWidget *, TSharedPtr< SWidget > >	Blueprint/UserWidgetPool.h
DefaultPlayerController	TWeakObjectPtr< APlayerController >	Blueprint/UserWidgetPool.h
InactiveWidgets	TArray< TObjectPtr< UUserWidget > >	Blueprint/UserWidgetPool.h	Transient
OwningWidget	TWeakObjectPtr< UWidget >	Blueprint/UserWidgetPool.h
OwningWorld	TWeakObjectPtr< UWorld >	Blueprint/UserWidgetPool.h

Functions

Public

Name	Remarks	Include Path
void AddReferencedObjects ( FReferenceCollector& Collector )	Report any references to UObjects to the reference collector (only necessary if this is not already a UPROPERTY)	Blueprint/UserWidgetPool.h
const TArray< UUserWidget * > & GetActiveWidgets()		Blueprint/UserWidgetPool.h
UserWidgetT * GetOrCreateInstance ( TSubclassOf< UserWidgetT > WidgetClass, WidgetConstructFunc ConstructWidgetFunc )	Gets an instance of the widget this factory is for with a custom underlying SObjectWidget type	Blueprint/UserWidgetPool.h
UserWidgetT * GetOrCreateInstance ( TSubclassOf< UserWidgetT > WidgetClass )	Gets an instance of a widget of the given class.	Blueprint/UserWidgetPool.h
bool IsInitialized()		Blueprint/UserWidgetPool.h
void RebuildWidgets()	Triggers RebuildWidget on all currently active UserWidget instances	Blueprint/UserWidgetPool.h
void Release ( TArray< UUserWidget* > Widgets, bool bReleaseSlate )	Return a widget object to the pool, allowing it to be reused in the future	Blueprint/UserWidgetPool.h
void Release ( UUserWidget* Widget, bool bReleaseSlate )	Return a widget object to the pool, allowing it to be reused in the future	Blueprint/UserWidgetPool.h
void ReleaseAll ( bool bReleaseSlate )	Returns all active widget objects to the inactive pool and optionally destroys all cached underlying slate widgets.	Blueprint/UserWidgetPool.h
void ReleaseAllSlateResources()	Reset of all cached underlying Slate widgets, but not the active UUserWidget objects	Blueprint/UserWidgetPool.h
void ReleaseInactiveSlateResources()	Reset of all cached underlying Slate widgets, only for inactive widgets in the pool.	Blueprint/UserWidgetPool.h
void ReleaseSlateResources()		Blueprint/UserWidgetPool.h
void ResetPool()	Full reset of all created widget objects (and any cached underlying slate)	Blueprint/UserWidgetPool.h
void SetDefaultPlayerController ( APlayerController* InDefaultPlayerController )	In the case a pool has no owner widget, a default player controller can optionally be specified allowing greater control	Blueprint/UserWidgetPool.h
void SetWorld ( UWorld* OwningWorld )	In the case that you don't have an owner widget, you should set a world to your pool, or it won't be able to construct widgets.	Blueprint/UserWidgetPool.h

Navigation