Navigation
API > API/Plugins > API/Plugins/CommonUI
A special Image widget that can show unloaded images and takes care of the loading for you!
| Name | UCommonLazyWidget |
| Type | class |
| Header File | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonLazyWidget.h |
| Include Path | #include "CommonLazyWidget.h" |
Syntax
UCLASS (MinimalAPI)
class UCommonLazyWidget : public UWidget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UCommonLazyWidget
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCommonLazyWidget
(
const FObjectInitializer& ObjectInitializer |
CommonLazyWidget.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BP_OnLoadingStateChanged | FOnLoadGuardStateChangedDynamic | CommonLazyWidget.h |
|
|
| Content | TObjectPtr< UUserWidget > | CommonLazyWidget.h |
|
|
| LoadingBackgroundBrush | FSlateBrush | CommonLazyWidget.h |
|
|
| LoadingThrobberBrush | FSlateBrush | The loading throbber brush | CommonLazyWidget.h |
|
| MyLoadGuard | TSharedPtr< SLoadGuard > | CommonLazyWidget.h | ||
| OnContentChangedEvent | FOnLazyContentChangedEvent | CommonLazyWidget.h | ||
| OnLoadingStateChangedEvent | FOnLoadGuardStateChangedEvent | CommonLazyWidget.h | ||
| StreamingHandle | TSharedPtr< FStreamableHandle > | CommonLazyWidget.h | ||
| StreamingObjectPath | FSoftObjectPath | CommonLazyWidget.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UUserWidget * GetContent() |
CommonLazyWidget.h |
|
|
bool IsLoading() |
CommonLazyWidget.h |
|
|
FOnLazyContentChangedEvent & OnContentChanged() |
CommonLazyWidget.h | ||
FOnLoadGuardStateChangedEvent & OnLoadingStateChanged() |
CommonLazyWidget.h | ||
void SetLazyContent
(
const TSoftClassPtr< UUserWidget > SoftWidget |
CommonLazyWidget.h |
|
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CancelStreaming() |
CommonLazyWidget.h | ||
void OnStreamingComplete
(
TSoftClassPtr< UObject > LoadedSoftObject |
CommonLazyWidget.h | ||
void OnStreamingStarted
(
TSoftClassPtr< UObject > SoftObject |
CommonLazyWidget.h | ||
void SetForceShowSpinner
(
bool bShowLoading |
CommonLazyWidget.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FText GetPaletteCategory() |
CommonLazyWidget.h | ||
virtual void OnWidgetRebuilt() |
CommonLazyWidget.h | ||
virtual TSharedRef< SWidget > RebuildWidget() |
CommonLazyWidget.h | ||
virtual void SynchronizeProperties() |
CommonLazyWidget.h |
Overridden from UVisual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ReleaseSlateResources
(
bool bReleaseChildren |
CommonLazyWidget.h |