FSlowTask | Unreal Engine 5.5 Documentation

Inheritance Hierarchy


Module	Core
Header	/Engine/Source/Runtime/Core/Public/Misc/SlowTask.h
Include	#include "Misc/SlowTask.h"

struct FSlowTask

Data type used to store information about a currently running slow task. Direct use is not advised, use FScopedSlowTask instead

Type	Name	Description
float	CompletedWork	The amount of work we have already completed in this scope
float	CurrentFrameScope	The amount of work the current frame is responsible for
FText	DefaultMessage	Default message to display to the user when not overridden by a frame
FText	FrameMessage	Message pertaining to the current frame's work
TOptional< float >	OpenDialogThreshold	Threshold before dialog is opened
double	StartTime	The time that this scope was created
float	TotalAmountOfWork	The amount of work to do in this scope
ESlowTaskVisibility	Visibility	The visibility of this slow task

	Type	Name	Description
		FSlowTask ( float InAmountOfWork, const FText& InDefaultMessage, bool bInEnabled, FFeedbackContext& InContext )	Construct this scope from an amount of work to do, and a message to display

Type	Name	Description
void	Destroy ()	Function that finishes any remaining work and removes itself from the global scope stack
void	EnterProgressFrame ( float ExpectedWorkThisFrame, const FText& Text )	Indicate that we are to enter a frame that will take up the specified amount of work.
void	ForceRefresh ()	Whenever we encounter edge condition requiring to force a UI refresh (Like if another popup would show when the slow task finishes and you want it to show 100%)
const FText &	GetCurrentMessage ()	Get the frame message or default message if empty
void	Initialize ()	Function that initializes the scope by adding it to its context's stack
void	MakeDialog ( bool bShowCancelButton, bool bAllowInPIE )	Creates a new dialog for this slow task, if there is currently not one open
void	MakeDialogDelayed ( float Threshold, bool bShowCancelButton, bool bAllowInPIE )	Creates a new dialog for this slow task after the given time threshold.
bool	ShouldCancel ()	True if the user has requested that the slow task be canceled
bool	ShouldCreateThrottledSlowTask ()	True if a slow task should be created.
void	TickProgress ()	Let the UI refresh but doesn't advance progress.