Navigation
API > API/Runtime > API/Runtime/Core
Base class for all graph tasks, used for both TGraphTask and simple graph events. This is a wrapper around the `Tasks::Private::FTaskBase_ functionality
| Name | FBaseGraphTask |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Async/TaskGraphInterfaces.h |
| Include Path | #include "Async/TaskGraphInterfaces.h" |
Syntax
class FBaseGraphTask : public UE::Tasks::Private::FTaskBase
Inheritance Hierarchy
- FInheritedContextBase → FTaskBase → FBaseGraphTask
- FTaskBase → FBaseGraphTask
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBaseGraphTask
(
const FGraphEventArray* InPrerequisites |
These functions handle integration with FTaskBase and the named thread executor and should not be called directly. | Async/TaskGraphInterfaces.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DispatchSubsequents
(
ENamedThreads::Type CurrentThreadIfKnown |
Backward compatibility wrapper for Unlock | Async/TaskGraphInterfaces.h | |
void DispatchSubsequents
(
TArray< FBaseGraphTask* >& NewTasks, |
Async/TaskGraphInterfaces.h | ||
void DontCompleteUntil
(
FGraphEventRef NestedTask |
Call on a currently active task to add a nested task, which will delay any subsequent tasks until the nested task completes. | Async/TaskGraphInterfaces.h | |
void Execute
(
TArray< FBaseGraphTask* >& NewTasks, |
Async/TaskGraphInterfaces.h | ||
FGraphEventRef GetCompletionEvent() |
Returns a reference to this task that can be used as a prerequisite for new tasks or passed to DontCompleteUntil | Async/TaskGraphInterfaces.h | |
ENamedThreads::Type GetThreadToExecuteOn() |
Returns the old-style named thread this task will be executed on | Async/TaskGraphInterfaces.h | |
void Init
(
const TCHAR* InDebugName, |
Async/TaskGraphInterfaces.h | ||
bool IsComplete() |
Return true if this task has finished executing, this wrapper exists for backward compatibility | Async/TaskGraphInterfaces.h | |
bool IsTaskEvent() |
Returns true if this is a simple task event, which cannot execute code and must be manually dispatched | Async/TaskGraphInterfaces.h | |
void SetDebugName
(
const TCHAR* InDebugName |
Async/TaskGraphInterfaces.h | ||
void Unlock
(
ENamedThreads::Type CurrentThreadIfKnown |
Unlocks a task that was returned from ConstructAndHold or CreateGraphEvent, which may execute immediately if prerequisites are already completed. | Async/TaskGraphInterfaces.h | |
void Wait
(
ENamedThreads::Type CurrentThreadIfKnown |
Blocks the current thread and waits for the completion of this task | Async/TaskGraphInterfaces.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FGraphEventRef CreateGraphEvent() |
Create a simple task event that can be used as a prerequisite for other tasks, and then manually triggered with DispatchSubsequents | Async/TaskGraphInterfaces.h |