Navigation
API > API/Plugins > API/Plugins/GameplayAbilities
Handles canceling active Gameplay Abilities based on Gameplay Tags for the Target actor of the owner Gameplay Effect
| Name | UCancelAbilityTagsGameplayEffectComponent |
| Type | class |
| Header File | /Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayEffectComponents/CancelAbilityTagsGameplayEffectComponent.h |
| Include Path | #include "GameplayEffectComponents/CancelAbilityTagsGameplayEffectComponent.h" |
Syntax
UCLASS (DisplayName="Cancel Abilities with Tags", MinimalAPI)
class UCancelAbilityTagsGameplayEffectComponent : public UGameplayEffectComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGameplayEffectComponent → UCancelAbilityTagsGameplayEffectComponent
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ComponentMode | ECancelAbilityTagsGameplayEffectComponentMode | When do we want the ability cancellation logic for this component to happen? | GameplayEffectComponents/CancelAbilityTagsGameplayEffectComponent.h |
|
| InheritableCancelAbilitiesWithoutTagsContainer | FInheritedTagContainer | These tags cancel active Gameplay Abilities without these tags. | GameplayEffectComponents/CancelAbilityTagsGameplayEffectComponent.h |
|
| InheritableCancelAbilitiesWithTagsContainer | FInheritedTagContainer | These tags cancel active Gameplay Abilities with these tags. | GameplayEffectComponents/CancelAbilityTagsGameplayEffectComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void SetAndApplyCanceledAbilityTagChanges
(
const FInheritedTagContainer& CanceledAbilityWithTagsMods, |
Applies the Canceled Ability Tags to the GameplayEffect (and saves those changes) so that when the Gameplay Effect is applied, abilities with these tags are cancelled | GameplayEffectComponents/CancelAbilityTagsGameplayEffectComponent.h |
Overridden from UGameplayEffectComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnGameplayEffectApplied
(
FActiveGameplayEffectsContainer& ActiveGEContainer, |
Needed to cancel abilities if we're canceling abilities on effect application | GameplayEffectComponents/CancelAbilityTagsGameplayEffectComponent.h | |
virtual void OnGameplayEffectChanged() |
Needed to properly apply FInheritedTagContainer properties | GameplayEffectComponents/CancelAbilityTagsGameplayEffectComponent.h | |
virtual void OnGameplayEffectExecuted
(
FActiveGameplayEffectsContainer& ActiveGEContainer, |
Needed to cancel abilities if we're canceling abilities on execution | GameplayEffectComponents/CancelAbilityTagsGameplayEffectComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostInitProperties() |
Set up an EditorFriendlyName and do some initialization | GameplayEffectComponents/CancelAbilityTagsGameplayEffectComponent.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FName & GetInheritableCancelAbilitiesWithoutTagsContainerPropertyName() |
GameplayEffectComponents/CancelAbilityTagsGameplayEffectComponent.h | ||
static const FName & GetInheritableCancelAbilitiesWithTagsContainerPropertyName() |
Get a cached version of the FProperty Name for PostEditChangeProperty | GameplayEffectComponents/CancelAbilityTagsGameplayEffectComponent.h |