Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > GameplayTasks > UGameplayTasksComponent

Light Theme

Dark Theme

UGameplayTasksComponent

The core ActorComponent for interfacing with the GameplayAbilities System

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UGameplayTasksComponent

	UAbilitySystemComponent
	UMockGameplayTasksComponent

References

Module	GameplayTasks
Header	/Engine/Source/Runtime/GameplayTasks/Classes/GameplayTasksComponent.h
Include	#include "GameplayTasksComponent.h"

Syntax

class UGameplayTasksComponent :
public UActorComponent,
public IGameplayTaskOwnerInterface

Remarks

The core ActorComponent for interfacing with the GameplayAbilities System

Variables

	Name	Description
uint8: 1	bIsNetDirty	Set to indicate that GameplayTasksComponent needs immediate replication.
FGameplayResour...	CurrentlyClaimedResources	Resources used by currently active tasks
TArray< UGamepl...	KnownTasks	All known tasks (processed by this component) referenced for GC
FOnClaimedResou...	OnClaimedResourcesChange
TArray< FGamepl...	TaskEvents	Transient array of events whose main role is to avoid long chain of recurrent calls if an activated/paused/removed task wants to push/pause/kill other tasks.
TArray< UGamepl...	TaskPriorityQueue
TArray< UGamepl...	TickingTasks	Array of currently active UGameplayTask that require ticking
uint8	TopActivePriority	Indicates what's the highest priority among currently running tasks

Constructors

	Name	Description
	UGameplayTasksComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddTaskReadyForActivation ( UGameplayTask& NewTask )	Processes the task and figures out if it should get triggered instantly or wait based on task's RequiredResources, Priority and ResourceOverlapPolicy
void	DescribeSelfToVisLog ( FVisualLogEntry* Snapshot )
void	EndAllResourceConsumingTasksOwnedBy ( const IGameplayTaskOwnerInterface&... )
bool	FindAllResourceConsumingTasksOwnedBy ( const IGameplayTaskOwnerInterface&..., TArray< UGameplayTask* >& Fou... )
UGameplayTas...	FindResourceConsumingTaskByName ( const FName TaskInstanceName )	Finds first resource-consuming task of given name
FGameplayRes...	GetCurrentlyUsedResources()
FConstGamepl...	GetKnownTaskIterator()
FString	GetKnownTasksDescription()
FConstGamepl...	GetPriorityQueueIterator()
bool	GetShouldTick()	Retrieves information whether this component should be ticking taken current activity into consideration
const TArray...	GetSimulatedTasks()
TArray< UGam...	GetSimulatedTasks_Mutable()
FString	GetTasksPriorityQueueDescription()
FString	GetTaskStateName ( EGameplayTaskState Value )
FConstGamepl...	GetTickingTaskIterator()
FString	GetTickingTasksDescription()
bool	HasActiveTasks ( UClass* TaskClass )
EGameplayTas...	K2_RunGameplayTask ( TScriptInterface< IGameplayTaskOwne..., UGameplayTask* Task, uint8 Priority, TArray< TSubclassOf< UGameplayTaskR..., TArray< TSubclassOf< UGameplayTaskR... )
void	OnRep_SimulatedTasks()
void	ProcessTaskEvents()
void	RemoveResourceConsumingTask ( UGameplayTask& Task )
void	RequestTicking()
EGameplayTas...	RunGameplayTask ( IGameplayTaskOwnerInterface& TaskO..., UGameplayTask& Task, uint8 Priority, FGameplayResourceSet AdditionalRequ..., FGameplayResourceSet AdditionalClai... )
void	SetCurrentlyClaimedResources ( FGameplayResourceSet NewClaimedSet )
void	SetSimulatedTasks ( const TArray< UGameplayTask* >... )
void	UpdateShouldTick()
void	UpdateTaskActivations()

Overridden from UActorComponent

		Name	Description
	bool	ReplicateSubobjects ( UActorChannel* Channel, FOutBunch* Bunch, FReplicationFlags* RepFlags )	Allows a component to replicate other subobject on the actor
	void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

Overridden from UObject

		Name	Description
	void	GetLifetimeReplicatedProps ( TArray< FLifetimeProperty >& OutLi... )	Returns properties that are replicated for the lifetime of the actor channel

Overridden from IGameplayTaskOwnerInterface

	Name	Description
AActor *	GetGameplayTaskAvatar ( const UGameplayTask* Task )	Get "body" of task's owner / default, having location in world (e.g. Owner = AIController, Avatar = Pawn)
AActor *	GetGameplayTaskOwner ( const UGameplayTask* Task )	Get owner of a task or default one when task is null
UGameplayTas...	GetGameplayTasksComponent ( const UGameplayTask& Task )	Finds tasks component for given GameplayTask, Task.GetGameplayTasksComponent() may not be initialized at this point!
void	OnGameplayTaskActivated ( UGameplayTask& Task )	Notify called after GameplayTask changes state to Active (initial activation or resuming)
void	OnGameplayTaskDeactivated ( UGameplayTask& Task )	Notify called after GameplayTask changes state from Active (finishing or pausing)

Classes

	Name	Description
	FEventLock

Deprecated Variables

		Name	Description
	TArray< UGamepl...	SimulatedTasks	This will be made private in future versions. Use GetSimulatedTasks, GetSimulatedTasks_Mutable, or SetSimulatedTasks instead.

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

Take our survey

Dismiss