1. Epic GamesDeveloper
  3. UMassReplicationSubsystem

UMassReplicationSubsystem

Manages the creation of NetworkIDs, ClientBubbles and ClientReplicationInfo.

API > API/Plugins > API/Plugins/MassReplication

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;&41;  
class UMassReplicationSubsystem : public UWorldSubsystem

Remarks

Manages the creation of NetworkIDs, ClientBubbles and ClientReplicationInfo. 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. ClientReplicationInfo relate to all the player controllers that have a parent or child UNetConnection to a single Client machine (split screen etc).

Variables

  Type Name Description
Protected variable UProperty Transient TArray< FMassClientBubbleInfoData > BubbleInfoArray  
Protected variable FMassClientHandleManager ClientHandleManager Clients free list FMassClientHandle manager, handles will to the indices of FMassClientReplicationData::ClientBubbles
Protected variable TArray< FMassClientReplicationInfo > ClientsReplicationInfo An Array of each Clients viewer handles (split screen players sharing the same client connections).
Protected variable TArray< FViewerClientPair > ClientToViewerHandleArray A free list array of FViewerClientPairs.
Protected variable TMap< FMassNetworkID, FMassReplicationEntityInfo > EntityInfoMap  
Protected variable TSharedPtr< FMassEntityManager > EntityManager  
Protected variable uint64 LastSynchronizedFrame Used to make sure the FMassEntityHandle_ClientReplications are synchronized immediately before they are needed
Protected variable UProperty TObjectPtr< UMassLODSubsystem > MassLODSubsystem  
Protected variable UE::MassReplication::FMassAgentDelegate OnMassAgentAdded Broadcast just after a mass agent is added to the client simulation
Protected variable UE::MassReplication::FMassAgentDelegate OnRemovingMassAgent Broadcast just before a mass agent is removed from the client simulation
Protected variable FReplicationHashGrid2D ReplicationGrid  
Protected variable TArray< FViewerClientPair > ViewerToClientHandleArray A free list array of FViewerClientPairs.
Protected variable UProperty TObjectPtr< UWorld > World  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function void

AddClient ( FMassViewerHandle ViewerHandle,
APlayerController& InController
)

 Adds a Client and sets up all the data relevant to the bubble.
Protected function void  
Public function EFindOrAddMassEntityInfo

FindAndUpdateOrAddMassEntityInfo ( const FMassNetworkID NetworkID,
int32 ReplicationID,
const FMassReplicationEntityInfo*& OutMassEntityInfo
)

 Finds or adds an FMassReplicationEntityInfo to the EntityInfoMap for an Entity with NetWorkID.
Public function Const FMassEntityHandle

FindEntity ( const FMassNetworkID NetworkID
)

  
Public function Const const FMassReplicationEntityInfo *

FindMassEntityInfo ( const FMassNetworkID NetworkID
)

 Finds the FMassReplicationEntityInfo for the Entity with NetworkID.
Protected function FMassReplicationEntityInfo *  
Public function Const FMassBubbleInfoClassHandle  
Public function Const AMassClientBubbleInfoBase *

GetClientBubble ( FMassBubbleInfoClassHandle BubbleClassHandle,
FMassClientHandle ClientHandle
)

 Gets the client bubble safely
Public function Const AMassClientBubbleInfoBase * Get the client bubble. Faster version using check()s
Public function Const const TArray< FMassClientHandle > &  
Public function Const const FMassClientReplicationInfo * Gets the client replication info safely
Public function Const const FMassClientReplicationInfo & Gets the client replication info. Faster version using check()s
Public function Const const TMap< FMassNetworkID, FMassReplicationEntityInfo > &  
Public function Const const FReplicationHashGrid2D &

GetGrid ()

  
Public function FReplicationHashGrid2D &  
Public function FMassClientReplicationInfo * Gets the client replication info. Faster version using check()s
Public function FMassClientReplicationInfo & Gets the client replication info. Faster version using check()s
Public function Const FMassNetworkID Retrieve network id from Mass handle.
Public function Static FMassNetworkID  
Public function UE::MassReplication::FMassAgentDelegate &  
Public function UE::MassReplication::FMassAgentDelegate &  
Public function Const TType * Gets the client bubble safely returning the template type
Public function Const TType * Gets the client bubble returning the template type. Faster version using check()s
Public function Const bool  
Public function Const bool  
Public function FMassBubbleInfoClassHandle Registers BubbleInfoClass with the system.
Protected function void

RemoveClient ( FMassClientHandle ClientHandle
)

 Removes a Client and removes up all the data relevant to the bubble
Public function void  
Public function FMassEntityHandle

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.
Public function 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
Protected function bool

SynchronizeClients ( const TArray< FViewerInfo >& Viewers
)

  
Public function void  
Protected function void  

Overridden from USubsystem

  Type Name Description
Protected function Virtual void Implement this for deinitialization of instances of the system
Protected function Virtual void USubsystem BEGIN.

Enums

  Type Name Description
Public enum EFindOrAddMassEntityInfo    

Constants

Name Description
CurrentNetMassCounter  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page