MetaData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Map.h"
#include "Containers/UnrealString.h"
#include "HAL/Platform.h"
#include "Serialization/StructuredArchive.h"
#include "UObject/NameTypes.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/SoftObjectPath.h"
#include "UObject/UObjectGlobals.h"
#include "UObject/WeakObjectPtr.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ScriptMacros.h"
 
#include "MetaData.generated.h"
 
class FArchive;
class UPackage;
 
/*-----------------------------------------------------------------------------
    UMetaData.
-----------------------------------------------------------------------------*/
 
UCLASS(MinimalAPI, Deprecated, Config = Engine)
class UDEPRECATED_MetaData : public UObject
{
    GENERATED_UCLASS_BODY()
 
public:
    TMap< FWeakObjectPtr, TMap<FName, FString> > ObjectMetaDataMap;
 
    TMap< FName, FString > RootMetaDataMap;
 
public:
    // UObject interface
    COREUOBJECT_API virtual void Serialize(FArchive& Ar) override;
    virtual bool NeedsLoadForEditorGame() const override { return true; }
    virtual bool IsAsset() const override { return false; }
    // End of UObject interface
 
private:
    static COREUOBJECT_API void InitializeRedirectMap();
 
private:
    // Redirect map from deprecated keys to current key names
    static COREUOBJECT_API TMap<FName, FName> KeyRedirectMap;
};
 
#if WITH_METADATA
class FMetaData
{
public:
    TMap< FSoftObjectPath, TMap<FName, FString> > ObjectMetaDataMap;
 
    TMap< FName, FString > RootMetaDataMap;
 
    void RemapObjectKeys(FName OldPackageName, FName NewPackageName);
 
public:
    [[nodiscard]] FMetaData() = default;
    [[nodiscard]] explicit consteval FMetaData(EConstEval)
    : ObjectMetaDataMap(ConstEval)
    , RootMetaDataMap(ConstEval)
    {
    }
 
    // MetaData utility functions
 
    COREUOBJECT_API const FString& GetValue(const UObject* Object, const TCHAR* Key);
    
    COREUOBJECT_API const FString& GetValue(const UObject* Object, FName Key);
 
    bool HasValue(const UObject* Object, const TCHAR* Key)
    {
        return FindValue(Object, Key) != nullptr;
    }
 
    bool HasValue(const UObject* Object, FName Key)
    {
        return FindValue(Object, Key) != nullptr;
    }
 
    COREUOBJECT_API const FString* FindValue(const UObject* Object, const TCHAR* Key);
 
    COREUOBJECT_API const FString* FindValue(const UObject* Object, FName Key);
 
    COREUOBJECT_API bool HasObjectValues(const UObject* Object);
 
    COREUOBJECT_API void SetObjectValues(const UObject* Object, const TMap<FName, FString>& Values);
 
    COREUOBJECT_API void SetObjectValues(const UObject* Object, TMap<FName, FString>&& Values);
 
    COREUOBJECT_API void SetValue(const UObject* Object, const TCHAR* Key, const TCHAR* Value);
 
    COREUOBJECT_API void SetValue(const UObject* Object, FName Key, const TCHAR* Value);
 
    COREUOBJECT_API void RemoveValue(const UObject* Object, const TCHAR* Key);
 
    COREUOBJECT_API void RemoveValue(const UObject* Object, FName Key);
 
    static COREUOBJECT_API TMap<FName, FString>* GetMapForObject(const UObject* Object);
 
    static COREUOBJECT_API void CopyMetadata(UObject* SourceObject, UObject* DestObject);
 
    COREUOBJECT_API void RemoveMetaDataOutsidePackage(UPackage* MetaDataPackage);
 
    friend FArchive& operator<<(FArchive& Ar, FMetaData& MetaData)
    {
        return Ar << MetaData.ObjectMetaDataMap << MetaData.RootMetaDataMap;
    }
 
    // Returns the remapped key name, or NAME_None was not remapped.
    static COREUOBJECT_API FName GetRemappedKeyName(FName OldKey);
 
private:
    static COREUOBJECT_API void InitializeRedirectMap();
 
    // Redirect map from deprecated keys to current key names
    static COREUOBJECT_API TMap<FName, FName> KeyRedirectMap;
};
 
struct FMetaDataUtilities
{
private:
    static class FAutoConsoleCommand DumpAllConsoleCommand;
 
public:
    COREUOBJECT_API static void DumpAllMetaData();
 
    COREUOBJECT_API static void DumpMetaData(UPackage* Package);
 
private:
    friend class UObject;
 
    class FMoveMetadataHelperContext
    {
    public:
        FMoveMetadataHelperContext(UObject *SourceObject, bool bSearchChildren);
 
        ~FMoveMetadataHelperContext();
    private:
 
        UPackage* OldPackage;
 
        UObject* OldObject;
 
        FSoftObjectPath OldObjectPath;
 
        bool bShouldSearchChildren;
    };
 
private:
    FMetaDataUtilities() {}
};
 
#endif //WITH_METADATA