FSlowTask

Data type used to store information about a currently running slow task.

Windows
MacOS
Linux

Inheritance Hierarchy

FSlowTask

FScopedSlowTask

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/SlowTask.h

Include

#include "Misc/SlowTask.h"

Syntax

struct FSlowTask

Remarks

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

Variables

Name Description

Public variable

float

 

CompletedWork

The amount of work we have already completed in this scope

Public variable

float

 

CurrentFrameScope

The amount of work the current frame is responsible for

Public variable

FText

 

DefaultMessage

Default message to display to the user when not overridden by a frame

Public variable

FText

 

FrameMessage

Message pertaining to the current frame's work

Public variable

TOptional< floa...

 

OpenDialogThreshold

Threshold before dialog is opened

Public variable

double

 

StartTime

The time that this scope was created

Public variable

float

 

TotalAmountOfWork

The amount of work to do in this scope

Public variable

ESlowTaskVisibi...

 

Visibility

The visibility of this slow task

Constructors

Name Description

Public function

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

Functions

Name Description

Public function

void

 

Destroy()

Function that finishes any remaining work and removes itself from the global scope stack

Public function

void

 

EnterProgressFrame

(
    float ExpectedWorkThisFrame,
    FText Text
)

Indicate that we are to enter a frame that will take up the specified amount of work.

Public function Const

FText

 

GetCurrentMessage()

Get the frame message or default message if empty

Public function

void

 

Initialize()

Function that initializes the scope by adding it to its context's stack

Public function

void

 

MakeDialog

(
    bool bShowCancelButton,
    bool bAllowInPIE
)

Creates a new dialog for this slow task, if there is currently not one open

Public function

void

 

MakeDialogDelayed

(
    float Threshold,
    bool bShowCancelButton,
    bool bAllowInPIE
)

Creates a new dialog for this slow task after the given time threshold.

Public function Const

bool

 

ShouldCancel()

True if the user has requested that the slow task be canceled

Public function Static

bool

 

ShouldCreateThrottledSlowTask()

True if a slow task should be created.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback