Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UAbilityTask_WaitTargetData

UAbilityTask_WaitTargetData

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

API > API/Plugins > API/Plugins/GameplayAbilities > API/Plugins/GameplayAbilities/Abilities > API/Plugins/GameplayAbilities/Abilities/Tasks

Inheritance Hierarchy

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 ()  
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

  Type Name Description
Public variable UProperty BlueprintAssignable FWaitTargetDataDelegate Cancelled  
Protected variable TEnumAsByte< EGameplayTargetingConfirmation::Type > ConfirmationType  
Protected variable FDelegateHandle OnTargetDataReplicatedCallbackDelegateHandle  
Protected variable UProperty TObjectPtr< AGameplayAbilityTargetActor > TargetActor The TargetActor that we spawned
Protected variable UProperty TSubclassOf< AGameplayAbilityTargetActor > TargetClass  
Public variable UProperty BlueprintAssignable FWaitTargetDataDelegate ValidData  

Constructors

  Type Name Description
Public function  

UAbilityTask_WaitTargetData ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual UFunction BlueprintCallable, Category, Meta bool  
Protected function Virtual Const void  
Public function Virtual UFunction BlueprintCallable, Category, Meta void  
Protected function Virtual Const void  
Public function Virtual UFunction void 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)
Public function Virtual UFunction void The TargetActor we spawned locally has called back with valid target data
Public function Virtual UFunction void Valid TargetData was replicated to use (we are server, was sent from client)
Public function Virtual UFunction void Client canceled this Targeting Task (we are the server)
Protected function Virtual void  
Protected function Virtual Const bool  
Protected function Virtual Const bool  
Public function Static UFunction BlueprintCallable, Category, Meta UAbilityTask_WaitTargetData * Spawns target actor and waits for it to return valid data or to be canceled.
Public function Static UFunction BlueprintCallable, Category, Meta UAbilityTask_WaitTargetData * Uses specified target actor and waits for it to return valid data or to be canceled.

Overridden from UGameplayTask

  Type Name Description
Public 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 Virtual void Called when the ability is asked to cancel from an outside node.
Public function Virtual void

ExternalConfirm ( bool bEndTask
)

 Called when the ability is asked to confirm from an outside node.
Protected function Virtual void

OnDestroy ( bool AbilityEnded
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page