FGameplayTagCountContainer

Struct that tracks the number/count of tag applications within it.

API > API/Plugins > API/Plugins/GameplayAbilities

References

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

Syntax

struct FGameplayTagCountContainer

Remarks

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.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Fills in ParentTags from GameplayTags
Public function Const const FGameplayTagContainer & Simple accessor to the explicit gameplay tag list
Public function Const int32 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.
Public function Const int32

GetTagCount ( const FGameplayTag& Tag
)

 Return the hierarchical count for a specified tag e.g. if A.B & A.C were added, GetTagCount("A") would return 2.
Public function Const bool Check if the count container has gameplay tags that matches against all of the specified tags (expands to include parents of asset tags)
Public function Const bool Check if the count container has gameplay tags that matches against any of the specified tags (expands to include parents of asset tags)
Public function Const bool Check if the count container has a gameplay tag that matches against the specified tag (expands to include parents of asset tags)
Public function void Broadcasts the AnyChange event for this tag.
Public function FOnGameplayEffectTagCountChanged & Return delegate that can be bound to for when the specific tag's count changes to or off of zero
Public function FOnGameplayEffectTagCountChanged & Return delegate that can be bound to for when the any tag's count changes to or off of zero
Public function void

Reset ( bool bResetCallbacks
)

 Removes all of the tags. Does not notify any delegates.
Public function bool

SetTagCount ( const FGameplayTag& Tag,
int32 NewCount
)

 Set the specified tag count to a specific value
Public function 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
Public function 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
Public function 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page