Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > ReplicationGraph > UReplicationGraph

Light Theme

Dark Theme

UReplicationGraph

Manages actor replication for an entire world / net driver

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UReplicationDriver

UReplicationGraph

UBasicReplicationGraph

References

Module	ReplicationGraph
Header	/Engine/Plugins/Runtime/ReplicationGraph/Source/Public/ReplicationGraph.h
Include	#include "ReplicationGraph.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Transient, Config=Engine)
class UReplicationGraph : public UReplicationDriver

Remarks

Manages actor replication for an entire world / net driver

Variables

	Name	Description
TSet< AActor &#...	ActiveNetworkActors	The authoritative set of "what actors are in the graph"
bool	bEnableFullActorPrioritizationDetailsAllConnections
TArray< UNetRep...	Connections	List of connection managers. This list is not sorted and not stable.
TArray< UNetCon...	ConnectionsNeedingsPostTickDispatchFlush	Connections needing a FlushNet in PostTickDispatch
FReplicationGra...	CSVTracker
float	DestructInfoMaxDistanceSquared	The max distance between an FActorDestructionInfo and a connection that we will replicate.
FFastSharedPath...	FastSharedPathConstants
FOutBunch *	FastSharedReplicationBunch
UActorChannel &...	FastSharedReplicationChannel
FName	FastSharedReplicationFuncName
uint32	GlobalActorChannelFrameNumTimeout	How long, in frames, without replicating before an actor channel is closed on a connection.
FGlobalActorRep...	GlobalActorReplicationInfoMap
TArray< UReplic...	GlobalGraphNodes	A list of nodes that can add actors to all connections.
TSharedPtr< FRe...	GraphGlobals
UNetDriver *...	NetDriver
TArray< UNetRep...	PendingConnections	ConnectionManagers that we have created but haven't officially been added to the net driver's ClientConnection list.
TArray< UReplic...	PrepareForReplicationNodes	A list of nodes that want PrepareForReplication() to be called on them at the top of the replication frame.
FPrioritization...	PrioritizationConstants
FPrioritizedRep...	PrioritizedReplicationList	Temporary List we use while prioritizing actors
TSubclassOf< UN...	ReplicationConnectionManagerClass	The per-connection manager class to instantiate.
TClassMap< bool...	RPC_Multicast_OpenChannelForClass
TMap< FObjectKe...	RPCSendPolicyMap	Special case handling of specific RPCs. Currently supports immediate send/flush for multicasts

Constructors

	Name	Description
	UReplicationGraph()

Functions

	Name	Description
