FrequencyRules

FrequencyRules

#Overview

name: FrequencyRules

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

It is referenced in 2 C++ source files.

#Summary

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Plugins/Developer/Concert/ConcertApp/MultiUserClient/Config/BaseMultiUserClient.ini:3, section: [/Script/MultiUserClient.MultiUserReplicationSettings]

• INI Section: /Script/MultiUserClient.MultiUserReplicationSettings
• Raw value: (DefaultObjectFrequencySettings=(ReplicationMode=SpecifiedRate,ReplicationRate=30),FrequencyRuleStack=((ReplicationSettings=(ReplicationRate=60),SubobjectMatchingRules=(SubobjectMatchingRules=(("/Script/Engine.Actor", (IncludeClasses=("/Script/CinematicCamera.CineCameraComponent"))))))))
• Is Array: False

#References in C++ code

#Callsites

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

#Loc: <Workspace>/Engine/Plugins/Developer/Concert/ConcertApp/MultiUserClient/Source/MultiUserClient/Private/Replication/Frequency/FrequencyChangeTracker.cpp:43

Scope (from outer to inner):

file
namespace    UE::MultiUserClient
function     FFrequencyChangelist FFrequencyChangeTracker::BuildForSubmission

Source code excerpt:

		// Set frequency defaults if either this is the first time we're submitting to the server or the user has changes the project settings since.
		const FConcertObjectReplicationSettings& DefaultsToSet = UMultiUserReplicationSettings::Get()->FrequencyRules.DefaultObjectFrequencySettings;
		if (DefaultsToSet != StreamSynchronizer.GetFrequencySettings().Defaults)
		{
			Result.NewDefaults = DefaultsToSet;
		}
		
		return Result;

#Loc: <Workspace>/Engine/Plugins/Developer/Concert/ConcertApp/MultiUserClient/Source/MultiUserClient/Private/Settings/MultiUserReplicationSettings.h:27

Scope (from outer to inner):

file
class        class UMultiUserReplicationSettings : public UObject

Source code excerpt:

	/** Determines the frequency settings applied to an object set by default when it is added to the stream. */
	UPROPERTY(Config, Category = "Replication Settings|Frequency", EditAnywhere)
	FMultiUserFrequencyDefaultRules FrequencyRules;

	/**
	 * Checks Object against these settings and returns override settings to set for this object.
	 * @param Object An object that the user just added to the stream
	 */
	TOptional<FConcertObjectReplicationSettings> DetermineObjectFrequencySettings(UObject& Object) const { return FrequencyRules.FindOverrideSettings(Object); }
};