1. Epic GamesDeveloper
  3. UGameplayTasksComponent

UGameplayTasksComponent

The core ActorComponent for interfacing with the GameplayAbilities System

Unreal Engine C++ API Reference > Runtime > GameplayTasks

Inheritance Hierarchy

References

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

Syntax

class UGameplayTasksComponent :  
    public UActorComponent,  
    public IGameplayTaskOwnerInterface,  
    public IVisualLoggerDebugSnapshotInterface

Remarks

The core ActorComponent for interfacing with the GameplayAbilities System

Variables

  Type Name Description
Protected variable FGameplayResourceSet CurrentlyClaimedResources Resources used by currently active tasks
Protected variable TArray< TObjectPtr< UGameplayTask > > KnownTasks All known tasks (processed by this component) referenced for GC
Public variable FOnClaimedResourcesChangeSignature OnClaimedResourcesChange  
Protected variable TArray< FGameplayTaskEventData > 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.
Protected variable TArray< TObjectPtr< UGameplayTask > > TaskPriorityQueue  
Protected variable TArray< TObjectPtr< UGameplayTask > > TickingTasks Array of currently active UGameplayTask that require ticking
Protected variable uint8 TopActivePriority Indicates what's the highest priority among currently running tasks

Constructors

  Type Name Description
Public function  

UGameplayTasksComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function bool Add a new simulated task.
Public function void Processes the task and figures out if it should get triggered instantly or wait based on task's RequiredResources, Priority and ResourceOverlapPolicy
Public function Const void  
Public function void  
Public function Const bool  
Public function Const UGameplayTask *

FindResourceConsumingTaskByName ( const FName TaskInstanceName
)

 Finds first resource-consuming task of given name
Public function Const FGameplayResourceSet  
Public function Const GameplayTaskContainerType::TConstIterator  
Public function Const FString  
Public function Const GameplayTaskContainerType::TConstIterator  
Public function Virtual Const bool Retrieves information whether this component should be ticking taken current activity into consideration
Public function Const GameplayTaskContainerType::TConstIterator  
Protected function const TArray< UGameplayTask * > & Tasks that run on simulated proxies
Public function Const FString  
Public function Static FString

GetTaskStateName ( EGameplayTaskState Value
)

  
Public function Const GameplayTaskContainerType::TConstIterator  
Public function Const FString  
Public function Const bool

HasActiveTasks ( UClass* TaskClass
)

  
Public function Static EGameplayTaskRunResult

K2_RunGameplayTask ( TScriptInterface< IGameplayTaskOwnerInterface > TaskOwner,
UGameplayTask* Task,
uint8 Priority,
TArray< TSubclassOf< UGameplayTaskResource > > AdditionalRequiredResources,
TArray< TSubclassOf< UGameplayTaskResource > > AdditionalClaimedResources
)

  
Public function void

OnRep_SimulatedTasks ( const TArray< UGameplayTask* >& PreviousSimulatedTasks
)

  
Protected function void  
Public function void  
Protected function void Remove an existing simulated task
Protected function void  
Public function Static EGameplayTaskRunResult

RunGameplayTask ( IGameplayTaskOwnerInterface& TaskOwner,
UGameplayTask& Task,
uint8 Priority,
FGameplayResourceSet AdditionalRequiredResources,
FGameplayResourceSet AdditionalClaimedResources
)

  
Protected function void  
Protected function void

SetSimulatedTasks ( const TArray< UGameplayTask* >& NewSimulatedTasks
)

 Remove all current tasks and register the one in the passed array.
Public function void  
Protected function void  

Overridden from UActorComponent

  Type Name Description
Public function Virtual void ReadyForReplication gets called on replicated components when their owning actor is officially ready for replication.
Public function Virtual bool Allows a component to replicate other subobject on the actor.
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Public function Virtual Const void Returns properties that are replicated for the lifetime of the actor channel

Overridden from IGameplayTaskOwnerInterface

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

Overridden from IVisualLoggerDebugSnapshotInterface

  Type Name Description
Public function Virtual Const void  

Classes

  Type Name Description
Protected struct FEventLock    

Typedefs

Name Description
GameplayTaskContainerType  

Deprecated Functions

  Type Name Description
Protected function TArray< TObjectPtr< UGameplayTask > > & This will be removed in future versions. Use AddSimulatedTask or RemoveSimulatedTask to modify the array

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page