AssetRegistryTagsContext.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "Containers/StringView.h"
#include "Misc/Optional.h"
#include "Templates/Function.h"
#include "Templates/UnrealTemplate.h"
#include "UObject/CookEnums.h"
#include "UObject/Object.h" // UObject::FAssetRegistryTag
 
class ITargetPlatform;
class UObject;
struct FAssetBundleData;
 
namespace UE::AssetRegistry
{
 
inline constexpr FStringView CookTagPrefix = TEXTVIEW("Cook_");
 
}
 
enum class EAssetRegistryTagsCaller : uint8
{
    AssetRegistryQuery,
    AssetRegistryLoad,
    FullUpdate,
    SavePackage,
    Fast,
    Uncategorized,
};
 
struct FAssetRegistryTagsContextData
{
public:
    COREUOBJECT_API FAssetRegistryTagsContextData(const UObject* CallTarget,
        EAssetRegistryTagsCaller InCaller = EAssetRegistryTagsCaller::Uncategorized);
 
    TMap<FName, UObject::FAssetRegistryTag> Tags;
    const UObject* Object = nullptr;
    const ITargetPlatform* TargetPlatform = nullptr;
    const FAssetBundleData* BundleResult = nullptr;
    EAssetRegistryTagsCaller Caller = EAssetRegistryTagsCaller::Uncategorized;
    UE::Cook::ECookType CookType = UE::Cook::ECookType::Unknown;
    UE::Cook::ECookingDLC CookingDLC = UE::Cook::ECookingDLC::Unknown;
    bool bProceduralSave = false;
    bool bWantsBundleResult = false;
    bool bWantsCookTags = false;
    bool bFullUpdateRequested = false;
};
 
class FAssetRegistryTagsContext
{
public:
    // This is an implicit constructor to reduce the boilerplate for calling GetAssetRegistryTags
    COREUOBJECT_API FAssetRegistryTagsContext(FAssetRegistryTagsContextData& InData);
    COREUOBJECT_API FAssetRegistryTagsContext(const FAssetRegistryTagsContext& Other);
 
    COREUOBJECT_API EAssetRegistryTagsCaller GetCaller() const;
    COREUOBJECT_API const UObject* GetObject() const;
 
    COREUOBJECT_API bool IsFullUpdate() const;
    COREUOBJECT_API bool IsSaving() const;
    COREUOBJECT_API bool IsProceduralSave() const;
    COREUOBJECT_API bool IsCooking() const;
    COREUOBJECT_API const ITargetPlatform* GetTargetPlatform() const;
 
    COREUOBJECT_API bool IsCookByTheBook() const;
    COREUOBJECT_API bool IsCookOnTheFly() const;
    COREUOBJECT_API bool IsCookTypeUnknown() const;
    COREUOBJECT_API UE::Cook::ECookType GetCookType() const;
    COREUOBJECT_API UE::Cook::ECookingDLC GetCookingDLC() const;
 
    COREUOBJECT_API UObject::FAssetRegistryTag& FindOrAddTag(FName TagName, bool* bOutAlreadyExists=nullptr);
    COREUOBJECT_API UObject::FAssetRegistryTag* FindTag(FName TagName);
    COREUOBJECT_API bool ContainsTag(FName TagName) const;
    COREUOBJECT_API void AddTag(UObject::FAssetRegistryTag TagResult);
    COREUOBJECT_API void RemoveTag(FName TagName);
    COREUOBJECT_API int32 GetNumTags() const;
    COREUOBJECT_API void EnumerateTags(TFunctionRef<void(const UObject::FAssetRegistryTag&)> Visitor) const;
 
    COREUOBJECT_API bool WantsBundleResult() const;
    COREUOBJECT_API const FAssetBundleData* GetBundleResult();
    COREUOBJECT_API void SetBundleResult(const FAssetBundleData* InBundleResult);
 
    COREUOBJECT_API bool WantsCookTags() const;
 
    COREUOBJECT_API UObject::FAssetRegistryTag& FindOrAddCookTag(FName TagName, bool* bOutAlreadyExists);
    COREUOBJECT_API UObject::FAssetRegistryTag* FindCookTag(FName TagName);
    COREUOBJECT_API bool ContainsCookTag(FName TagName) const;
    COREUOBJECT_API void AddCookTag(UObject::FAssetRegistryTag TagResult);
    COREUOBJECT_API void RemoveCookTag(FName TagName);
 
private:
    bool TryValidateTagName(FName TagName) const;
    FName TransformTagName(FName TagName, FStringView PrefixToAdd, bool bCreateNameIfDoesNotExist = true) const;
    UObject::FAssetRegistryTag& FindOrAddTagInternal(FName TagName, FStringView PrefixToAdd, bool* bOutAlreadyExists);
    UObject::FAssetRegistryTag* FindTagInternal(FName TagName, FStringView PrefixToAdd);
    bool ContainsTagInternal(FName TagName, FStringView PrefixToAdd) const;
    void AddTagInternal(UObject::FAssetRegistryTag&& TagResult, FStringView PrefixToAdd);
    void RemoveTagInternal(FName TagName, FStringView PrefixToAdd);
 
private:
    FAssetRegistryTagsContextData& Data;
    friend class UObject;
};