1. Epic GamesDeveloper
  3. SLoadGuard

SLoadGuard

API > API/Plugins > API/Plugins/CommonUI

   
Name SLoadGuard
Type class
Header File /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonLoadGuard.h
Include Path #include "CommonLoadGuard.h"

Syntax

class SLoadGuard : public SCompoundWidget

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

SLoadGuard()

   CommonLoadGuard.h  

Structs

Name Remarks
FArguments  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bForceShowSpinner bool   CommonLoadGuard.h  
bIsShowingSpinner bool   CommonLoadGuard.h  
ContentBorder TSharedPtr< SBorder >   CommonLoadGuard.h  
GuardBorder TSharedPtr< SBorder >   CommonLoadGuard.h  
GuardTextBlock TSharedPtr< STextBlock >   CommonLoadGuard.h  
LazyAsset TSoftObjectPtr< UObject >   CommonLoadGuard.h  
OnLoadingStateChanged FOnLoadGuardStateChanged   CommonLoadGuard.h  
StreamingHandle TSharedPtr< FStreamableHandle >   CommonLoadGuard.h  
ThrobberSlot SHorizontalBox::FSlot *   CommonLoadGuard.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Construct ( const FArguments& InArgs
)

   CommonLoadGuard.h  

TSharedRef< SBorder > GetContentBorder()

   CommonLoadGuard.h  

void GuardAndLoadAsset ( const TSoftObjectPtr< UObject >& InLazyAsset,
FOnLoadGuardAssetLoaded 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. CommonLoadGuard.h  

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

   CommonLoadGuard.h  

bool IsLoading()

   CommonLoadGuard.h  

void SetContent ( const TSharedRef< SWidget >& InContent
)

   CommonLoadGuard.h  

void SetForceShowSpinner ( bool bInForceShowSpinner
)

   CommonLoadGuard.h  

void SetGuardBackgroundBrush ( const FSlateBrush* InGuardBackground
)

   CommonLoadGuard.h  

void SetGuardText ( const FText& InText
)

   CommonLoadGuard.h  

void SetGuardTextStyle ( const FTextBlockStyle& InGuardTextStyle
)

   CommonLoadGuard.h  

void SetThrobber ( const TSharedPtr< SWidget >& InThrobber
)

   CommonLoadGuard.h  

void SetThrobberHAlign ( EHorizontalAlignment InHAlign
)

   CommonLoadGuard.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FVector2D ComputeDesiredSize ( float
) const

   CommonLoadGuard.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page