| FSlowTask
|
Module |
|
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
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 |
|
DefaultMessage |
Default message to display to the user when not overridden by a frame |
|
|
FrameMessage |
Message pertaining to the current frame's work |
|
|
TOptional< floa... |
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 |
|
Visibility |
The visibility of this slow task |
Name | Description | |
---|---|---|
|
FSlowTask ( |
Construct this scope from an amount of work to do, and a message to display |
Name | Description | ||
---|---|---|---|
|
Destroy() |
Function that finishes any remaining work and removes itself from the global scope stack |
|
|
EnterProgressFrame ( |
Indicate that we are to enter a frame that will take up the specified amount of work. |
|
|
const FText ... |
GetCurrentMessage() |
Get the frame message or default message if empty |
|
Initialize() |
Function that initializes the scope by adding it to its context's stack |
|
|
MakeDialog |
Creates a new dialog for this slow task, if there is currently not one open |
|
|
MakeDialogDelayed |
Creates a new dialog for this slow task after the given time threshold. |
|
|
ShouldCancel() |
True if the user has requested that the slow task be canceled |
|
|
ShouldCreateThrottledSlowTask() |
True if a slow task should be created. |