UMassReplicationManager

Manages the creation of NetworkIDs, ClientBubbles and ClientViewers.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USubsystem

UWorldSubsystem

UMassReplicationManager

References

Module	MassReplication
Header	/Engine/Plugins/Runtime/MassGameplay/Source/MassReplication/Public/MassReplicationManager.h
Include	#include "MassReplicationManager.h"

Syntax

UCLASS()
class UMassReplicationManager : public UWorldSubsystem

Remarks

Manages the creation of NetworkIDs, ClientBubbles and ClientViewers. NetworkIDs are per replicated Agent Entity and are unique and replicated between server and clients. ClientBubbles relate to the player controller that owns the parent UNetConnection to a Client machine. ClientViewers relate to all the player controllers that have a parent or child UNetConnection to a single Client machine (split screen etc).

Variables

	Name	Description
TArray< FMassCl...	BubbleInfoArray
FMassClientHand...	ClientHandleManager	Clients free list FMassClientHandle manager, handles will to the indices of FMassClientReplicationData::ClientBubbles
TArray< FClient...	ClientsViewerHandles	An Array of each Clients viewer handles (split screen players sharing the same client connections).
TArray< FViewer...	ClientToViewerHandleArray	A free list array of FViewerClientPairs.
TMap< FMassNetw...	EntityInfoMap
UMassEntitySubs...	EntitySystem
uint64	LastSynchronizedFrame	Used to make sure the FMassEntityHandle_ClientReplications are synchronized immediately before they are needed
UMassLODManager...	MassLODManager
UE::MassReplica...	OnMassAgentAdded	Broadcast just after a mass agent is added to the client simulation
UE::MassReplica...	OnRemovingMassAgent	Broadcast just before a mass agent is removed from the client simulation
TArray< FViewer...	ViewerToClientHandleArray	A free list array of FViewerClientPairs.
UWorld *	World

Functions

	Name	Description
void	AddClient ( FMassViewerHandle ViewerHandle, APlayerController& InController )	Adds a Client and sets up all the data relevant to the bubble.
void	DebugCheckArraysAreInSync()
EFindOrAddMa...	FindAndUpdateOrAddMassEntityInfo ( const FMassNetworkID NetworkID, int32 ReplicationID, const FMassReplicationEntityInfo&#... )	Finds or adds an FMassReplicationEntityInfo to the EntityInfoMap for an Entity with NetWorkID.
FMassEntityH...	FindEntity ( const FMassNetworkID NetworkID )
const FMassR...	FindMassEntityInfo ( const FMassNetworkID NetworkID )	Finds the FMassReplicationEntityInfo for the Entity with NetworkID.
FMassReplica...	FindMassEntityInfoMutable ( const FMassNetworkID NetworkID )
FMassBubbleI...	GetBubbleInfoClassHandle ( const TSubclassOf< AMassClientBubbl... )
AMassClientB...	GetClientBubble ( FMassBubbleInfoClassHandle BubbleCl..., FMassClientHandle ClientHandle )	Gets the client bubble safely
AMassClientB...	GetClientBubbleChecked ( FMassBubbleInfoClassHandle BubbleCl..., FMassClientHandle ClientHandle )	Get the client bubble. Faster version using check()s
const TArray...	GetClientReplicationHandles()
const FClien...	GetClientViewers ( FMassClientHandle Handle )	Gets the client viewers safely
const FClien...	GetClientViewersChecked ( FMassClientHandle Handle )	Gets the client viewers. Faster version using check()s
const TMap< ...	GetEntityInfoMap()
FMassNetwork...	GetNetIDFromHandle ( const FMassEntityHandle Handle )	Retrieve network id from Mass handle.
FMassNetwork...	GetNextAvailableMassNetID()
UE::MassRepl...	GetOnMassAgentAdded()
UE::MassRepl...	GetOnRemovingMassAgent()
TType *	GetTypedClientBubble ( FMassBubbleInfoClassHandle BubbleCl..., FMassClientHandle ClientHandle )	Gets the client bubble safely returning the template type
TType *	GetTypedClientBubbleChecked ( FMassBubbleInfoClassHandle BubbleCl..., FMassClientHandle ClientHandle )	Gets the client bubble returning the template type. Faster version using check()s
bool	IsBubbleClassHandleValid ( FMassBubbleInfoClassHandle Handle )
FMassBubbleI...	RegisterBubbleInfoClass ( const TSubclassOf< AMassClientBubbl... )	Registers BubbleInfoClass with the system.
void	RemoveClient ( FMassClientHandle ClientHandle )	Removes a Client and removes up all the data relevant to the bubble
void	RemoveFromEntityInfoMap ( const FMassNetworkID NetworkID )
FMassEntityH...	ResetEntityIfValid ( const FMassNetworkID NetworkID, int32 ReplicationID )	Resets the item with NetworkID in the EntityInfoMap if its currently Set / Valid and its the most recent ReplicationID.
void	SetEntity ( const FMassNetworkID NetworkID, const FMassEntityHandle Entity )	Must be called immediately after an Entity is added to the simulation and after FindAndUpdateOrAddMassEntityInfo has been called
bool	SynchronizeClients ( const TArray< FViewerInfo >& Viewe... )
void	SynchronizeClientsAndViewers()
void	SynchronizeClientViewers ( const TArray< FViewerInfo >& Viewe... )

Overridden from USubsystem

		Name	Description
	void	Deinitialize()	Implement this for deinitialization of instances of the system
	void	Initialize ( FSubsystemCollectionBase& Collecti... )	USubsystem BEGIN.

Enums

	Name	Description
	EFindOrAddMassEntityInfo

Constants

Name	Description
CurrentNetMassCounter