UAbilitySystemComponent::RemoveActiveGameplayEffectBySourceEffect

Remove active gameplay effects whose backing definition are the specified gameplay effect class

Windows
MacOS
Linux

References

Module

GameplayAbilities

Header

/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/AbilitySystemComponent.h

Include

#include "AbilitySystemComponent.h"

Source

/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Private/AbilitySystemComponent.cpp

Syntax

[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, BlueprintAuthorityOnly, Category=GameplayEffects)
virtual void RemoveActiveGameplayEffectBySourceEffect
(
    TSubclassOf< UGameplayEffect > GameplayEffect,
    UAbilitySystemComponent * InstigatorAbilitySystemComponent,
    int32 StacksToRemove
)

Remarks

Remove active gameplay effects whose backing definition are the specified gameplay effect class

Parameters

Parameter

Description

GameplayEffect

Class of gameplay effect to remove; Does nothing if left null

InstigatorAbilitySystemComponent

If specified, will only remove gameplay effects applied from this instigator ability system component

StacksToRemove

Number of stacks to remove, -1 means remove all

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