GameplayTagsSettings.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/Object.h"
#include "UObject/SoftObjectPath.h"
#include "GameplayTagsManager.h"
#include "Engine/DeveloperSettings.h"
#include "GameplayTagRedirectors.h"
#include "GameplayTagsSettings.generated.h"
 
USTRUCT()
struct FGameplayTagCategoryRemap
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY(EditAnywhere, Category = GameplayTags)
    FString BaseCategory;
 
    UPROPERTY(EditAnywhere, Category = GameplayTags)
    TArray<FString> RemapCategories;
 
    friend inline bool operator==(const FGameplayTagCategoryRemap& A, const FGameplayTagCategoryRemap& B)
    {
        return A.BaseCategory == B.BaseCategory && A.RemapCategories == B.RemapCategories;
    }
};
 
UCLASS(config = GameplayTagsList, MinimalAPI)
class UGameplayTagsList : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY()
    FString ConfigFileName;
 
    UPROPERTY(config, EditAnywhere, Category = GameplayTags, meta = (ConfigRestartRequired = true))
    TArray<FGameplayTagRedirect> GameplayTagRedirects;
 
    UPROPERTY(config, EditAnywhere, Category = GameplayTags)
    TArray<FGameplayTagTableRow> GameplayTagList;
 
    GAMEPLAYTAGS_API void SortTags();
};
 
UCLASS(config = GameplayTags, MinimalAPI)
class URestrictedGameplayTagsList : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY()
    FString ConfigFileName;
 
    UPROPERTY(config, EditAnywhere, Category = GameplayTags)
    TArray<FRestrictedGameplayTagTableRow> RestrictedGameplayTagList;
 
    GAMEPLAYTAGS_API void SortTags();
};
 
USTRUCT()
struct FRestrictedConfigInfo
{
    GENERATED_BODY()
 
    
    UPROPERTY(config, EditAnywhere, AdvancedDisplay, Category = GameplayTags)
    FString RestrictedConfigName;
 
    UPROPERTY(config, EditAnywhere, AdvancedDisplay, Category = GameplayTags)
    TArray<FString> Owners;
 
    GAMEPLAYTAGS_API bool operator==(const FRestrictedConfigInfo& Other) const;
    GAMEPLAYTAGS_API bool operator!=(const FRestrictedConfigInfo& Other) const;
};
 
UCLASS(config=GameplayTags, defaultconfig, MinimalAPI)
class UGameplayTagsSettings : public UGameplayTagsList
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(config, EditAnywhere, Category = GameplayTags)
    bool ImportTagsFromConfig;
 
    UPROPERTY(config, EditAnywhere, Category = GameplayTags, meta = (ConfigRestartRequired = true))
    bool WarnOnInvalidTags;
 
    UE_DEPRECATED(5.5, "We never clear invalid tags when reading saved tag references as the loading order of native tags is not guaranteed.")
    UPROPERTY(config)
    bool ClearInvalidTags = false;
 
    UPROPERTY(config, EditAnywhere, Category = "Advanced Gameplay Tags")
    bool AllowEditorTagUnloading;
 
    UPROPERTY(config, EditAnywhere, Category = "Advanced Gameplay Tags")
    bool AllowGameTagUnloading;
 
    UPROPERTY(config, EditAnywhere, Category = "Advanced Replication")
    bool FastReplication;
 
    UPROPERTY(config, EditAnywhere, Category = "Advanced Replication", meta=(EditCondition="!FastReplication"))
    bool bDynamicReplication;
 
    UPROPERTY(config, EditAnywhere, Category = GameplayTags)
    FString InvalidTagCharacters;
 
    UPROPERTY(config, EditAnywhere, Category = GameplayTags)
    TArray<FGameplayTagCategoryRemap> CategoryRemapping;
 
    UPROPERTY(config, EditAnywhere, Category = GameplayTags, meta = (AllowedClasses = "/Script/Engine.DataTable"))
    TArray<FSoftObjectPath> GameplayTagTableList;
 
    UPROPERTY(config, EditAnywhere, Category = "Advanced Replication")
    TArray<FName> CommonlyReplicatedTags;
 
    UPROPERTY(config, EditAnywhere, Category = "Advanced Replication")
    int32 NumBitsForContainerSize;
 
    UPROPERTY(config, EditAnywhere, Category= "Advanced Replication")
    int32 NetIndexFirstBitSegment;
 
    UPROPERTY(config, EditAnywhere, AdvancedDisplay, Category = "Advanced Gameplay Tags")
    TArray<FRestrictedConfigInfo> RestrictedConfigFiles;
 
#if WITH_EDITORONLY_DATA
    // Dummy parameters used to hook the editor UI
    UPROPERTY(EditAnywhere, AdvancedDisplay, transient, Category = "Advanced Gameplay Tags")
    FString RestrictedTagList;
 
    UPROPERTY(EditAnywhere, transient, Category = "GameplayTags")
    FString NewTagSource;
 
    UPROPERTY(EditAnywhere, transient, Category = "GameplayTags")
    FString CleanupUnusedTags;
#endif
 
#if WITH_EDITOR
    GAMEPLAYTAGS_API virtual void PreEditChange(FProperty* PropertyThatWillChange) override;
    GAMEPLAYTAGS_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
 
private:
    // temporary copy of RestrictedConfigFiles that we use to identify changes in the list
    // this is required to autopopulate the owners field
    TArray<FRestrictedConfigInfo> RestrictedConfigFilesTempCopy;
#endif
};
 
UCLASS(config=EditorPerProjectUserSettings, meta=(DisplayName="Gameplay Tag Editing"), MinimalAPI)
class UGameplayTagsDeveloperSettings : public UDeveloperSettings
{
    GENERATED_UCLASS_BODY()
 
    GAMEPLAYTAGS_API virtual FName GetCategoryName() const override;
 
    UPROPERTY(config, EditAnywhere, Category=GameplayTags)
    FString DeveloperConfigName;
 
    UPROPERTY(config, EditAnywhere, Category=GameplayTags)
    FName FavoriteTagSource;
};