1. Epic GamesDeveloper
  3. UReplicationGraph

UReplicationGraph

Manages actor replication for an entire world / net driver

Unreal Engine C++ API Reference > Plugins > ReplicationGraph

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Transient, Config&61;Engine&41;  
class UReplicationGraph : public UReplicationDriver

Remarks

Manages actor replication for an entire world / net driver

Variables

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

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function void Associate a node to a specific connection.
Public function void Add a global node to the root that will have a chance to emit actor rep lists for all connections
Protected function Virtual void

AddReplayViewers ( UNetConnection* NetConnection,
FNetViewerArray& Viewers
)

  
Public function Virtual Const void  
Public function Virtual Const AReplicationGraphDebugActor *  
Public function T *

CreateNewNode ( FName NodeBaseName
)

 Creates a new node for the graph with a given base name.
Public function T * Creates a new node for the graph.
Public function Const void Print the Net Culling Distance of all actors in the RepGraph.
Public function Const UNetReplicationGraphConnection *  
Protected function UNetReplicationGraphConnection *  
Public function Const const TSharedPtr< FReplicationGraphGlobalData > &  
Public function Const uint32  
Public function Const uint16

GetReplicationPeriodFrameForFrequency ( float NetUpdateFrequency
)

  
Public function Virtual Const UWorld *  
Protected function void

HandleStarvedActorList ( const UNetReplicationGraphConnection& RepGraphConnection,
const FPrioritizedRepList& List,
int32 StartIdx,
FPerConnectionActorInfoMap& ConnectionActorInfoMap,
uint32 FrameNum
)

 Sets the next timeout frame for the actors in the list along with their dependent actors
Protected function Virtual void Override this function to init/configure graph for a specific connection.
Protected function Virtual void Override this function to initialize the per-class data for replication
Protected function Virtual void Override this function to init/configure your project's Global Graph
Protected function Virtual void  
Protected function Virtual void  
Public function bool  
Public function Virtual Const void  
Public function Virtual Const void  
Public function Virtual Const void  
Public function void  
Public function void  
Protected function Virtual void Event called after ServerReplicateActors to dispatch the replication stats from this frame
Public function void  
Public function void  
Public function void  
Protected function void

ReplicateActorListsForConnections_Default ( UNetReplicationGraphConnection* ConnectionManager,
FGatheredReplicationActorLists& GatheredReplicationListsForConnection,
FNetViewerArray& Viewers
)

 Default Replication Path
Protected function void "FastShared" Replication Path
Public function Virtual void

ReplicateActorsForConnection ( UNetConnection* NetConnection,
FPerConnectionActorInfoMap& ConnectionActorInfoMap,
UNetReplicationGraphConnection* ConnectionManager,
const uint32 FrameNum
)

  
Public function int64

ReplicateSingleActor ( AActor* Actor,
FConnectionReplicationActorInfo& ActorInfo,
FGlobalActorReplicationInfo& GlobalActorInfo,
FPerConnectionActorInfoMap& ConnectionActorInfoMap,
UNetReplicationGraphConnection& ConnectionManager,
const uint32 FrameNum
)

  
Public function int64

ReplicateSingleActor_FastShared ( AActor* Actor,
FConnectionReplicationActorInfo& ConnectionData,
FGlobalActorReplicationInfo& GlobalActorInfo,
UNetReplicationGraphConnection& ConnectionManager,
const uint32 FrameNum
)

  
Public function Virtual void  
Public function Virtual void  
Public function void  
Public function void

SetActorDiscoveryBudget ( int32 ActorDiscoveryBudgetInKBytesPerSec
)

  
Public function void

SetAllCullDistanceSettingsForActor ( const FActorRepListType& Actor,
float CullDistanceSquared
)

 Sets the global and connection-specific cull distance setting of this actor
Public function Const void

UpdateActorChannelCloseFrameNum ( AActor* Actor,
FConnectionReplicationActorInfo& ConnectionData,
const FGlobalActorReplicationInfo& GlobalData,
const uint32 FrameNum,
UNetConnection* NetConnection
)

  
Public function void  
Public function Virtual void  

Overridden from UReplicationDriver

  Type Name Description
Public function Virtual void

AddClientConnection ( UNetConnection* NetConnection
)

 Called by the NetDriver when the client connection is ready/added to the NetDriver's client connection list
Public function Virtual void

AddNetworkActor ( AActor* Actor
)

  
Public function Virtual void

FlushNetDormancy ( AActor* Actor,
bool bWasDormInitial
)

  
Public function Virtual void

ForceNetUpdate ( AActor* Actor
)

  
Public function Virtual void

InitForNetDriver ( UNetDriver* InNetDriver
)

 Called to associate a netdriver with a rep driver.
Public function Virtual void Called after World and NetDriver have been set.
Public function Virtual void

NotifyActorDormancyChange ( AActor* Actor,
ENetDormancy OldDormancyState
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void Called when a destruction info is created for an actor.
Public function Virtual void Called after the netdriver has handled TickDispatch
Public function Virtual bool

ProcessRemoteFunction ( AActor* Actor,
UFunction* Function,
void* Parameters,
FOutParmRec* OutParms,
FFrame* Stack,
UObject* SubObject
)

 Handles an RPC.
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual int32

ServerReplicateActors ( float DeltaSeconds
)

 The main function that will actually replicate actors. Called every server tick.
Public function Virtual void

SetRepDriverWorld ( UWorld* InWorld
)

 Called to associate a world with a rep driver. This will be called before InitForNetDriver
Public function Virtual void

SetRoleSwapOnReplicate ( AActor* Actor,
bool bSwapRoles
)

  
Public function Virtual void  

Overridden from UObject

  Type Name Description
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public struct FFastSharedPathConstants    
Protected struct FFrameReplicationStats Collects basic stats on the replicated actors  
Public struct 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

  Type Name Description
Protected function void

HandleStarvedActorList ( const FPrioritizedRepList& List,
int32 StartIdx,
FPerConnectionActorInfoMap& ConnectionActorInfoMap,
uint32 FrameNum
)

 This function has been replaced with a version that needs to receive a UNetReplicationGraphConnection

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page