NetworkVersion.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "Logging/LogMacros.h"
#include "Misc/EngineNetworkCustomVersion.h"
 
// The version number used for determining network compatibility. If zero, uses the engine compatible version.
#define ENGINE_NET_VERSION  0
 
// The version number used for determining replay compatibility
#define ENGINE_REPLAY_VERSION  ENGINE_NET_VERSION
 
CORE_API DECLARE_LOG_CATEGORY_EXTERN( LogNetVersion, Log, All );
 
class FNetworkReplayVersion
{
public:
    FNetworkReplayVersion() 
        : NetworkVersion(0)
        , Changelist(0)
    {
    }
 
    FNetworkReplayVersion(const FString& InAppString, const uint32 InNetworkVersion, const uint32 InChangelist) 
        : AppString(InAppString)
        , NetworkVersion(InNetworkVersion)
        , Changelist(InChangelist)
    {
    }
 
    FString     AppString;
    uint32      NetworkVersion;
    uint32      Changelist;
};
 
enum class EEngineNetworkRuntimeFeatures : uint16
{
    None = 0,
    IrisEnabled = 1 << None, // Are we running the Iris or Generic replication system
    UseRemoteObjectReferences = 1 << IrisEnabled, // Are UObjects being serialized as remote object references
};
ENUM_CLASS_FLAGS(EEngineNetworkRuntimeFeatures);
 
struct FNetworkVersion
{
    DECLARE_DELEGATE_RetVal( uint32, FGetLocalNetworkVersionOverride );
    static CORE_API FGetLocalNetworkVersionOverride GetLocalNetworkVersionOverride;
 
    DECLARE_DELEGATE_RetVal_TwoParams( bool, FIsNetworkCompatibleOverride, uint32, uint32 );
    static CORE_API FIsNetworkCompatibleOverride IsNetworkCompatibleOverride;
 
    DECLARE_DELEGATE_RetVal(uint32, FGetReplayCompatibleChangeListOverride);
    static CORE_API FGetReplayCompatibleChangeListOverride GetReplayCompatibleChangeListOverride;
 
    static CORE_API uint32 GetNetworkCompatibleChangelist();
    static CORE_API uint32 GetReplayCompatibleChangelist();
 
    UE_DEPRECATED(5.2, "Please use GetNetworkProtocolVersion instead.")
    static CORE_API uint32 GetEngineNetworkProtocolVersion();
    UE_DEPRECATED(5.2, "Please use GetNetworkProtocolVersion instead.")
    static CORE_API uint32 GetGameNetworkProtocolVersion();
 
    UE_DEPRECATED(5.2, "Please use GetCompatibleNetworkProtocolVersion instead.")
    static CORE_API uint32 GetEngineCompatibleNetworkProtocolVersion();
    UE_DEPRECATED(5.2, "Please use GetCompatibleNetworkProtocolVersion instead.")
    static CORE_API uint32 GetGameCompatibleNetworkProtocolVersion();
 
    static CORE_API uint32 GetNetworkProtocolVersion(const FGuid& VersionGuid);
    static CORE_API uint32 GetCompatibleNetworkProtocolVersion(const FGuid& VersionGuid);
 
    static CORE_API const FCustomVersionContainer& GetNetworkCustomVersions();
 
    static CORE_API void RegisterNetworkCustomVersion(const FGuid& VersionGuid, int32 Version, int32 CompatibleVersion, const FName& FriendlyName);
 
    static CORE_API uint32 GetLocalNetworkVersion( bool AllowOverrideDelegate=true );
 
    static CORE_API bool IsNetworkCompatible( const uint32 LocalNetworkVersion, const uint32 RemoteNetworkVersion );
 
    static CORE_API FNetworkReplayVersion GetReplayVersion();
 
    static CORE_API void SetProjectVersion(const TCHAR* InVersion);
 
    static CORE_API void SetGameNetworkProtocolVersion(uint32 GameNetworkProtocolVersion);
 
    static CORE_API void SetGameCompatibleNetworkProtocolVersion(uint32 GameCompatibleNetworkProtocolVersion);
 
    static CORE_API bool AreNetworkRuntimeFeaturesCompatible(EEngineNetworkRuntimeFeatures LocalFeatures, EEngineNetworkRuntimeFeatures RemoteFeatures);
 
    static CORE_API void DescribeNetworkRuntimeFeaturesBitset(EEngineNetworkRuntimeFeatures FeaturesBitflag, FStringBuilderBase& OutVerboseDescription);
    
    static const FString& GetProjectVersion() { return GetProjectVersion_Internal(); }
 
    static void InvalidateNetworkChecksum() { bHasCachedNetworkChecksum = false; }
 
protected:
 
    static CORE_API FString& GetProjectVersion_Internal();
 
    static CORE_API bool        bHasCachedNetworkChecksum;
    static CORE_API uint32  CachedNetworkChecksum;
 
    static CORE_API bool        bHasCachedReplayChecksum;
    static CORE_API uint32  CachedReplayChecksum;
 
    UE_DEPRECATED(5.2, "Now storing this value in NetworkCustomVersions, do not use directly.")
    static CORE_API uint32  EngineNetworkProtocolVersion;
    UE_DEPRECATED(5.2, "Now storing this value in NetworkCustomVersions, do not use directly.")
    static CORE_API uint32  GameNetworkProtocolVersion;
 
    UE_DEPRECATED(5.2, "Now storing this value in CompatibleNetworkCustomVersions, do not use directly.")
    static CORE_API uint32  EngineCompatibleNetworkProtocolVersion;
    UE_DEPRECATED(5.2, "Now storing this value in CompatibleNetworkCustomVersions, do not use directly.")
    static CORE_API uint32  GameCompatibleNetworkProtocolVersion;
};