1. Epic GamesDeveloper
  3. UObjectReplicationBridge

UObjectReplicationBridge

Partial implementation of ReplicationBridge that can be used as a foundation for implementing support for replicating objects derived from [UObject](API\Runtime\CoreUObject\UObject\UObject)

API > API/Runtime > API/Runtime/IrisCore > API/Runtime/IrisCore/Iris > API/Runtime/IrisCore/Iris/ReplicationSystem

Inheritance Hierarchy

References

   
Module IrisCore
Header /Engine/Source/Runtime/Experimental/Iris/Core/Public/Iris/ReplicationSystem/ObjectReplicationBridge.h
Include #include "Iris/ReplicationSystem/ObjectReplicationBridge.h"

Syntax

UCLASS (Transient, MinimalAPI)  
class UObjectReplicationBridge : public UReplicationBridge

Remarks

Partial implementation of ReplicationBridge that can be used as a foundation for implementing support for replicating objects derived from UObject

Variables

  Type Name Description
Protected variable bool bSuppressCreateInstanceFailedEnsure  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Protected function Virtual    

Functions

  Type Name Description
Public function void Adds a dependent object.
Public function void

AddStaticDestructionInfo ( const FString& ObjectPath,
const UObject* Outer,
const FEndReplicationParameters& Parameters
)

 Add static destruction info, this is used when stably named objects are destroyed prior to starting replication
Protected function Const uint8

ConvertPollFrequencyIntoFrames ( float PollFrequency
)

 Transform a poll frequency (in updates per second) to an equivalent number of frames.
Public function FString

DescribeObjectReference ( const UE::Net::FNetObjectReference& ObjectRef,
const UE::Net::FNetObjectResolveContext& ResolveContext
)

 Describe the NetObjectReference
Protected function Virtual void Destroy or tear-off the game instance on request from remote.
Protected function Virtual Const TArray< uint32 > Parses a list of arguments and returns a list of Connection's that match them Ex: ConnectionId=1 or ConnectionId=1,5,7
Protected function bool

FindOrCachePollFrequency ( const UClass* Class,
float& OutPollPeriod
)

 Finds the final poll frequency for a class and cache it for future lookups.
Protected function Const bool

GetClassPollFrequency ( const UClass* Class,
float& OutPollPeriod
)

 Find the poll period of a class if it was configured with an override.
Protected function UE::Net::FNetObjectFilterHandle

GetDynamicFilter ( const UClass* Class,
bool bRequireForceEnabled,
FName& OutFilterProfile
)

 Retrieves the dynamic filter to set for the given class.
Protected function Const FInstanceGetWorldObjectInfoFunction Get the function that we should call to get the world location of an object.
Protected function Const FInstancePreUpdateFunction Get the function that we should call before copying state data.
Protected function Const float Current max tick rate set by the engine
Protected function Const UObject * Lookup the UObject associated with the provided Handle.
Public function Const bool Returns whether the object wants to be dormant.
Public function Const UE::Net::FNetObjectReference

GetOrCreateObjectReference ( const UObject* Instance
)

 Get or create NetObjectReference for object instance.
Public function Const UE::Net::FNetObjectReference

GetOrCreateObjectReference ( const FString& Path,
const UObject* Outer
)

 Get or create NetObjectReference for object identified by path relative to outer.
Protected function Virtual Const float

GetPollFrequencyOfRootObject ( const UObject* ReplicatedObject
)

 Returns the poll frequency of a specific root object.
Public function Const UObject * Get the Object from a replicated handle, if the handle is invalid or not is a replicated handle the function will return nullptr
Public function Const FNetRefHandle Get NetRefHandle from a NetHandle.
Public function Const FNetRefHandle

GetReplicatedRefHandle ( const UObject* Object,
EGetRefHandleFlags GetRefHandleFlags
)

 Get NetRefHandle from a replicated UObject.
Public function Const FNetRefHandle Get the handle of the root object of any replicated subobject.
Protected function bool

IsClassCritical ( const UClass* Class
)

 Returns true if the class is considered critical and we force a disconnection if a protocol mismatch prevents instances of this class from replicating.
Protected function void Re-initialize config-driven parameters found in ObjectReplicationBridgeConfig.
Public function void Trigger a single poll to refresh the dirty values of a dormant object.
Public function Virtual Const bool Returns true of the level that the Object belongs to has finished loading.
Protected function Virtual void Called when we found a divergence between the local and remote protocols when trying to instantiate a remote replicated object.
Protected function Virtual void Invoked for new replicated SubObjects after state has been applied to owner
Public function Const void  
Protected function Virtual Const FString

PrintConnectionInfo ( uint32 ConnectionId
)

 Returns the most relevant description of the client tied to this connection id.
Public function Const void Debug functions that are triggered via console commands.
Public function Const void

PrintNetCullDistances ( const TArray< FString >& Args
)

  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void  
Protected function void Re-initialize the poll frequency of all replicated root objects.
Public function Virtual Const bool

RemapPathForPIE ( uint32 ConnectionId,
FString& Path,
bool bReading
)

 PIE package name remapping support.
Public function void

