FTaskHandle | Unreal Engine 5.8 Documentation

Base implementation used by TTask to provide handle functionality


Name	FTaskHandle
Type	class
Header File	/Engine/Source/Runtime/Core/Public/Tasks/Task.h
Include Path	#include "Tasks/Task.h"

Syntax

class FTaskHandle

Name	Remarks	Include Path	Unreal Specifiers
FTaskHandle ()		Tasks/Task.h
FTaskHandle ( FTaskBase* Other )		Tasks/Task.h

Name	Type	Remarks	Include Path
FTaskHandleId	void		Tasks/Task.h

Name	Type	Remarks	Include Path	Unreal Specifiers
FTaskBase	friend	Friends to get access to `Pimpl_	Tasks/Task.h

Name	Remarks	Include Path
EExtendedTaskPriority GetExtendedPriority()	Gets the extended priority this task was initialized with	Tasks/Task.h
ETaskPriority GetPriority()	Gets the priority this task was initialized with	Tasks/Task.h
bool IsAwaitable()	Returns true if it is valid to Wait on this task	Tasks/Task.h
bool IsCompleted()	Checks if task's execution is done	Tasks/Task.h
bool IsValid()	True if the task has been correctly initialized and not yet destroyed	Tasks/Task.h
void Launch ( const TCHAR* DebugName, TaskBodyType&& TaskBody, ETaskPriority Priority, EExtendedTaskPriority ExtendedPriority, ETaskFlags Flags )	Launches a task for asynchronous execution	Tasks/Task.h
void Launch ( const TCHAR* DebugName, TaskBodyType&& TaskBody, PrerequisitesCollectionType&& Prerequisites, ETaskPriority Priority, EExtendedTaskPriority ExtendedPriority, ETaskFlags Flags )	Launches a task for asynchronous execution, with prerequisites that must be completed before the task is scheduled	Tasks/Task.h
bool TryRetractAndExecute()	Try to finish the task on the current thread if it's not already started.	Tasks/Task.h
bool Wait ()	Waits for task's completion without timeout.	Tasks/Task.h
bool Wait ( FTimespan Timeout ) const	Waits for task's completion with timeout.	Tasks/Task.h

Name	Remarks	Include Path	Unreal Specifiers
bool operator!= ( const FTaskHandle& Other ) const		Tasks/Task.h
bool operator== ( const FTaskHandle& Other ) const		Tasks/Task.h