1. Epic GamesDeveloper
  3. UGameplayTask

UGameplayTask

Unreal Engine C++ API Reference > Runtime > GameplayTasks

Inheritance Hierarchy

References

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

Syntax

class UGameplayTask :  
    public UObject,  
    public IGameplayTaskOwnerInterface

Variables

  Type Name Description
Protected variable uint32: 1 bCaresAboutPriority  
Protected variable uint32: 1 bClaimRequiredResources  
Protected variable uint32: 1 bIsPausable  
Protected variable uint32: 1 bIsSimulating Am I actually running this as a simulated task.
Protected variable uint32: 1 bOwnedByTasksComponent This is set to avoid duplicate calls to task's owner and TasksComponent when both are the same object
Protected variable uint32: 1 bOwnerFinished  
Protected variable uint32: 1 bSimulatedTask Should this task run on simulated clients? This should only be used in rare cases, such as movement tasks.
Protected variable uint32: 1 bTickingTask If true, this task will receive TickTask calls from TasksComponent
Protected variable TObjectPtr< UGameplayTask > ChildTask Child task instance
Protected variable FGameplayResourceSet ClaimedResources Resources that are going to be locked when this task gets activated, but are not required to get this task started
Protected variable FString DebugDescription  
Protected variable FName InstanceName This name allows us to find the task later so that we can end it.
Protected variable uint8 Priority This controls how this task will be treated in relation to other, already running tasks, provided GameplayTasksComponent is configured to care about priorities (the default behavior)
Protected variable FGameplayResourceSet RequiredResources Abstract "resource" IDs this task needs available to be able to get activated.
Protected variable ETaskResourceOverlapPolicy ResourceOverlapPolicy  
Protected variable TWeakInterfacePtr< IGameplayTaskOwnerInterface > TaskOwner Task Owner that created us
Protected variable TWeakObjectPtr< UGameplayTasksComponent > TasksComponent  
Protected variable EGameplayTaskState TaskState You should never access it directly.

Constructors

  Type Name Description
Public function  

UGameplayTask ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Virtual void Called to trigger the actual task once the delegates have been set up Note that the default implementation does nothing and you don't have to call it
Public function void  
Public function void  
Public function void

AddClaimedResourceSet ( const TArray< TSubclassOf< UGameplayTaskResource > >& AdditionalResourcesToClaim
)

  
Public function void

AddClaimedResourceSet ( FGameplayResourceSet AdditionalResourcesToClaim
)

  
Public function void  
Public function void Marks this task as requiring specified resource which has a number of consequences, like task not being able to run if the resource is already taken.
Public function void

AddRequiredResourceSet ( const TArray< TSubclassOf< UGameplayTaskResource > >& RequiredResourceSet
)

  
Public function void  
Protected function Static IGameplayTaskOwnerInterface *

ConvertToTaskOwner ( UObject& OwnerObject
)

  
Protected function Static IGameplayTaskOwnerInterface *

ConvertToTaskOwner ( AActor& OwnerActor
)

  
Public function void

EndTask ()

 Called explicitly to end the task (usually by the task itself).
Public function Virtual void Called when the task is asked to cancel from an outside node.
Public function Virtual void

ExternalConfirm ( bool bEndTask
)

 Called when the task is asked to confirm from an outside node.
Public function Virtual Const FString  
Public function Const AActor * Proper way to get the avatar actor associated with the task owner (usually a pawn, tower, etc)
Public function Const UGameplayTask *  
Public function Const FGameplayResourceSet  
Public function Const const FString &  
Public function Virtual Const FString Return debug string describing task
Public function UGameplayTasksComponent *  
Public function Const UGameplayTasksComponent *  
Public function Const FName  
Public function Const AActor * Proper way to get the owning actor of task owner.
Public function Const uint8  
Public function Const FGameplayResourceSet  
Public function Const ETaskResourceOverlapPolicy  
Public function Const EGameplayTaskState  
Public function Const IGameplayTaskOwnerInterface *  
Public function Const FString  
Public function Virtual Const UWorld * Helper function for getting UWorld off a task
Public function Const bool  
Public function Virtual void

InitSimulatedTask ( UGameplayTasksComponent& InGameplayTasksComponent
)

  
Protected function void

InitTask ( IGameplayTaskOwnerInterface& InTaskOwner,
uint8 InPriority
)

 Initializes the task with the task owner interface instance but does not activate until Activate() is called
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function void Called when a task owner wants to inform the task that it's done and don't want to get notified on task deactivation (i.e. OnGameplayTaskDeactivated).
Public function Static T *

NewTask ( IGameplayTaskOwnerInterface& TaskOwner,
FName InstanceName
)

  
Public function Static T *  
Public function Static T *

NewTask ( UObject* WorldContextObject,
FName InstanceName
)

 Helper function for instantiating and initializing a new task
Public function Static T *

NewTask ( UObject& WorldContextObject,
FName InstanceName
)

  
Public function Static T * Added for consistency with NewTask, but to indicate that a task requires manual call to InitTask This path is used to manually configure some aspects of the task, like Priority
Protected function Virtual void

OnDestroy ( bool bInOwnerFinished
)

 End and CleanUp the task - may be called by the task itself or by the task owner if the owner is ending.
Protected function Virtual void

Pause ()

 Protected by design. Not meant to be called outside from GameplayTaskComponent mechanics
Public function void Called to trigger the actual task once the delegates have been set up
Public function Const bool  
Protected function Virtual void

Resume ()

  
Public function void Called when task owner has "ended" (before the task ends) kills the task. Calls OnDestroy.
Public function Virtual void

TickTask ( float DeltaTime
)

 Tick function for this task, if bTickingTask == true

Overridden from UObject

  Type Name Description
Public function Virtual Const bool IsSupportedForNetworking means an object can be referenced over the network

Overridden from IGameplayTaskOwnerInterface

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

Classes

  Type Name Description
Public class FGenericGameplayTaskDelegate    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page