void	AddConnectionGraphNode ( UReplicationGraphNode* GraphNo..., UNetConnection* NetConnection )
void	AddConnectionGraphNode ( UReplicationGraphNode* GraphNo..., UNetReplicationGraphConnection*... )	Associate a node to a specific connection.
void	AddGlobalGraphNode ( UReplicationGraphNode* GraphNo... )	Add a global node to the root that will have a chance to emit actor rep lists for all connections
AReplication...	CreateDebugActor()
T *	CreateNewNode()	Creates a new node for the graph.
void	DebugPrintCullDistances ( UNetReplicationGraphConnection*... )	Print the Net Culling Distance of all actors in the RepGraph.
UNetReplicat...	FindOrAddConnectionManager ( UNetConnection* NetConnection )
const TShare...	GetGraphGlobals()
uint32	GetReplicationGraphFrame()
uint16	GetReplicationPeriodFrameForFrequency ( float NetUpdateFrequency )
UWorld *	GetWorld()
void	HandleStarvedActorList ( const FPrioritizedRepList& List, int32 StartIdx, FPerConnectionActorInfoMap& Connec..., uint32 FrameNum )
void	InitConnectionGraphNodes ( UNetReplicationGraphConnection*... )	Override this function to init/configure graph for a specific connection.
void	InitGlobalActorClassSettings()	Override this function to initialize the per-class data for replication
void	InitGlobalGraphNodes()	Override this function to init/configure your project's Global Graph
void	InitializeForWorld ( UWorld* World )
void	InitNode ( UReplicationGraphNode* Node )
bool	IsConnectionReady ( UNetConnection* Connection )
void	LogConnectionGraphNodes ( FReplicationGraphDebugInfo& DebugI... )
void	LogGlobalGraphNodes ( FReplicationGraphDebugInfo& DebugI... )
void	LogGraph ( FReplicationGraphDebugInfo& DebugI... )
void	NotifyConnectionSaturated ( UNetReplicationGraphConnection& Co... )
void	RemoveConnectionGraphNode ( UReplicationGraphNode* GraphNo..., UNetReplicationGraphConnection*... )
void	RemoveConnectionGraphNode ( UReplicationGraphNode* GraphNo..., UNetConnection* NetConnection )
void	ReplicateActorListsForConnections_Default ( UNetReplicationGraphConnection*..., FGatheredReplicationActorLists& Ga..., FNetViewerArray& Viewers )	Default Replication Path
void	ReplicateActorListsForConnections_FastShared ( UNetReplicationGraphConnection*..., FGatheredReplicationActorLists& Ga..., FNetViewerArray& Viewers )	"FastShared" Replication Path
int64	ReplicateSingleActor ( AActor* Actor, FConnectionReplicationActorInfo& A..., FGlobalActorReplicationInfo& Globa..., FPerConnectionActorInfoMap& Connec..., UNetReplicationGraphConnection& Co..., const uint32 FrameNum )
int64	ReplicateSingleActor_FastShared ( AActor* Actor, FConnectionReplicationActorInfo& C..., FGlobalActorReplicationInfo& Globa..., UNetReplicationGraphConnection& Co..., const uint32 FrameNum )
void	RouteAddNetworkActorToNodes ( const FNewReplicatedActorInfo& Act..., FGlobalActorReplicationInfo& Globa... )
void	RouteRemoveNetworkActorToNodes ( const FNewReplicatedActorInfo& Act... )
void	SetActorDestructionInfoToIgnoreDistanceCulling ( AActor* DestroyedActor )
void	SetActorDiscoveryBudget ( int32 ActorDiscoveryBudgetInKBytesP... )
void	SetAllCullDistanceSettingsForActor ( const FActorRepListType& Actor, float CullDistanceSquared )	Sets the global and connection-specific cull distance setting of this actor
void	UpdateActorChannelCloseFrameNum ( AActor* Actor, FConnectionReplicationActorInfo& C..., const FGlobalActorReplicationInfo&..., const uint32 FrameNum, UNetConnection* NetConnection )

Overridden from UReplicationDriver

	Name	Description
void	AddClientConnection ( UNetConnection* NetConnection )	Called by the NetDriver when the client connection is ready/added to the NetDriver's client connection list
void	AddNetworkActor ( AActor* Actor )
void	FlushNetDormancy ( AActor* Actor, bool bWasDormInitial )
void	ForceNetUpdate ( AActor* Actor )
void	InitForNetDriver ( UNetDriver* InNetDriver )	Called to associate a netdriver with a rep driver.
void	InitializeActorsInWorld ( UWorld* InWorld )	Called after World and NetDriver have been set.
void	NotifyActorDormancyChange ( AActor* Actor, ENetDormancy OldDormancyState )
void	NotifyActorFullyDormantForConnection ( AActor* Actor, UNetConnection* Connection )
void	NotifyActorTearOff ( AActor* Actor )
void	PostTickDispatch()	Called after the netdriver has handled TickDispatch
bool	ProcessRemoteFunction ( AActor* Actor, UFunction* Function, void* Parameters, FOutParmRec* OutParms, FFrame* Stack, UObject* SubObject )	Handles an RPC.
void	RemoveClientConnection ( UNetConnection* NetConnection )
void	RemoveNetworkActor ( AActor* Actor )
void	ResetGameWorldState()
int32	ServerReplicateActors ( float DeltaSeconds )	The main function that will actually replicate actors. Called every server tick.
void	SetRepDriverWorld ( UWorld* InWorld )	Called to associate a world with a rep driver. This will be called before InitForNetDriver
void	SetRoleSwapOnReplicate ( AActor* Actor, bool bSwapRoles )

Overridden from UObject

		Name	Description
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Classes

	Name	Description
	FFastSharedPathConstants
	FPrioritizationConstants	Prioritization Constants: these affect how the final priority of an actor is calculated in the prioritize phase

Constants

Name	Description
OnListRequestExceedsPooledSize	Invoked when a rep list is requested that exceeds the size of the preallocated lists

Deprecated Functions

		Name	Description
	void	ReplicateActorListsForConnection_Default ( UNetReplicationGraphConnection*..., FGatheredReplicationActorLists& Ga..., FNetViewer& Viewer )	Use the array format to support subconnections as well
	void	ReplicateActorListsForConnection_FastShared ( UNetReplicationGraphConnection*..., FGatheredReplicationActorLists& Ga..., FNetViewer& Viewer )	Use the array format to support subconnections as well

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss