FInterchangeTaskSystem | Unreal Engine 5.6 Documentation


Name	FInterchangeTaskSystem
Type	class
Header File	/Engine/Source/Runtime/Interchange/Core/Public/InterchangeTaskSystem.h
Include Path	#include "InterchangeTaskSystem.h"

Syntax

class FInterchangeTaskSystem

Name	Remarks	Include Path	Unreal Specifiers
FInterchangeTaskSystem()	The constructor should not be called directly, an ensure will be set if its the case Use the static Get function to acces the singleton.	InterchangeTaskSystem.h

Name	Type	Remarks	Include Path
bIsCreatingSingleton	bool		InterchangeTaskSystem.h

Name	Type	Remarks	Include Path
CancelTaskRequests	TArray< uint64 >		InterchangeTaskSystem.h
CancelTaskRequestsCriticalSection	FCriticalSection		InterchangeTaskSystem.h
OnTaskSystemTick	FOnInterchangeTaskSystemTick		InterchangeTaskSystem.h
PriorityValue	uint64	The priority value is a counter that is increment for each task added to the system to create the task id The lower task id are execute earlier if possible.	InterchangeTaskSystem.h
PriorityValueCriticalSection	FCriticalSection		InterchangeTaskSystem.h
ReleaseAndDoneTasks	TArray< uint64 >	When a task is done, we add it here and release the task.	InterchangeTaskSystem.h
TaskPerIdMap	TMap< uint64, TSharedPtr< FInterchangeTaskBase, ESPMode::ThreadSafe > >	Store the tasks per id.	InterchangeTaskSystem.h
TaskPerIdMapCriticalSection	FCriticalSection		InterchangeTaskSystem.h
TickTickerHandle	FTSTicker::FDelegateHandle	The ticker we use to tick in the engine tick.	InterchangeTaskSystem.h

Name	Remarks	Include Path
uint64 AddTask ( TSharedPtr< FInterchangeTaskBase, ESPMode::ThreadSafe > Task )	Add a task without prerequisite.	InterchangeTaskSystem.h
uint64 AddTask ( TSharedPtr< FInterchangeTaskBase, ESPMode::ThreadSafe > Task, TArray< uint64 >& TaskPrerequisites )	Add a task with some prerequisites.	InterchangeTaskSystem.h
void CancelTask ( const uint64 TaskId, const bool bCancelPrerequisites )	Cancel a task, you can control if you cancel also the prerequisites, and subsequents.	InterchangeTaskSystem.h
EInterchangeTaskStatus GetTaskStatus ( const uint64 TaskId ) const	Return the current task status	InterchangeTaskSystem.h
FOnInterchangeTaskSystemTick & OnTaskSystemTickDelegate()		InterchangeTaskSystem.h
void WaitUntilTasksComplete ( const TArray< uint64 >& TasksToComplete )	Wait can be call only on game thread.	InterchangeTaskSystem.h

Name	Remarks	Include Path	Unreal Specifiers
static FInterchangeTaskSystem & Get()	The interchange task system is a singleton.	InterchangeTaskSystem.h