RemoteObjectSerialization.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/RemoteObjectTransfer.h"
 
namespace UE::RemoteObject::Handle { struct FRemoteObjectStub; }
 
#ifndef UE_WITH_REMOTEOBJECTARCHIVE_DEBUGGING
#define UE_WITH_REMOTEOBJECTARCHIVE_DEBUGGING 0
#endif
 
namespace UE::RemoteObject::Serialization
{
    enum class ERemoteObjectSerializationFlags : uint8
    {
        None = 0,
        UseExistingObjects = (1 << 0),          // If possible re-use existing UObjects and don't reconstruct them when deserializing object data
        PreserveRemoteReferences = (1 << 1),        // Don't overwrite references to objects that are remote
        Resetting = (1 << 2)                        // Indicates that the serialization process is resetting an object to its archetype state
    };
    ENUM_CLASS_FLAGS(ERemoteObjectSerializationFlags);
 
    struct FRemoteObjectHeader
    {
        FName Name;
        FRemoteObjectId RemoteId;
        TObjectPtr<UClass> Class;
        TObjectPtr<UObject> Outer;
        TObjectPtr<UObject> Archetype;
        int32 InternalFlags = 0;
        int64 NextOffset = 0;
 
        int32 SerialNumber = 0;
    };
 
    struct FRemoteObjectConstructionParams
    {
        FName Name;
        FRemoteObjectId OuterId;
        FRemoteObjectId RemoteId;
        int32 SerialNumber = 0;
    };
 
    class FRemoteObjectConstructionOverrides
    {
        TArray<FRemoteObjectConstructionParams> Overrides;
 
    public:
 
        FRemoteObjectConstructionOverrides() = default;
        explicit FRemoteObjectConstructionOverrides(const TArray<FRemoteObjectHeader>& InObjectHeaders);
 
        const FRemoteObjectConstructionParams* Find(FName InName, UObject* InOuter) const;
    };
 
    class FRemoteObjectConstructionOverridesStack final
    {
        TArray<const FRemoteObjectConstructionOverrides*> Stack;
 
    public:
 
        FRemoteObjectConstructionOverridesStack() = default;
        ~FRemoteObjectConstructionOverridesStack();
 
        COREUOBJECT_API static FRemoteObjectConstructionOverridesStack& Get();
 
        void Push(const FRemoteObjectConstructionOverrides& InOverrides)
        {
            Stack.Push(&InOverrides);
        }
        void Pop()
        {
            Stack.Pop(EAllowShrinking::No);
        }
        bool IsEmpty() const
        {
            return !Stack.Num();
        }
        COREUOBJECT_API const FRemoteObjectConstructionParams* Find(FName InName, UObject* InOuter) const;
    };
 
    class FRemoteObjectConstructionOverridesScope final
    {
        FRemoteObjectConstructionOverridesStack& Stack;
        FRemoteObjectConstructionOverrides* Overrides = nullptr;
 
    public:
        explicit FRemoteObjectConstructionOverridesScope(FRemoteObjectConstructionOverrides* InOverrides)
            : Stack(FRemoteObjectConstructionOverridesStack::Get())
            , Overrides(InOverrides)
        {
            if (Overrides)
            {
                Stack.Push(*Overrides);
            }
        }
        ~FRemoteObjectConstructionOverridesScope()
        {
            if (Overrides)
            {
                Stack.Pop();
            }
        }
    };
 
    FRemoteObjectData SerializeObjectData(UObject* InObject, TSet<UObject*>& OutObjects, TSet<UObject*>& OutReferencedObjects, const FUObjectMigrationContext* MigrationContext);
 
    int32 DeserializeObjectData(FRemoteObjectData& ObjectData, const FUObjectMigrationContext* MigrationContext, TArray<FRemoteObjectId>& OutObjectRemoteIds, TArray<UObject*>& OutReceivedObjects, ERemoteObjectSerializationFlags DeserializeFlags = ERemoteObjectSerializationFlags::None);
 
    UObject* FindCanonicalRootObjectForSerialization(UObject* Object);
 
} // namespace UE::RemoveObject::Serialization
 
 
namespace UE::RemoteObject::Serialization::Disk
{
    void LoadObjectFromDisk(const FUObjectMigrationContext& MigrationContext);
    void SaveObjectToDisk(const UE::RemoteObject::Transfer::FMigrateSendParams& Params);
}