1. Epic GamesDeveloper
  3. UCommonLoadGuard

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.

Unreal Engine C++ API Reference > Plugins > CommonUI

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Config&61;Game, defaultconfig&41;  
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

  Type Name Description
Protected variable UProperty Category, EditAnywhere bool bShowLoading  

Constructors

  Type Name Description
Public function  

UCommonLoadGuard ( const FObjectInitializer& Initializer
)

  

Functions

  Type Name Description
Public function void

GuardAndLoadAsset ( const TSoftObjectPtr< ObjectType >& InLazyAsset,
TFunction< void(ObjectType*)> OnAssetLoaded
)

 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.
Public function void

GuardAndLoadAsset ( const TSoftObjectPtr< UObject >& InLazyAsset,
FOnLoadGuardAssetLoaded OnAssetLoaded
)

  
Public function Const UFunction BlueprintCallable, Category bool  
Public function FOnLoadGuardStateChangedEvent &  
Public function UFunction BlueprintCallable, Category void

SetIsLoading ( bool bInIsLoading
)

  
Public function UFunction BlueprintCallable, Category void

SetLoadingText ( const FText& InLoadingText
)

  

Overridden from UPanelWidget

  Type Name Description
Public function Virtual Const UClass * UPanelWidget.
Public function Virtual void

OnSlotAdded ( UPanelSlot* NewSlot
)

  
Public function Virtual void

OnSlotRemoved ( UPanelSlot* OldSlot
)

  

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Public function Virtual void Called after constructing a new widget from the palette.
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Begin UObject.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public class FOnAssetLoaded    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page