Navigation
API > API/Runtime > API/Runtime/Core
A templated asynchronous task that returns a result payload when complete
| Name | TTask |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Tasks/Task.h |
| Include Path | #include "Tasks/Task.h" |
| Source | /Engine/Source/Runtime/Core/Public/Tasks/TaskPrivate.h |
Syntax
template<typename ResultType>
class TTask : public UE::Tasks::Private::FTaskHandle
Inheritance Hierarchy
- FTaskHandle → TTask
- TTask
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TTask () |
A movable/copyable handle of `Private::TTaskWithResult*_ with the API adopted for public usage. | Tasks/Task.h | |
TTask
(
Private::FTaskBase* Other |
Private constructor, valid instances can be created only by launching (see friends) | Tasks/Task.h |
Class Specializations
| Name | Remarks |
|---|---|
| TTask< ReturnType(ParameterTypes...)> | |
| TTask< void > | A task that does not return a result payload |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FPipe | friend | Tasks/Task.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ResultType & GetResult() |
Waits until the task is completed and returns task's result | Tasks/Task.h |