Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > CommonUI > UCommonLoadGuard

Light Theme

Dark Theme

UCommonLoadGuard

The Load Guard behaves similarly to a Border, but with the ability to hide its primary content and display a loading spinner and optional message while needed content is loaded or otherwise prepared.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UPanelWidget

UContentWidget

UCommonLoadGuard

References

Module	CommonUI
Header	/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonLoadGuard.h
Include	#include "CommonLoadGuard.h"

Syntax

UCLASS(Config=Game, defaultconfig)
class UCommonLoadGuard : public UContentWidget

Remarks

The Load Guard behaves similarly to a Border, but with the ability to hide its primary content and display a loading spinner and optional message while needed content is loaded or otherwise prepared.

Use GuardAndLoadAsset to automatically display the loading state until the asset is loaded (then the content widget will be displayed). For other applications (ex: waiting for an async backend call to complete), you can manually set the loading state of the guard.

Variables

		Name	Description
	bool	bShowLoading

Constructors

	Name	Description
	UCommonLoadGuard ( const FObjectInitializer& Initiali... )

Functions

	Name	Description
void	GuardAndLoadAsset ( const TSoftObjectPtr< ObjectType > ..., TFunction< void> ... )	Displays the loading spinner until the asset is loaded Will pass a casted pointer to the given asset in the lambda callback - could be nullptr if you provide an incompatible type or invalid asset.
void	GuardAndLoadAsset ( const TSoftObjectPtr< UObject >& I..., FOnLoadGuardAssetLoaded OnAssetLoad... )
bool	IsLoading()
FOnLoadGuard...	OnLoadingStateChanged()
void	SetIsLoading ( bool bInIsLoading )
void	SetLoadingText ( const FText& InLoadingText )

Overridden from UPanelWidget

	Name	Description
UClass *	GetSlotClass()	UPanelWidget.
void	OnSlotAdded ( UPanelSlot* NewSlot )
void	OnSlotRemoved ( UPanelSlot* OldSlot )

Overridden from UWidget

	Name	Description
const FText	GetPaletteCategory()	Gets the palette category of the widget
void	OnCreationFromPalette()	Called by the palette after constructing a new widget, allows the widget to perform interesting default setup that we don't want to be UObject Defaults.
TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
void	SynchronizeProperties()	Applies all properties to the native widget if possible.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from UObject

		Name	Description
	void	PostLoad()	Begin UObject.
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Classes

	Name	Description
	FOnAssetLoaded