Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Plugins > GameplayAbilities > Abilities > Tasks > UAbilityTask

Light Theme

Dark Theme

UAbilityTask

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGameplayTask

UAbilityTask

UAbilityTask_ApplyRootMotion_Base

	UAbilityTask_ApplyRootMotionConstantForce
	UAbilityTask_ApplyRootMotionJumpForce
	UAbilityTask_ApplyRootMotionMoveToActorForce
	UAbilityTask_ApplyRootMotionMoveToForce
	UAbilityTask_ApplyRootMotionRadialForce

UAbilityTask_MoveToLocation

UAbilityTask_NetworkSyncPoint

UAbilityTask_PlayMontageAndWait

UAbilityTask_Repeat

UAbilityTask_SpawnActor

UAbilityTask_StartAbilityState

UAbilityTask_VisualizeTargeting

UAbilityTask_WaitAbilityActivate

UAbilityTask_WaitAbilityCommit

UAbilityTask_WaitAttributeChange

UAbilityTask_WaitAttributeChangeRatioThreshold

UAbilityTask_WaitAttributeChangeThreshold

UAbilityTask_WaitCancel

UAbilityTask_WaitConfirm

UAbilityTask_WaitConfirmCancel

UAbilityTask_WaitDelay

UAbilityTask_WaitGameplayEffectApplied

	UAbilityTask_WaitGameplayEffectApplied_Self
	UAbilityTask_WaitGameplayEffectApplied_Target

UAbilityTask_WaitGameplayEffectBlockedImmunity

UAbilityTask_WaitGameplayEffectRemoved

UAbilityTask_WaitGameplayEffectStackChange

UAbilityTask_WaitGameplayEvent

UAbilityTask_WaitGameplayTag

	UAbilityTask_WaitGameplayTagAdded
	UAbilityTask_WaitGameplayTagRemoved

UAbilityTask_WaitInputPress

UAbilityTask_WaitInputRelease

UAbilityTask_WaitMovementModeChange

UAbilityTask_WaitOverlap

UAbilityTask_WaitTargetData

UAbilityTask_WaitVelocityChange

References

Module	GameplayAbilities
Header	/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/Abilities/Tasks/AbilityTask.h
Include	#include "Abilities/Tasks/AbilityTask.h"

Syntax

UCLASS(Abstract)
class UAbilityTask : public UGameplayTask

Variables

	Name	Description
UGameplayAbilit...	Ability	GameplayAbility that created us
UAbilitySystemC...	AbilitySystemComponent
uint8: 1	bWasSuccessfullyDestroyed
uint8	WaitStateBitMask	What we are waiting on

Constructors

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

Functions

	Name	Description
bool	CallOrAddReplicatedDelegate ( EAbilityGenericReplicatedEvent::Typ..., FSimpleMulticastDelegate::FDelegate... )	Helper method for registering client replicated callbacks
void	ClearWaitingOnAvatar()
void	ClearWaitingOnRemotePlayerData()
bool	DelayedFalse()
FGameplayAbi...	GetAbilitySpecHandle()	Returns spec handle for owning ability
FPredictionK...	GetActivationPredictionKey()	Returns ActivationPredictionKey of owning ability
bool	IsForRemoteClient()	Returns true if we are executing the ability on the server for a non locally controlled client
bool	IsLocallyControlled()	Returns true if we are executing the ability on the locally controlled client
bool	IsPredictingClient()	Returns true if the ability is a locally predicted ability running on a client.
T *	NewAbilityTask ( UGameplayAbility* ThisAbility, FName InstanceName )	Helper function for instantiating and initializing a new task
T *	NewTask ( UObject* WorldContextObject, FName InstanceName )	This function has been added to make sure AbilityTasks don't use this method
void	SetAbilitySystemComponent ( UAbilitySystemComponent* InAbi... )
void	SetWaitingOnAvatar()	Same as RemotePlayerData but for ACharacter type of state (movement state, etc)
void	SetWaitingOnRemotePlayerData()	Called when the ability task is waiting on remote player data.
bool	ShouldBroadcastAbilityTaskDelegates()	This should be called prior to broadcasting delegates back into the ability graph.

Overridden from UGameplayTask

	Name	Description
void	InitSimulatedTask ( UGameplayTasksComponent& InGamepla... )
bool	IsWaitingOnAvatar()
bool	IsWaitingOnRemotePlayerdata()
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.

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.

Constants

Name	Description
GlobalAbilityTaskCount