Navigation
API > API/Plugins > API/Plugins/GameplayAbilities
Grants additional Gameplay Abilities to the Target of a Gameplay Effect while active
| Name | UAbilitiesGameplayEffectComponent |
| Type | class |
| Header File | /Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayEffectComponents/AbilitiesGameplayEffectComponent.h |
| Include Path | #include "GameplayEffectComponents/AbilitiesGameplayEffectComponent.h" |
Syntax
UCLASS (DisplayName="Grant Gameplay Abilities", MinimalAPI)
class UAbilitiesGameplayEffectComponent : public UGameplayEffectComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGameplayEffectComponent → UAbilitiesGameplayEffectComponent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UAbilitiesGameplayEffectComponent() |
Constructor | GameplayEffectComponents/AbilitiesGameplayEffectComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddGrantedAbilityConfig
(
const FGameplayAbilitySpecConfig& Config |
Adds an entry for granting Gameplay Abilities | GameplayEffectComponents/AbilitiesGameplayEffectComponent.h |
Overridden from UGameplayEffectComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool OnActiveGameplayEffectAdded
(
FActiveGameplayEffectsContainer& ActiveGEContainer, |
Register for the appropriate events when we're applied | GameplayEffectComponents/AbilitiesGameplayEffectComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EDataValidationResult IsDataValid
(
FDataValidationContext& Context |
Warn on misconfigured Gameplay Effect | GameplayEffectComponents/AbilitiesGameplayEffectComponent.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GrantAbilities
(
FActiveGameplayEffectHandle ActiveGEHandle |
We should grant the configured Gameplay Abilities | GameplayEffectComponents/AbilitiesGameplayEffectComponent.h | |
virtual void OnInhibitionChanged
(
FActiveGameplayEffectHandle ActiveGEHandle, |
This allows us to be notified when the owning GameplayEffect has had its inhibition changed (which can happen on the initial application). | GameplayEffectComponents/AbilitiesGameplayEffectComponent.h | |
virtual void RemoveAbilities
(
FActiveGameplayEffectHandle ActiveGEHandle |
We should remove the configured Gameplay Abilities | GameplayEffectComponents/AbilitiesGameplayEffectComponent.h |