OnlineReplStructs.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
//
// Unreal networking serialization helpers
//
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Class.h"
#include "Online/CoreOnline.h"
#include "OnlineReplStructs.generated.h"
 
class FJsonValue;
enum class EUniqueIdEncodingFlags : uint8;
 
USTRUCT(BlueprintType, DisplayName = "Unique Net Id")
struct FUniqueNetIdRepl : public FUniqueNetIdWrapper
{
    GENERATED_USTRUCT_BODY()
 
    FUniqueNetIdRepl()
    {
    }
 
    FUniqueNetIdRepl(TYPE_OF_NULLPTR)
    {
    }
 
    FUniqueNetIdRepl(const FUniqueNetIdRepl& InWrapper)
        : FUniqueNetIdWrapper(InWrapper.Variant)
    {
    }
 
    FUniqueNetIdRepl(const FUniqueNetIdWrapper& InWrapper)
        : FUniqueNetIdWrapper(InWrapper)
    {
    }
 
    FUniqueNetIdRepl(const FUniqueNetIdRef& InUniqueNetId)
        : FUniqueNetIdWrapper(InUniqueNetId)
    {
    }
 
    FUniqueNetIdRepl(const FUniqueNetIdPtr& InUniqueNetId)
        : FUniqueNetIdWrapper(InUniqueNetId)
    {
    }
    
    FUniqueNetIdRepl(const FUniqueNetId& InUniqueNetId)
        : FUniqueNetIdWrapper(InUniqueNetId)
    {
    }
 
    virtual ~FUniqueNetIdRepl() {}
 
    virtual void SetUniqueNetId(const FUniqueNetIdPtr& UniqueNetId) override
    {
        ReplicationBytes.Empty();
        FUniqueNetIdWrapper::SetUniqueNetId(UniqueNetId);
    }
 
    virtual void SetAccountId(const UE::Online::FAccountId& AccountId) override
    {
        ReplicationBytes.Empty();
        FUniqueNetIdWrapper::SetAccountId(AccountId);
    }
 
    bool ExportTextItem(FString& ValueStr, FUniqueNetIdRepl const& DefaultValue, UObject* Parent, int32 PortFlags, UObject* ExportRootScope) const;
 
    bool ImportTextItem(const TCHAR*& Buffer, int32 PortFlags, UObject* Parent, FOutputDevice* ErrorText);
 
    ENGINE_API bool NetSerialize(FArchive& Ar, class UPackageMap* Map, bool& bOutSuccess);
 
    void NetSerializeLoadV1Encoded(FArchive& Ar, const EUniqueIdEncodingFlags EncodingFlags, bool& bOutSuccess);
    void NetSerializeLoadV1Unencoded(FArchive& Ar, const EUniqueIdEncodingFlags EncodingFlags, bool& bOutSuccess);
    void NetSerializeLoadV2(FArchive& Ar, const EUniqueIdEncodingFlags EncodingFlags, bool& bOutSuccess);
 
    ENGINE_API friend FArchive& operator<<( FArchive& Ar, FUniqueNetIdRepl& UniqueNetId);
 
    bool Serialize(FArchive& Ar);
    
    ENGINE_API TSharedRef<FJsonValue> ToJson() const;
    ENGINE_API void FromJson(const FString& InValue);
 
    friend inline uint32 GetTypeHash(FUniqueNetIdRepl const& Value)
    {
        if (Value.IsValid())
        {
            return GetTypeHash(*Value);
        }
        else
        {
            // If we hit this, something went wrong and we have received an unhashable wrapper.
            return INDEX_NONE;
        }
    }
 
protected:
 
    void UniqueIdFromString(FName Type, const FString& Contents);
    void MakeReplicationData();
    void MakeReplicationDataV1();
    void MakeReplicationDataV2();
    UPROPERTY(Transient)
    TArray<uint8> ReplicationBytes;
    
    static bool ShouldExportTextItemAsQuotedString(const FString& NetIdStr);
};
 
template<>
struct TStructOpsTypeTraits<FUniqueNetIdRepl> : public TStructOpsTypeTraitsBase2<FUniqueNetIdRepl>
{
    enum 
    {
        // Can be copied via assignment operator
        WithCopy = true,
        // Requires custom serialization
        WithSerializer = true,
        // Requires custom net serialization
        WithNetSerializer = true,
        // Can share serialization state across connections
        WithNetSharedSerialization = true,
        // Requires custom Identical operator for rep notifies in PostReceivedBunch()
        WithIdenticalViaEquality = true,
        // Export contents of this struct as a string (displayall, obj dump, etc)
        WithExportTextItem = true,
        // Import string contents as a unique id
        WithImportTextItem = true
    };
    static constexpr EPropertyObjectReferenceType WithSerializerObjectReferences = EPropertyObjectReferenceType::None;
};
 
ENGINE_API void TestUniqueIdRepl(class UWorld* InWorld);