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 > UGameplayAbility

Light Theme

Dark Theme

UGameplayAbility

Abilities define custom gameplay logic that can be activated by players or external game logic

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGameplayAbility

	UGameplayAbility_CharacterJump
	UGameplayAbility_Montage

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable)
class UGameplayAbility :
public UObject,
public IGameplayTaskOwnerInterface

Remarks

Abilities define custom gameplay logic that can be activated by players or external game logic

Variables

	Name	Description
FGameplayTagCon...	AbilityTags	Public variables, exposed for backwards compatibility This ability has these tags
TArray< FAbilit...	AbilityTriggers	Triggers to determine if this ability should execute in response to an event
FGameplayTagCon...	ActivationBlockedTags	This ability is blocked if the activating actor/component has any of these tags
FGameplayTagCon...	ActivationOwnedTags	Tags to apply to activating owner while this ability is active
FGameplayTagCon...	ActivationRequiredTags	This ability can only be activated if the activating actor/component has all of these tags
TArray< UGamepl...	ActiveTasks	List of currently active tasks, do not modify directly
bool	bHasBlueprintActivate
bool	bHasBlueprintActivateFromEvent
bool	bHasBlueprintCanUse
bool	bHasBlueprintShouldAbilityRespondToEvent
bool	bIsAbilityEnding	True if the end ability has been called, but has not yet completed.
bool	bIsActive	True if the ability is currently active. For instance per owner abilities
bool	bIsBlockingOtherAbilities	True if the ability block flags are currently enabled
bool	bIsCancelable	True if the ability is currently cancelable, if not will only be canceled by hard EndAbility calls
FGameplayTagCon...	BlockAbilitiesWithTag	Abilities with these tags are blocked while this ability is active
bool	bMarkPendingKillOnAbilityEnd	Flag that is set by AbilitySystemComponent::OnRemoveAbility to indicate the ability needs to be cleaned up in AbilitySystemComponent::NotifyAbilityEnded
bool	bReplicateInputDirectly	If true, this ability will always replicate input press/release events to the server.
bool	bRetriggerInstancedAbility	If true, and trying to activate an already active instanced ability, end it and re-trigger it.
bool	bServerRespectsRemoteAbilityCancellation	If this is set, the server-side version of the ability can be canceled by the client-side version.
FGameplayTagCon...	CancelAbilitiesWithTag	Ability exclusion / canceling
TArray< FName >	CancelTaskInstanceNames
TSubclassOf< cl...	CooldownGameplayEffectClass	This GameplayEffect represents the cooldown.
TSubclassOf< cl...	CostGameplayEffectClass	This GameplayEffect represents the cost (mana, stamina, etc) of the ability.
FGameplayAbilit...	CurrentActivationInfo	This is information specific to this instance of the ability.
const FGameplay...	CurrentActorInfo	This is shared, cached information about the thing using us E.g, Actor, MovementComponent, AnimInstance, etc.
FGameplayEventD...	CurrentEventData	Information specific to this instance of the ability, if it was activated by an event
UAnimMontage &#...	CurrentMontage	Active montage being played by this ability
FGameplayAbilit...	CurrentSpecHandle	For instanced abilities
TArray< FName >	EndTaskInstanceNames
TEnumAsByte< EG...	InstancingPolicy	How the ability is instanced when executed.
TEnumAsByte< EG...	NetExecutionPolicy	How does an ability execute on the network.
TEnumAsByte< EG...	NetSecurityPolicy	What protections does this ability have? Should the client be allowed to request changes to the execution of the ability?
FGenericAbility...	OnConfirmDelegate	Callback for when this ability has been confirmed by the server
FOnGameplayAbil...	OnGameplayAbilityCancelled	Notification that the ability is being cancelled. Called before OnGameplayAbilityEnded.
FOnGameplayAbil...	OnGameplayAbilityEnded	Notification that the ability has ended. Set using TryActivateAbility.
FGameplayAbilit...	OnGameplayAbilityEndedWithData	Notification that the ability has ended with data on how it was ended
FOnGameplayAbil...	OnGameplayAbilityStateEnded	Used by the ability state task to handle when a state is ended
bool	RemoteInstanceEnded	Set when the remote instance of this ability has ended (but the local instance may still be running or finishing up
TEnumAsByte< EG...	ReplicationPolicy	Protected properties
int8	ScopeLockCount	A count of all the current scope locks.
FGameplayTagCon...	SourceBlockedTags	This ability is blocked if the source actor/component has any of these tags
FGameplayTagCon...	SourceRequiredTags	This ability can only be activated if the source actor/component has all of these tags
FGameplayTagCon...	TargetBlockedTags	This ability is blocked if the target actor/component has any of these tags
FGameplayTagCon...	TargetRequiredTags	This ability can only be activated if the target actor/component has all of these tags
TArray< FAbilit...	TaskDebugMessages	Tasks can emit debug messages throughout their life for debugging purposes.
TSet< FGameplay...	TrackedGameplayCues	GameplayCues that were added during this ability that will get automatically removed when it ends
TArray< FPostLo...	WaitingToExecute	A list of all the functions waiting for the scope lock to end so they can run.

Constructors

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

Functions

	Name	Description
void	ActivateAbility ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf..., const FGameplayEventData* Trig... )	Actually activate ability, do not call this directly
void	AddAbilityTaskDebugMessage ( UGameplayTask* AbilityTask, FString DebugMessage )	Adds a debug message to display to the user
void	ApplyAbilityTagsToGameplayEffectSpec ( FGameplayEffectSpec& Spec, FGameplayAbilitySpec* AbilityS... )	Add the Ability's tags to the given GameplayEffectSpec.
void	ApplyCooldown ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf... )	Applies CooldownGameplayEffect to the target
void	ApplyCost ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf... )	Applies the ability's cost to the target
FActiveGamep...	ApplyGameplayEffectSpecToOwner ( const FGameplayAbilitySpecHandle Ab..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf..., const FGameplayEffectSpecHandle Spe... )
TArray< FAct...	ApplyGameplayEffectSpecToTarget ( const FGameplayAbilitySpecHandle Ab..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf..., const FGameplayEffectSpecHandle Spe..., const FGameplayAbilityTargetDataHan... )
FActiveGamep...	ApplyGameplayEffectToOwner ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf..., const UGameplayEffect* Gamepla..., float GameplayEffectLevel, int32 Stacks )	Non blueprintcallable, safe to call on CDO/NonInstance abilities
TArray< FAct...	ApplyGameplayEffectToTarget ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf..., const FGameplayAbilityTargetDataHan..., TSubclassOf< UGameplayEffect > Game..., float GameplayEffectLevel, int32 Stacks )	Non blueprintcallable, safe to call on CDO/NonInstance abilities
FActiveGamep...	BP_ApplyGameplayEffectToOwner ( TSubclassOf< UGameplayEffect > Game..., int32 GameplayEffectLevel, int32 Stacks )	Apply Gameplay effects to Self Apply a gameplay effect to the owner of this ability
TArray< FAct...	BP_ApplyGameplayEffectToTarget ( FGameplayAbilityTargetDataHandle Ta..., TSubclassOf< UGameplayEffect > Game..., int32 GameplayEffectLevel, int32 Stacks )	Apply Gameplay effects to Target Apply a gameplay effect to a Target
void	BP_RemoveGameplayEffectFromOwnerWithAssetTags ( FGameplayTagContainer WithAssetTags, int32 StacksToRemove )	Remove Gameplay effects from Self
void	BP_RemoveGameplayEffectFromOwnerWithGrantedTags ( FGameplayTagContainer WithGrantedTa..., int32 StacksToRemove )	Removes GameplayEffects from owner which grant the given tags
void	BP_RemoveGameplayEffectFromOwnerWithHandle ( FActiveGameplayEffectHandle Handle, int32 StacksToRemove )	Removes GameplayEffect from owner that match the given handle
void	CallActivateAbility ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf..., FOnGameplayAbilityEnded::FDelegate ..., const FGameplayEventData* Trig... )	Executes PreActivate and ActivateAbility
bool	CanActivateAbility ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayTagContainer* S..., const FGameplayTagContainer* T..., OUTFGameplayTagContainer* Opti... )	CanActivateAbility Returns true if this ability can be activated right now. Has no side effects
bool	CanBeCanceled()	Returns true if this ability can be canceled
void	CancelAbility ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf..., bool bReplicateCancelAbility )	CancelAbility
void	CancelTaskByInstanceName ( FName InstanceName )	Add any task with this instance name to a list to be canceled (not ended) next frame.
bool	CheckCooldown ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., OUTFGameplayTagContainer* Opti... )	Checks cooldown. returns true if we can be used again. False if not
bool	CheckCost ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., OUTFGameplayTagContainer* Opti... )	Checks cost. returns true if we can pay for the ability. False if not
bool	CommitAbility ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf..., OUTFGameplayTagContainer* Opti... )
bool	CommitAbilityCooldown ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf..., const bool ForceCooldown, OUTFGameplayTagContainer* Opti... )
bool	CommitAbilityCost ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf..., OUTFGameplayTagContainer* Opti... )
bool	CommitCheck ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf..., OUTFGameplayTagContainer* Opti... )	The last chance to fail before committing, this will usually be the same as CanActivateAbility.
void	CommitExecute ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf... )	Does the commit atomically (consume resources, do cooldowns, etc)
void	ConfirmActivateSucceed()	Called on a predictive ability when the server confirms its execution
void	ConfirmTaskByInstanceName ( FName InstanceName, bool bEndTask )	Ability Tasks
void	DecrementListLock()	Decreases the scope lock count. Runs the waiting to execute delegates if the count drops to zero.
bool	DoesAbilitySatisfyTagRequirements ( const UAbilitySystemComponent& Abi..., const FGameplayTagContainer* S..., const FGameplayTagContainer* T..., OUTFGameplayTagContainer* Opti... )	Returns true if none of the ability's tags are blocked and if it doesn't have a "Blocking" tag and has all "Required" tags.
void	EndAbility ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf..., bool bReplicateEndAbility, bool bWasCancelled )	Native function, called if an ability ends normally or abnormally.
void	EndAbilityState ( FName OptionalStateNameToEnd )	Ends any active ability state task with the given name.
void	EndOrCancelTasksByInstanceName()	Internal function, cancels all the tasks we asked to cancel last frame (by instance name).
void	EndTaskByInstanceName ( FName InstanceName )	Add any task with this instance name to a list to be ended (not canceled) next frame.
int32	GetAbilityLevel ( FGameplayAbilitySpecHandle Handle, const FGameplayAbilityActorInfo... )	Returns current ability level for non instanced abilities.
int32	GetAbilityLevel()	Ability Levels and source objects Returns current level of the Ability
int32	GetAbilityLevel_BP ( FGameplayAbilitySpecHandle Handle, const FGameplayAbilityActorInfo& A... )	Returns current ability level for non instanced abilities.
UAbilitySyst...	GetAbilitySystemComponentFromActorInfo()	Returns the AbilitySystemComponent that is activating this ability
UAbilitySyst...	GetAbilitySystemComponentFromActorInfo_Checked()	Returns the AbilitySystemComponent that is activating this ability
UAbilitySyst...	GetAbilitySystemComponentFromActorInfo_Ensured()	Returns the AbilitySystemComponent that is activating this ability
FGameplayAbi...	GetActorInfo()	Returns the actor info associated with this ability, has cached pointers to useful objects
AActor *	GetAvatarActorFromActorInfo()	Returns the physical actor that is executing this ability. May be null
FGameplayEff...	GetContextFromOwner ( FGameplayAbilityTargetDataHandle Op... )	Generates a GameplayEffectContextHandle from our owner and an optional TargetData.
UGameplayEff...	GetCooldownGameplayEffect()	Returns the gameplay effect used to determine cooldown
const FGamep...	GetCooldownTags()	Returns all tags that are currently on cooldown
float	GetCooldownTimeRemaining()	Returns the time in seconds remaining on the currently active cooldown.
float	GetCooldownTimeRemaining ( const FGameplayAbilityActorInfo... )	Returns the time in seconds remaining on the currently active cooldown.
void	GetCooldownTimeRemainingAndDuration ( FGameplayAbilitySpecHandle Handle, const FGameplayAbilityActorInfo..., float& TimeRemaining, float& CooldownDuration )	Returns the time in seconds remaining on the currently active cooldown and the original duration for this cooldown.
UGameplayEff...	GetCostGameplayEffect()	Returns the gameplay effect used to apply cost
FGameplayAbi...	GetCurrentAbilitySpec()	Retrieves the actual AbilitySpec for this ability. Can only be called on instanced abilities.
FGameplayAbi...	GetCurrentAbilitySpecHandle()	Gets the current AbilitySpecHandle- can only be called on instanced abilities.
FGameplayAbi...	GetCurrentActivationInfo()	Gets the current activation info bound to this ability - can only be called on instanced abilities.
FGameplayAbi...	GetCurrentActivationInfoRef()	Gets the current activation info bound to this ability - can only be called on instanced abilities.
const FGamep...	GetCurrentActorInfo()	Gets the current actor info bound to this ability - can only be called on instanced abilities.
UAnimMontage...	GetCurrentMontage()	Animation Returns the currently playing montage for this ability, if any
UObject *...	GetCurrentSourceObject()	Retrieves the SourceObject associated with this ability. Can only be called on instanced abilities.
FGameplayEff...	GetGrantedByEffectContext()	Retrieves the EffectContext of the GameplayEffect that granted this ability.
EGameplayAbi...	GetInstancingPolicy()	The important functions: CanActivateAbility() - const function to see if ability is activatable.
EGameplayAbi...	GetNetExecutionPolicy()	Where does an ability execute on the network? Does a client "ask and predict", "ask and wait", "don't ask (just do it)"
EGameplayAbi...	GetNetSecurityPolicy()	Where should an ability execute on the network? Provides protection from clients attempting to execute restricted abilities.
AActor *	GetOwningActorFromActorInfo()	Returns the actor that owns this ability, which may not have a physical location
USkeletalMes...	GetOwningComponentFromActorInfo()	Convenience method for abilities to get skeletal mesh component - useful for aiming abilities
EGameplayAbi...	GetReplicationPolicy()	How an ability replicates state/events to everyone on the network
UObject *...	GetSourceObject ( FGameplayAbilitySpecHandle Handle, const FGameplayAbilityActorInfo... )	Retrieves the SourceObject associated with this ability. Callable on non instanced
UObject *...	GetSourceObject_BP ( FGameplayAbilitySpecHandle Handle, const FGameplayAbilityActorInfo& A... )	Retrieves the SourceObject associated with this ability. Callable on non instanced
UWorld *	GetWorld()
bool	HasAuthority ( const FGameplayAbilityActivationInf... )	True if this is the server or single player
bool	HasAuthorityOrPredictionKey ( const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf... )	True if we are authority or we have a valid prediciton key that is expected to work
void	IncrementListLock()	Increases the scope lock count.
void	InputPressed ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf... )	Input Input binding stub.
void	InputReleased ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf... )	Input binding stub.
void	InvalidateClientPredictionKey()	Invalidates the current prediction key.
bool	IsActive()	Returns true if the ability is currently active
bool	IsBlockingOtherAbilities()	Returns true if this ability is blocking other abilities
bool	IsEndAbilityValid ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo... )	Check if the ability can be ended
bool	IsForRemoteClient()	True if this is on the server and is being executed for a non-local player, false in single player
bool	IsInstantiated()	True if this has been instanced, always true for blueprints
bool	IsLocallyControlled()	True if the owning actor is locally controlled, true in single player
bool	IsMarkPendingKillOnAbilityEnd()	Is bMarkPendingKillOnAbilityEnd set
bool	IsPredictingClient()	Is this ability running on a a predicting client, this is false in single player
bool	IsTriggered()	Is this ability triggered from TriggerData (or is it triggered explicitly through input/game code)
void	K2_ActivateAbility()	ActivateAbility
void	K2_ActivateAbilityFromEvent ( const FGameplayEventData& EventDat... )
void	K2_AddGameplayCue ( FGameplayTag GameplayCueTag, FGameplayEffectContextHandle Contex..., bool bRemoveOnAbilityEnd )	Adds a persistent gameplay cue to the ability owner. Optionally will remove if ability ends
void	K2_AddGameplayCueWithParams ( FGameplayTag GameplayCueTag, const FGameplayCueParameters& Game..., bool bRemoveOnAbilityEnd )	Adds a persistent gameplay cue to the ability owner. Optionally will remove if ability ends
FActiveGamep...	K2_ApplyGameplayEffectSpecToOwner ( const FGameplayEffectSpecHandle Eff... )	Apply a previously created gameplay effect spec to the owner of this ability
TArray< FAct...	K2_ApplyGameplayEffectSpecToTarget ( const FGameplayEffectSpecHandle Eff..., FGameplayAbilityTargetDataHandle Ta... )	Apply a previously created gameplay effect spec to a target
bool	K2_CanActivateAbility ( FGameplayAbilityActorInfo ActorInfo, const FGameplayAbilitySpecHandle Ha..., FGameplayTagContainer& RelevantTag... )	CanActivate Returns true if this ability can be activated right now. Has no side effects
void	K2_CancelAbility()	Call from Blueprint to cancel the ability naturally
bool	K2_CheckAbilityCooldown()	Checks the ability's cooldown, but does not apply it.
bool	K2_CheckAbilityCost()	Checks the ability's cost, but does not apply it.
bool	K2_CommitAbility()	CommitAbility
bool	K2_CommitAbilityCooldown ( bool BroadcastCommitEvent, bool ForceCooldown )	Attempts to commit the ability's cooldown only.
bool	K2_CommitAbilityCost ( bool BroadcastCommitEvent )	Attempts to commit the ability's cost only.
void	K2_CommitExecute()	BP event called from CommitAbility
void	K2_EndAbility()	EndAbility Call from kismet to end the ability naturally
void	K2_ExecuteGameplayCue ( FGameplayTag GameplayCueTag, FGameplayEffectContextHandle Contex... )	GameplayCue Abilities can invoke GameplayCues without having to create GameplayEffects
void	K2_ExecuteGameplayCueWithParams ( FGameplayTag GameplayCueTag, const FGameplayCueParameters& Game... )	Invoke a gameplay cue on the ability owner, with extra parameters
bool	K2_HasAuthority()
void	K2_OnEndAbility ( bool bWasCancelled )	Kismet event, will be called if an ability ends normally or abnormally
void	K2_RemoveGameplayCue ( FGameplayTag GameplayCueTag )	Removes a persistent gameplay cue from the ability owner
bool	K2_ShouldAbilityRespondToEvent ( FGameplayAbilityActorInfo ActorInfo, FGameplayEventData Payload )	ShouldAbilityRespondToEvent
FGameplayEff...	MakeEffectContext ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo... )	Returns an effect context, given a specified actor info
FGameplayEff...	MakeOutgoingGameplayEffectSpec ( TSubclassOf< UGameplayEffect > Game..., float Level )	Convenience method for abilities to get outgoing gameplay effect specs (for example, to pass on to projectiles to apply to whoever they hit)
FGameplayEff...	MakeOutgoingGameplayEffectSpec ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf..., TSubclassOf< UGameplayEffect > Game..., float Level )	Native version of above function
FGameplayAbi...	MakeTargetLocationInfoFromOwnerActor()	Target Data Creates a target location from where the owner avatar is
FGameplayAbi...	MakeTargetLocationInfoFromOwnerSkeletalMeshComponent ( FName SocketName )	Creates a target location from a socket on the owner avatar's skeletal mesh
void	MontageJumpToSection ( FName SectionName )	Animation Immediately jumps the active montage to a section
void	MontageSetNextSectionName ( FName FromSectionName, FName ToSectionName )	Sets pending section on active montage
void	MontageStop ( float OverrideBlendOutTime )	Stops the current animation montage.
void	NotifyAbilityTaskWaitingOnAvatar ( UAbilityTask* AbilityTask )	Called to inform the ability that a task is waiting for the player's avatar to do something in world
void	NotifyAbilityTaskWaitingOnPlayerData ( UAbilityTask* AbilityTask )	Called to inform the ability that a task is waiting for the player to do something
void	NotifyAvatarDestroyed()	Called to inform the ability that the AvatarActor has been replaced.
void	OnAvatarSet ( const FGameplayAbilityActorInfo..., const FGameplayAbilitySpec& Spec )	Called when the avatar actor is set/changes
void	OnGiveAbility ( const FGameplayAbilityActorInfo..., const FGameplayAbilitySpec& Spec )	Called when the ability is given to an AbilitySystemComponent
void	OnRemoveAbility ( const FGameplayAbilityActorInfo..., const FGameplayAbilitySpec& Spec )	Called when the ability is removed from an AbilitySystemComponent
void	OnWaitingForConfirmInputBegin()	Called from AbilityTask_WaitConfirmCancel to handle input confirming
void	OnWaitingForConfirmInputEnd()
void	PostNetInit()	Setters for temporary execution data
void	PreActivate ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf..., FOnGameplayAbilityEnded::FDelegate ..., const FGameplayEventData* Trig... )	Do boilerplate init stuff and then call ActivateAbility
void	RemoveGrantedByEffect()	Removes the GameplayEffect that granted this ability. Can only be called on instanced abilities.
void	SendGameplayEvent ( FGameplayTag EventTag, FGameplayEventData Payload )	Sends a gameplay event, also creates a prediction window
void	SetCanBeCanceled ( bool bCanBeCanceled )	Sets whether the ability should ignore cancel requests. Only valid on instanced abilities
void	SetCurrentActivationInfo ( const FGameplayAbilityActivationInf... )	Modifies activation info, only safe on instanced abilities
void	SetCurrentActorInfo ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo... )	Modifies actor info, only safe on instanced abilities
void	SetCurrentInfo ( const FGameplayAbilitySpecHandle Ha..., const FGameplayAbilityActorInfo..., const FGameplayAbilityActivationInf... )	Sets both actor and activation info
void	SetCurrentMontage ( UAnimMontage* InCurrentMontage )	Call to set/get the current montage from a montage task.
void	SetMarkPendingKillOnAbilityEnd ( bool bInMarkPendingKillOnAbilityEnd )	Setter for the bMarkPendingKillOnAbilityEnd
void	SetMovementSyncPoint ( FName SyncName )	Movement Sync
void	SetRemoteInstanceHasEnded()	Interaction with ability system component
void	SetShouldBlockOtherAbilities ( bool bShouldBlockAbilities )	Sets rather ability block flags are enabled or disabled. Only valid on instanced abilities
bool	ShouldAbilityRespondToEvent ( const FGameplayAbilityActorInfo..., const FGameplayEventData* Payl... )	Returns true if this ability can be triggered right now. Has no side effects
bool	ShouldActivateAbility ( ENetRole Role )	Returns true if an an ability should be activated
bool	ShouldReplicateAbilitySpec ( const FGameplayAbilitySpec& Abilit... )	Takes in the ability spec and checks if we should allow replication on the ability spec, this will NOT stop replication of the ability UObject just the spec inside the UAbilitySystemComponenet ActivatableAbilities for this ability

