BlueprintGameplayTagLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ScriptInterface.h"
#include "GameplayTagContainer.h"
#include "GameplayTagAssetInterface.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "Templates/SubclassOf.h"
#include "BlueprintGameplayTagLibrary.generated.h"
 
UCLASS(meta=(ScriptName="GameplayTagLibrary"), MinimalAPI)
class UBlueprintGameplayTagLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_UCLASS_BODY()
 
    
    UFUNCTION(BlueprintPure, Category="GameplayTags", meta = (Keywords = "DoGameplayTagsMatch", BlueprintThreadSafe))
    static GAMEPLAYTAGS_API bool MatchesTag(FGameplayTag TagOne, FGameplayTag TagTwo, bool bExactMatch);
 
    UFUNCTION(BlueprintPure, Category="GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API bool MatchesAnyTags(FGameplayTag TagOne, const FGameplayTagContainer& OtherContainer, bool bExactMatch);
 
    UFUNCTION(BlueprintPure, meta=(DisplayName="Equal (GameplayTag)", CompactNodeTitle="==", BlueprintThreadSafe), Category="GameplayTags")
    static GAMEPLAYTAGS_API bool EqualEqual_GameplayTag( FGameplayTag A, FGameplayTag B );
    
    UFUNCTION(BlueprintPure, meta=(DisplayName="Not Equal (GameplayTag)", CompactNodeTitle="!=", BlueprintThreadSafe), Category="GameplayTags")
    static GAMEPLAYTAGS_API bool NotEqual_GameplayTag( FGameplayTag A, FGameplayTag B );
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API bool IsGameplayTagValid(FGameplayTag GameplayTag);
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API FName GetTagName(const FGameplayTag& GameplayTag);
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API FGameplayTag MakeLiteralGameplayTag(FGameplayTag Value);
 
    UFUNCTION(BlueprintPure, Category="GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API int32 GetNumGameplayTagsInContainer(const FGameplayTagContainer& TagContainer);
 
    UFUNCTION(BlueprintPure, Category="GameplayTags", meta = (Keywords = "DoesContainerHaveTag", BlueprintThreadSafe))
    static GAMEPLAYTAGS_API bool HasTag(const FGameplayTagContainer& TagContainer, FGameplayTag Tag, bool bExactMatch);
 
    UFUNCTION(BlueprintPure, Category="GameplayTags", meta = (Keywords = "DoesContainerMatchAnyTagsInContainer", BlueprintThreadSafe))
    static GAMEPLAYTAGS_API bool HasAnyTags(const FGameplayTagContainer& TagContainer, const FGameplayTagContainer& OtherContainer, bool bExactMatch);
 
    UFUNCTION(BlueprintPure, Category="GameplayTags", meta = (Keywords = "DoesContainerMatchAllTagsInContainer", BlueprintThreadSafe))
    static GAMEPLAYTAGS_API bool HasAllTags(const FGameplayTagContainer& TagContainer, const FGameplayTagContainer& OtherContainer, bool bExactMatch);
 
    UFUNCTION(BlueprintPure, Category="GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API FGameplayTagContainer Filter(const FGameplayTagContainer& TagContainer, const FGameplayTagContainer& OtherContainer, bool bExactMatch);
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API bool IsTagQueryEmpty(const FGameplayTagQuery& TagQuery);
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API bool DoesContainerMatchTagQuery(const FGameplayTagContainer& TagContainer, const FGameplayTagQuery& TagQuery);
 
    UFUNCTION(BlueprintCallable, Category="GameplayTags",  meta=(WorldContext="WorldContextObject", DeterminesOutputType="ActorClass", DynamicOutputParam="OutActors"))
    static GAMEPLAYTAGS_API void GetAllActorsOfClassMatchingTagQuery(UObject* WorldContextObject, TSubclassOf<AActor> ActorClass, const FGameplayTagQuery& GameplayTagQuery, TArray<AActor*>& OutActors);
 
    UFUNCTION(BlueprintCallable, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API void AddGameplayTag(UPARAM(ref) FGameplayTagContainer& TagContainer, FGameplayTag Tag);
 
    UFUNCTION(BlueprintCallable, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API bool RemoveGameplayTag(UPARAM(ref) FGameplayTagContainer& TagContainer, FGameplayTag Tag);
 
    UFUNCTION(BlueprintCallable, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API void AppendGameplayTagContainers(UPARAM(ref) FGameplayTagContainer& InOutTagContainer, const FGameplayTagContainer& InTagContainer);
 
    UFUNCTION(BlueprintPure, meta=(DisplayName="Equal (GameplayTagContainer)", CompactNodeTitle="==", BlueprintThreadSafe), Category="GameplayTags")
    static GAMEPLAYTAGS_API bool EqualEqual_GameplayTagContainer( const FGameplayTagContainer& A, const FGameplayTagContainer& B );
    
    UFUNCTION(BlueprintPure, meta=(DisplayName="Not Equal (GameplayTagContainer)", CompactNodeTitle="!=", BlueprintThreadSafe), Category="GameplayTags")
    static GAMEPLAYTAGS_API bool NotEqual_GameplayTagContainer( const FGameplayTagContainer& A, const FGameplayTagContainer& B );
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API FGameplayTagContainer MakeLiteralGameplayTagContainer(FGameplayTagContainer Value);
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API FGameplayTagContainer MakeGameplayTagContainerFromArray(const TArray<FGameplayTag>& GameplayTags);
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API FGameplayTagContainer MakeGameplayTagContainerFromTag(FGameplayTag SingleTag);
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API void BreakGameplayTagContainer(const FGameplayTagContainer& GameplayTagContainer, TArray<FGameplayTag>& GameplayTags);
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API FGameplayTagQuery MakeGameplayTagQuery(FGameplayTagQuery TagQuery);
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API FGameplayTagQuery MakeGameplayTagQuery_MatchAnyTags(const FGameplayTagContainer& InTags);
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API FGameplayTagQuery MakeGameplayTagQuery_MatchAllTags(const FGameplayTagContainer& InTags);
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe))
    static GAMEPLAYTAGS_API FGameplayTagQuery MakeGameplayTagQuery_MatchNoTags(const FGameplayTagContainer& InTags);
    
    UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "TRUE"))
    static GAMEPLAYTAGS_API bool HasAllMatchingGameplayTags(TScriptInterface<IGameplayTagAssetInterface> TagContainerInterface, const FGameplayTagContainer& OtherContainer);
 
    UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "TRUE"))
    static GAMEPLAYTAGS_API bool HasAnyMatchingGameplayTags(TScriptInterface<IGameplayTagAssetInterface> TagContainerInterface, const FGameplayTagContainer& OtherContainer);
 
    UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "TRUE"))
    static GAMEPLAYTAGS_API bool DoesTagAssetInterfaceHaveTag(TScriptInterface<IGameplayTagAssetInterface> TagContainerInterface, FGameplayTag Tag);
 
    UFUNCTION(BlueprintPure, Category = PinOptions, meta = (BlueprintInternalUseOnly = "TRUE"))
    static GAMEPLAYTAGS_API bool NotEqual_TagTag(FGameplayTag A, FString B);
 
    UFUNCTION(BlueprintPure, Category = PinOptions, meta = (BlueprintInternalUseOnly = "TRUE"))
    static GAMEPLAYTAGS_API bool NotEqual_TagContainerTagContainer(FGameplayTagContainer A, FString B);
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta=(DefaultToSelf=TagContainerInterface))
    static GAMEPLAYTAGS_API UPARAM(DisplayName = "Owned Tags") FGameplayTagContainer GetOwnedGameplayTags(TScriptInterface<IGameplayTagAssetInterface> TagContainerInterface);
 
    UFUNCTION(BlueprintPure, meta=(DisplayName = "To GameplayTagAssetInterface", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|Casting")
    static GAMEPLAYTAGS_API TScriptInterface<IGameplayTagAssetInterface> Conv_ObjectToGameplayTagAssetInterface(UObject* InObject);
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe, BlueprintAutocast))
    static GAMEPLAYTAGS_API FString GetDebugStringFromGameplayTagContainer(const FGameplayTagContainer& TagContainer);
 
    UFUNCTION(BlueprintPure, Category = "GameplayTags", meta = (BlueprintThreadSafe, BlueprintAutocast))
    static GAMEPLAYTAGS_API FString GetDebugStringFromGameplayTag(FGameplayTag GameplayTag);
 
};