1. Epic GamesDeveloper
  3. FGameplayTag

FGameplayTag

A single gameplay tag, which represents a hierarchical name of the form x.y that is registered in the GameplayTagsManager You can filter the gameplay tags displayed in the editor using, meta = (Categories = "Tag1.Tag2.Tag3"))

Unreal Engine C++ API Reference > Runtime > GameplayTags

Inheritance Hierarchy

References

   
Module GameplayTags
Header /Engine/Source/Runtime/GameplayTags/Classes/GameplayTagContainer.h
Include #include "GameplayTagContainer.h"

Syntax

USTRUCT (BlueprintType ,  
        Meta=(HasNativeMake="/Script/GameplayTags.BlueprintGameplayTagLibrary.MakeLiteralGameplayTag", HasNativeBreak="/Script/GameplayTags.BlueprintGameplayTagLibrary.GetTagName", DisableSplitPin))  
struct FGameplayTag

Remarks

A single gameplay tag, which represents a hierarchical name of the form x.y that is registered in the GameplayTagsManager You can filter the gameplay tags displayed in the editor using, meta = (Categories = "Tag1.Tag2.Tag3"))

Variables

  Type Name Description
Protected variable UProperty Category SaveGame visibleanywhere FName TagName This Tags Name

Constructors

  Type Name Description
Public function   Constructors
Protected function  

FGameplayTag ( const FName& InTagName
)

 Intentionally private so only the tag manager can use

Functions

  Type Name Description
Public function void

FromExportString ( const FString& ExportString,
int32 PortFlags
)

 Sets from a ImportText string, used in asset registry
Public function Const FGameplayTagContainer Returns a new tag container that includes this tag and all parent tags as explicitly added tags.
Public function Const FGameplayTagContainer Returns a GameplayTagContainer containing only this tag
Public function Const FName Get the tag represented as a name
Public function bool

ImportTextItem ( const TCHAR*& Buffer,
int32 PortFlags,
UObject* Parent,
FOutputDevice* ErrorText
)

 Handles importing tag strings without (TagName=) in it
Public function Const bool

IsValid ()

 Returns whether the tag is valid or not; Invalid tags are set to NAME_None and do not exist in the game-specific global dictionary
Public function Static bool

IsValidGameplayTagString ( const FString& TagString,
FText* OutError,
FString* OutFixedString
)

 Returns true if this is a valid gameplay tag string (foo.bar.baz). If false, it will fill
Public function Const bool

MatchesAny ( const FGameplayTagContainer& ContainerToCheck
)

 Checks if this tag matches ANY of the tags in the specified container, also checks against our parent tags "A.1".MatchesAny({"A","B"}) will return True, "A".MatchesAny({"A.1","B"}) will return False If ContainerToCheck is empty/invalid it will always return False
Public function Const bool

MatchesAnyExact ( const FGameplayTagContainer& ContainerToCheck
)

 Checks if this tag matches ANY of the tags in the specified container, only allowing exact matches "A.1".MatchesAny({"A","B"}) will return False If ContainerToCheck is empty/invalid it will always return False
Public function Const bool

MatchesTag ( const FGameplayTag& TagToCheck
)

 Determine if this tag matches TagToCheck, expanding our parent tags "A.1".MatchesTag("A") will return True, "A".MatchesTag("A.1") will return False If TagToCheck is not Valid it will always return False
Public function Const int32

MatchesTagDepth ( const FGameplayTag& TagToCheck
)

 Check to see how closely two FGameplayTags match.
Public function Const bool

MatchesTagExact ( const FGameplayTag& TagToCheck
)

 Determine if TagToCheck is valid and exactly matches this tag "A.1".MatchesTagExact("A") will return False If TagToCheck is not Valid it will always return False
Public function bool

NetSerialize ( FArchive& Ar,
UPackageMap* Map,
bool& bOutSuccess
)

 Overridden for fast serialize
Public function bool

NetSerialize_Packed ( FArchive& Ar,
UPackageMap* Map,
bool& bOutSuccess
)

  
Public function Const void

ParseParentTags ( TArray< FGameplayTag >& UniqueParentTags
)

 Parses the tag name and fills in UniqueParentTags with raw parent tags, without validating with the tag manager.
Public function void

PostSerialize ( const FArchive& Ar
)

 Handles fixup and errors.
Public function Const FGameplayTag Returns direct parent GameplayTag of this GameplayTag, calling on x.y will return x
Public function Static FGameplayTag

RequestGameplayTag ( const FName& TagName,
bool ErrorIfNotFound
)

 Gets the FGameplayTag that corresponds to the TagName
Public function bool

SerializeFromMismatchedTag ( const FPropertyTag& Tag,
FStructuredArchive::FSlot Slot
)

 Used to upgrade a Name property to a GameplayTag struct property
Public function Const FString Displays gameplay tag as a string for blueprint graph usage

Operators

  Type Name Description
Public function Const bool

operator!= ( FGameplayTag const& Other
)

  
Public function Const bool

operator< ( FGameplayTag const& Other
)

  
Public function Const bool

operator== ( FGameplayTag const& Other
)

 Operators

Constants

Name Description
EmptyTag An empty Gameplay Tag

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page