IAsyncProgress::GetCompletion

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

Windows
MacOS
Linux

References

Module

Core

Header

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

Include

#include "Async/IAsyncProgress.h"

Syntax

TOptional< float > GetCompletion()

Remarks

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss