MaxNetTickRate

MaxNetTickRate

#Overview

name: MaxNetTickRate

The value of this variable can be defined or overridden in .ini config files. 2 .ini config files referencing this setting variable.

It is referenced in 2 C++ source files.

#Summary

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/BaseEngine.ini:1641, section: [/Script/OnlineSubsystemUtils.IpNetDriver]

Location: <Workspace>/Engine/Config/BaseEngine.ini:2260, section: [/Script/SteamSockets.SteamSocketsNetDriver]

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Source/Runtime/Engine/Classes/Engine/NetDriver.h:866

Scope (from outer to inner):

file
class        class UNetDriver : public UObject, public FExec

Source code excerpt:

	/** Limit tick rate of replication to allow very high frame rates to still replicate data. A value less or equal to zero means use the engine tick rate. A value greater than zero will clamp the net tick rate to this value.  */
	UPROPERTY(Config)
	int32 MaxNetTickRate;

	/** @todo document */
	UPROPERTY(Config)
	int32 MaxInternetClientRate;

	/** @todo document */

#Loc: <Workspace>/Engine/Source/Runtime/Engine/Private/NetConnection.cpp:4362

Scope (from outer to inner):

file
function     void UNetConnection::Tick

Source code excerpt:


	FrameTime = CurrentRealtimeSeconds - LastTime;
	const int32 MaxNetTickRate = Driver->MaxNetTickRate;
	float EngineTickRate = GEngine->GetMaxTickRate(0.0f, false);
	// We want to make sure the DesiredTickRate stays at <= 0 if there's no tick rate limiting of any kind, since it's used later in the function for bandwidth limiting.
	if (MaxNetTickRate > 0 && EngineTickRate <= 0.0f)
	{
		EngineTickRate = MAX_flt;
	}
	const float MaxNetTickRateFloat = MaxNetTickRate > 0 ? float(MaxNetTickRate) : MAX_flt;
	const float DesiredTickRate = FMath::Clamp(EngineTickRate, 0.0f, MaxNetTickRateFloat);
	// Apply net tick rate limiting if the desired net tick rate is strictly less than the engine tick rate.
	if (!IsInternalAck() && MaxNetTickRateFloat < EngineTickRate && DesiredTickRate > 0.0f)
	{
		const float MinNetFrameTime = 1.0f/DesiredTickRate;
		if (FrameTime < MinNetFrameTime)