IAsyncProgress Class Reference

#include <IAsyncProgress.h>

Public Member Functions
virtual TOptional< float >	GetCompletion ()=0
virtual FText	GetStatusText ()=0
virtual FSimpleDelegate &	OnProgressChanged ()=0
virtual	~IAsyncProgress ()

Detailed Description

Interface for checking the progress of asynchronous tasks.

Constructor & Destructor Documentation

~IAsyncProgress()

virtual IAsyncProgress::~IAsyncProgress ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

GetCompletion()

virtual TOptional< float > IAsyncProgress::GetCompletion ( )

pure virtual

Gets the task's completion percentage, if available (0.0 to 1.0, or unset).

Tasks should make a best effort to calculate a completion percentage. If the calculation is expensive, the value should be cached and only updated in regular intervals or whenever is appropriate. If a completion percentage cannot be computed at all, the optional return value should be unset.

Returns

Completion percentage value.

See also

GetStatusText

GetStatusText()

virtual FText IAsyncProgress::GetStatusText ( )

pure virtual

Gets a human readable text for the task's current status.

Returns

Status text.

See also

GetCompletion

OnProgressChanged()

virtual FSimpleDelegate & IAsyncProgress::OnProgressChanged ( )

pure virtual

A delegate that is executed if the task's progress changed.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Core/Public/Async/IAsyncProgress.h