RemoveDependentObject ( FNetRefHandle Parent,
FNetRefHandle DependentObject
)

 Remove dependent object from parent.
Public function UObject *

ResolveObjectReference ( const UE::Net::FNetObjectReference& ObjectRef,
const UE::Net::FNetObjectResolveContext& ResolveContext
)

 Try to resolve UObject from NetObjectReference, this function tries to resolve the object by loading if necessary.
Public function void

SetClassDynamicFilterConfig ( FName ClassPathName,
FName FilterName,
FName FilterProfile
)

  
Public function void

SetClassDynamicFilterConfig ( FName ClassPathName,
const UE::Net::FNetObjectFilterHandle FilterHandle,
FName FilterProfile
)

 Set the object filter to use for objects of this class and any derived classes without an explicit config.
Public function void

SetClassTypeStatsConfig ( FName ClassPathName,
FName TypeStatsName
)

 Set the TypeStats to use for specified class and any derived classes without explicit config
Public function void

SetClassTypeStatsConfig ( const FString& ClassPathName,
const FString& TypeStatsName
)

  
Protected function void Set the function that we should call to get the world location of an object.
Protected function void Set the function that we should call before copying state data.
Protected function void

SetMaxTickRate ( float InMaxTickRate
)

 Change the max tick rate to match the one from the engine
Public function void

SetObjectWantsToBeDormant ( FNetRefHandle Handle,
bool bWantsToBeDormant
)

 Set whether object should go dormant.
Public function void

SetPollFrequency ( FNetRefHandle RootHandle,
float PollFrequency
)

 Set poll frequency on root object and its subobjects. They will be polled on the same frame.
Protected function void

SetPollWithObject ( FNetRefHandle ObjectToPollWith,
FNetRefHandle Object
)

 Force polling of Object when ObjectToPollWith is polled.
Protected function void Set the function used to determine whether two classes are to be considered equal when it comes to filtering.
Protected function void Set the function used to determine whether an object should use the default spatial filter unless the class is configured to use some other filter.
Public function void Set NetCondition for a subobject, the condition is used to determine if the SubObject should replicate or not.
Public function Const bool Getter for CVar net.Iris.UseVerboseIrisCsvStats which is true if we want per-class iris stats output to CSV
Public function FNetRefHandle Start replicating a RootObject and return a valid NetRefHandle if successful.
Public function FNetRefHandle Start replicating a SubObject and return a valid NetRefHandle if successful.
Public function void

StopReplicatingNetObject ( UObject* Instance,
EEndReplicationFlags EndReplicationFlags
)

 Stop replicating any type of NetObject.

Overridden from UReplicationBridge

  Type Name Description
Protected function Virtual bool Cache info required to allow deferred writing of NetRefHandleCreationInfo
Protected function Virtual FReplicationBridgeCreateNetRefHandleResult Read data required to instantiate NetObject from bitstream.
Protected function Virtual void Deinitializes the bridge. Is called during ReplicationSystem deinitialization.
Protected function Virtual void Called when we detach instance protocol from the local instance
Protected function Virtual void Called when the instance is detached from the protocol on request by the remote.
Protected function Virtual void

Initialize ( UReplicationSystem* InReplicationSystem
)

 Initializes the bridge. Is called during ReplicationSystem initialization.
Protected function Virtual void

OnErrorWithNetRefHandleReported ( UE::Net::ENetRefHandleError ErrorType,
FNetRefHandle RefHandle,
uint32 ConnectionId
)

 Called when a remote connection has a critical error caused by a specific NetRefHandle
Protected function Virtual void Invoked after we sent data to all connections.
Protected function Virtual void

OnProtocolMismatchReported ( FNetRefHandle RefHandle,
uint32 ConnectionId
)

 Called when a remote connection detected a protocol mismatch when trying to instantiate the NetRefHandle replicated object.
Protected function Virtual void Invoked when the ReplicationSystem starts the PreSendUpdate tick.
Protected function Virtual void

PostApplyInitialState ( UE::Net::Private::FInternalNetRefIndex InternalObjectIndex
)

 Invoked after we have applied the initial state for an object.
Protected function Virtual void Invoked before ReplicationSystem copies dirty state data.
Protected function Virtual void Invoked before ReplicationSystem copies dirty state data for a single replicated object.
Protected function Virtual void Invoked post garbage collect to allow us to detect stale objects
Protected function Virtual void Invoked right before we apply the state for a new received subobject but after we have applied state for owning/root object in order to behave like old replication system
Protected function Virtual void Update world locations in FWorldLocations for objects that support it.
Protected function Virtual bool Write data required to instantiate NetObject remotely to bitstream.

Classes

  Type Name Description
Protected struct FDestroyInstanceParams    
Public struct FRootObjectReplicationParams    
Public struct FSubObjectReplicationParams    

Typedefs

Name Description
EGetRefHandleFlags  
FInstanceGetWorldObjectInfoFunction Helper method to get the world location & cull distance for replicated instances with the HasWorldLocation trait.
FInstancePreUpdateFunction Helper method that calls provided PreUpdateFunction and polls state data for all replicated instances with the NeedsPoll trait.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page