FGameplayTagCountContainer | Unreal Engine 5.6 Documentation

API > API/Plugins > API/Plugins/GameplayAbilities

Struct that tracks the number/count of tag applications within it. Explicitly tracks the tags added or removed, while simultaneously tracking the count of parent tags as well. Events/delegates are fired whenever the tag counts of any tag (explicit or parent) are modified.


Name	FGameplayTagCountContainer
Type	struct
Header File	/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayEffectTypes.h
Include Path	#include "GameplayEffectTypes.h"

Syntax

struct FGameplayTagCountContainer

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FGameplayTagCountContainer()		GameplayEffectTypes.h

Structs

Name	Remarks
FDelegateInfo

Variables

Protected

Name	Type	Remarks	Include Path
ExplicitTagCountMap	TMap< FGameplayTag, int32 >	Map of tag to explicit count of that tag.	GameplayEffectTypes.h
ExplicitTags	FGameplayTagContainer	Container of tags that were explicitly added	GameplayEffectTypes.h
GameplayTagCountMap	TMap< FGameplayTag, int32 >	Map of tag to active count of that tag	GameplayEffectTypes.h
GameplayTagEventMap	TMap< FGameplayTag, FDelegateInfo >	Map of tag to delegate that will be fired when the count for the key tag changes to or away from zero	GameplayEffectTypes.h
OnAnyTagChangeDelegate	FOnGameplayEffectTagCountChanged	Delegate fired whenever any tag's count changes to or away from zero	GameplayEffectTypes.h

Functions

Public

Name	Remarks	Include Path
void FillParentTags()	Fills in ParentTags from GameplayTags	GameplayEffectTypes.h
const FGameplayTagContainer & GetExplicitGameplayTags()	Simple accessor to the explicit gameplay tag list	GameplayEffectTypes.h
int32 GetExplicitTagCount ( const FGameplayTag& Tag ) const	Return how many times the exact specified tag has been added to the container (ignores the tag hierarchy) e.g. if A.B & A.C were added, GetExplicitTagCount("A") would return 0, and GetExplicitTagCount("A.B") would return 1.	GameplayEffectTypes.h
int32 GetTagCount ( const FGameplayTag& Tag ) const	Return the hierarchical count for a specified tag e.g. if A.B & A.C were added, GetTagCount("A") would return 2.	GameplayEffectTypes.h
bool HasAllMatchingGameplayTags ( const FGameplayTagContainer& TagContainer ) const	Check if the count container has gameplay tags that matches against all of the specified tags (expands to include parents of asset tags)	GameplayEffectTypes.h
bool HasAnyMatchingGameplayTags ( const FGameplayTagContainer& TagContainer ) const	Check if the count container has gameplay tags that matches against any of the specified tags (expands to include parents of asset tags)	GameplayEffectTypes.h
bool HasMatchingGameplayTag ( FGameplayTag TagToCheck ) const	Check if the count container has a gameplay tag that matches against the specified tag (expands to include parents of asset tags)	GameplayEffectTypes.h
void Notify_StackCountChange ( const FGameplayTag& Tag )	Broadcasts the AnyChange event for this tag.	GameplayEffectTypes.h
FOnGameplayEffectTagCountChanged & RegisterGameplayTagEvent ( const FGameplayTag& Tag, EGameplayTagEventType::Type EventType )	Return delegate that can be bound to for when the specific tag's count changes to or off of zero	GameplayEffectTypes.h
FOnGameplayEffectTagCountChanged & RegisterGenericGameplayEvent()	Return delegate that can be bound to for when the any tag's count changes to or off of zero	GameplayEffectTypes.h
void Reset ( bool bResetCallbacks )	Removes all of the tags. Does not notify any delegates.	GameplayEffectTypes.h
bool SetTagCount ( const FGameplayTag& Tag, int32 NewCount )	Set the specified tag count to a specific value	GameplayEffectTypes.h
void UpdateTagCount ( const FGameplayTagContainer& Container, int32 CountDelta )	Update the specified container of tags by the specified delta, potentially causing an additional or removal from the explicit tag list	GameplayEffectTypes.h
bool UpdateTagCount ( const FGameplayTag& Tag, int32 CountDelta )	Update the specified tag by the specified delta, potentially causing an additional or removal from the explicit tag list	GameplayEffectTypes.h
bool UpdateTagCount_DeferredParentRemoval ( const FGameplayTag& Tag, int32 CountDelta, TArray< FDeferredTagChangeDelegate >& DeferredTagChangeDelegates )	Update the specified tag by the specified delta, potentially causing an additional or removal from the explicit tag list.	GameplayEffectTypes.h

Navigation