Overridden from UObject

	Name	Description
bool	CallRemoteFunction ( UFunction* Function, void* Parms, FOutParmRec* OutParms, FFrame* Stack )	Call the actor's function remotely
int32	GetFunctionCallspace ( UFunction* Function, FFrame* Stack )	Return the space this function should be called.
bool	IsSupportedForNetworking()	IsSupportedForNetworking means an object can be referenced over the network

Overridden from IGameplayTaskOwnerInterface

	Name	Description
AActor *	GetGameplayTaskAvatar ( const UGameplayTask* Task )	Get "body" of task's owner / default, having location in world (e.g. Owner = AIController, Avatar = Pawn)
AActor *	GetGameplayTaskOwner ( const UGameplayTask* Task )	Get owner of a task or default one when task is null
UGameplayTas...	GetGameplayTasksComponent ( const UGameplayTask& Task )	Finds tasks component for given GameplayTask, Task.GetGameplayTasksComponent() may not be initialized at this point!
void	OnGameplayTaskActivated ( UGameplayTask& Task )	Notify called after GameplayTask changes state to Active (initial activation or resuming)
void	OnGameplayTaskDeactivated ( UGameplayTask& Task )	Notify called after GameplayTask changes state from Active (finishing or pausing)
void	OnGameplayTaskInitialized ( UGameplayTask& Task )	Notify called after GameplayTask finishes initialization (not active yet)

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

Take our survey

Dismiss