GameNetworkManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Engine/EngineTypes.h"
#include "GameFramework/Info.h"
#include "GameNetworkManager.generated.h"
 
UENUM()
enum EStandbyType : int
{
    STDBY_Rx,
    STDBY_Tx,
    STDBY_BadPing,
    STDBY_MAX,
};
 
 
UCLASS(config=Game, notplaceable, MinimalAPI)
class AGameNetworkManager : public AInfo
{
    GENERATED_UCLASS_BODY()
 
    //======================================================================================================================
    // Analytics
 
    /* If packet loss goes over this value, we have bad packet loss. Value is between 0 and 1.*/
    UPROPERTY(GlobalConfig)
    float BadPacketLossThreshold = 0.05f;
 
    /* If the packet loss goes over this threshold, we have severe packet loss. Value is between 0 and 1*/
    UPROPERTY(GlobalConfig)
    float SeverePacketLossThreshold = 0.15f;
 
    UPROPERTY(GlobalConfig)
    int32 BadPingThreshold;
 
    UPROPERTY(GlobalConfig)
    int32 SeverePingThreshold;
 
    //======================================================================================================================
    // Listen/dedicated server dynamic bandwidth (NetSpeed) adjustment
    
    UPROPERTY()
    int32 AdjustedNetSpeed;
 
    UPROPERTY()
    float LastNetSpeedUpdateTime;
 
    UPROPERTY(globalconfig)
    int32 TotalNetBandwidth;
 
    UPROPERTY(globalconfig)
    int32 MinDynamicBandwidth;
 
    UPROPERTY(globalconfig)
    int32 MaxDynamicBandwidth;
 
    //======================================================================================================================
    // Standby cheat detection
    
    UPROPERTY(config)
    uint32 bIsStandbyCheckingEnabled:1;
 
    UPROPERTY()
    uint32 bHasStandbyCheatTriggered:1;
 
    UPROPERTY(config)
    float StandbyRxCheatTime;
 
    UPROPERTY(config)
    float StandbyTxCheatTime;
 
    UPROPERTY(config)
    float PercentMissingForRxStandby;
 
    UPROPERTY(config)
    float PercentMissingForTxStandby;
 
    UPROPERTY(config)
    float PercentForBadPing;
 
    UPROPERTY(config)
    float JoinInProgressStandbyWaitTime;
 
    //======================================================================================================================
    // Player replication
    
    UPROPERTY(GlobalConfig)
    float MoveRepSize;
 
    UPROPERTY(GlobalConfig)
    float MAXPOSITIONERRORSQUARED;
 
    UPROPERTY(GlobalConfig)
    float MAXNEARZEROVELOCITYSQUARED;
 
    UPROPERTY(GlobalConfig)
    float CLIENTADJUSTUPDATECOST;
 
    UPROPERTY(GlobalConfig)
    float MAXCLIENTUPDATEINTERVAL;
 
    UPROPERTY(GlobalConfig)
    float MaxClientForcedUpdateDuration;
    
    UPROPERTY(GlobalConfig)
    float ServerForcedUpdateHitchThreshold;
 
    UPROPERTY(GlobalConfig)
    float ServerForcedUpdateHitchCooldown;
 
    UPROPERTY(GlobalConfig)
    float MaxMoveDeltaTime;
 
    UPROPERTY(GlobalConfig)
    float MaxClientSmoothingDeltaTime;
 
    UPROPERTY(GlobalConfig)
    float ClientNetSendMoveDeltaTime;
 
    UPROPERTY(GlobalConfig)
    float ClientNetSendMoveDeltaTimeThrottled;
 
    UPROPERTY(GlobalConfig)
    float ClientNetSendMoveDeltaTimeStationary;
 
    UPROPERTY(GlobalConfig)
    int32 ClientNetSendMoveThrottleAtNetSpeed;
 
    UPROPERTY(GlobalConfig)
    int32 ClientNetSendMoveThrottleOverPlayerCount;
 
    UPROPERTY(GlobalConfig)
    float ClientErrorUpdateRateLimit;
 
    UPROPERTY(GlobalConfig)
    float ClientNetCamUpdateDeltaTime;
 
    UPROPERTY(GlobalConfig)
    float ClientNetCamUpdatePositionLimit;
 
    UPROPERTY(GlobalConfig)
    bool ClientAuthorativePosition;
 
    //======================================================================================================================
    // Movement Time Discrepancy settings for Characters (speed hack detection and prevention)
 
    UPROPERTY(GlobalConfig)
    bool bMovementTimeDiscrepancyDetection;
 
    UPROPERTY(GlobalConfig)
    bool bMovementTimeDiscrepancyResolution;
 
    UPROPERTY(GlobalConfig)
    float MovementTimeDiscrepancyMaxTimeMargin;
 
    UPROPERTY(GlobalConfig)
    float MovementTimeDiscrepancyMinTimeMargin;
 
    UPROPERTY(GlobalConfig)
    float MovementTimeDiscrepancyResolutionRate;
 
    UPROPERTY(GlobalConfig)
    float MovementTimeDiscrepancyDriftAllowance;
 
    UPROPERTY(GlobalConfig)
    bool bMovementTimeDiscrepancyForceCorrectionsDuringResolution;
 
    ENGINE_API virtual void UpdateNetSpeeds(bool bIsLanMatch);
 
    ENGINE_API virtual void UpdateNetSpeedsTimer();
 
    ENGINE_API virtual bool IsInLowBandwidthMode();
 
    //======================================================================================================================
    // Player replication
 
    ENGINE_API virtual bool WithinUpdateDelayBounds(class APlayerController* PC, float LastUpdateTime) const;
 
    ENGINE_API virtual bool ExceedsAllowablePositionError(FVector LocDiff) const;
 
    ENGINE_API virtual bool NetworkVelocityNearZero(FVector InVelocity) const;
    ENGINE_API virtual void PostInitializeComponents() override;
 
    ENGINE_API virtual int32 CalculatedNetSpeed();
    
    //======================================================================================================================
    // Standby cheat detection
    ENGINE_API virtual void EnableStandbyCheatDetection(bool bIsEnabled);
 
    ENGINE_API virtual void StandbyCheatDetected(EStandbyType StandbyType);
 
    UPROPERTY(globalconfig)
    bool    bUseDistanceBasedRelevancy;
 
protected:
 
    FTimerHandle TimerHandle_UpdateNetSpeedsTimer;  
};