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 > Plugins > GameplayAbilities > Abilities > Tasks > UAbilityTask_WaitTargetData

Light Theme

Dark Theme

UAbilityTask_WaitTargetData

Wait for targeting actor (spawned from parameter) to provide data.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGameplayTask

UAbilityTask

UAbilityTask_WaitTargetData

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(NotPlaceable)
class UAbilityTask_WaitTargetData : public UAbilityTask

Remarks

Wait for targeting actor (spawned from parameter) to provide data. Can be set not to end upon outputting data. Can be ended by task name.

WARNING: These actors are spawned once per ability activation and in their default form are not very efficient For most games you will need to subclass and heavily modify this actor, or you will want to implement similar functions in a game-specific actor or blueprint to avoid actor spawn costs This task is not well tested by internal games, but it is a useful class to look at to learn how target replication occurs

Variables

	Name	Description
FWaitTargetData...	Cancelled
TEnumAsByte< EG...	ConfirmationType
FDelegateHandle	OnTargetDataReplicatedCallbackDelegateHandle
AGameplayAbilit...	TargetActor	The TargetActor that we spawned
TSubclassOf< AG...	TargetClass
FWaitTargetData...	ValidData

Constructors

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

Functions

	Name	Description
bool	BeginSpawningActor ( UGameplayAbility* OwningAbilit..., TSubclassOf< AGameplayAbilityTarget..., AGameplayAbilityTargetActor*& ... )
void	FinalizeTargetActor ( AGameplayAbilityTargetActor* S... )
void	FinishSpawningActor ( UGameplayAbility* OwningAbilit..., AGameplayAbilityTargetActor* S... )
void	InitializeTargetActor ( AGameplayAbilityTargetActor* S... )
void	OnTargetDataCancelledCallback ( const FGameplayAbilityTargetDataHan... )	The TargetActor we spawned locally has called back with a cancel event (they still include the 'last/best' targetdata but the consumer of this may want to discard it)
void	OnTargetDataReadyCallback ( const FGameplayAbilityTargetDataHan... )	The TargetActor we spawned locally has called back with valid target data
void	OnTargetDataReplicatedCallback ( const FGameplayAbilityTargetDataHan..., FGameplayTag ActivationTag )	Valid TargetData was replicated to use (we are server, was sent from client)
void	OnTargetDataReplicatedCancelledCallback()	Client canceled this Targeting Task (we are the server)
void	RegisterTargetDataCallbacks()
bool	ShouldReplicateDataToServer()
bool	ShouldSpawnTargetActor()
UAbilityTask...	WaitTargetData ( UGameplayAbility* OwningAbilit..., FName TaskInstanceName, TEnumAsByte< EGameplayTargetingConf..., TSubclassOf< AGameplayAbilityTarget... )	Spawns target actor and waits for it to return valid data or to be canceled.
UAbilityTask...	WaitTargetDataUsingActor ( UGameplayAbility* OwningAbilit..., FName TaskInstanceName, TEnumAsByte< EGameplayTargetingConf..., AGameplayAbilityTargetActor* T... )	Uses specified target actor and waits for it to return valid data or to be canceled.

Overridden from UGameplayTask

	Name	Description
void	Activate()	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
void	ExternalCancel()	Called when the ability is asked to cancel from an outside node.
void	ExternalConfirm ( bool bEndTask )	Called when the ability is asked to confirm from an outside node.
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.

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

Take our survey

Dismiss