Can't find any content

Error loading documents tree: Nothing found

  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

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

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 Virtual FObjectReplicationBridgeInstantiateResult

BeginInstantiateFromRemote ( FNetRefHandle SubObjectOwnerHandle,
const UE::Net::FNetObjectResolveContext& ResolveContext,
const FCreationHeader* Header
)

 Called when we instantiate/find object instance requested by remote.
Public function FNetRefHandle

BeginReplication ( FNetRefHandle OwnerHandle,
UObject* Instance,
FNetRefHandle InsertRelativeToSubObjectHandle,
ESubObjectInsertionOrder InsertionOrder,
const FCreateNetRefHandleParams& Params
)

 Begin replicating the Instance as a subobject of the OwnerHandle.
Public function FNetRefHandle

BeginReplication ( FNetRefHandle OwnerHandle,
UObject* Instance,
const FCreateNetRefHandleParams& Params
)

 Create handle and start replicating the Instance as a SubObject of the OwnerHandle.
Public function FNetRefHandle

BeginReplication ( UObject* Instance,
const FCreateNetRefHandleParams& Params
)

 Begin replicating the Instance and return a valid NetRefHandle for the Instance if successful.
Protected function Const uint8

ConvertPollFrequencyIntoFrames ( float PollFrequency
)

 Transform a poll frequency (in updates per second) to an equivalent number of frames.
Protected function Virtual void

DestroyInstanceFromRemote ( UObject* Instance,
EReplicationBridgeDestroyInstanceReason DestroyReason,
EReplicationBridgeDestroyInstanceFlags DestroyFlags
)

 Destroy or tear-off the game instance on request from remote.
Protected function Virtual void Invoked after remote NetHandle has been created and initial state is applied.
Public function void

EndReplication ( UObject* Instance,
EEndReplicationFlags EndReplicationFlags,
FEndReplicationParameters* Parameters
)

 Stop replicating the object.
Protected function bool

FindOrCachePollFrequency ( const UClass* Class,
float& OutPollPeriod
)

 Finds the final poll frequency for a class and cache it for future lookups.
Public function void Trigger replication of dirty state for object wanting to be dormant.
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 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 FString& Path,
const UObject* Outer
)

 Get or create NetObjectReference for object identified by path relative to outer.
Public function Const UE::Net::FNetObjectReference

GetOrCreateObjectReference ( const UObject* Instance
)

 Get or create NetObjectReference for object instance.
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
)

 Get NetRefHandle from a replicated UObject.
Protected function void Re-initialize config-driven parameters found in ObjectReplicationBridgeConfig.
Public function Virtual Const bool Returns true of the level that the Object belongs to has finished loading.
Protected function Virtual Const bool

OnInstantiatedFromRemote ( UObject* Instance,
const FCreationHeader* InHeader,
uint32 ConnectionId
)

 Invoked before we start applying state data to instance on remote end.
Protected function Virtual FCreationHeader * Create Header and read data required to instantiate the Handle.
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.
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.
Protected function void

SetPollWithObject ( FNetRefHandle ObjectToPollWith,
FNetRefHandle Object
)

 Force polling of Object when ObjectToPollWith is polled.
Protected function void

SetShouldSubclassUseSameFilterFunction ( TFunction< bool(const UClass*Class, const UClass*Subclass)>
)

 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

SetSubObjectNetCondition ( FNetRefHandle SubObjectHandle,
ELifetimeCondition Condition
)

 Set NetCondition for a subobject, the condition is used to determine if the SubObject should replicate or not.
Protected function Virtual bool $IRIS TODO: Consider moving these methods to separate interface to allow for a single ObjectReplicationBridge to support different type specific methods to its own interface and allow for a single bridge to support multiple subtypes? We will see what we need when we start to Serialize data we might not even want to expose virtual methods for doing this, and instead provide support for specifying a "creation state" that works exactly as any other state but only ever is replicated when we first instantiate an object of the specific type Write data required to instantiate the Handle.

Overridden from UReplicationBridge

  Type Name Description
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

DetachInstanceFromRemote ( FNetRefHandle Handle,
EReplicationBridgeDestroyInstanceReason DestroyReason,
EReplicationBridgeDestroyInstanceFlags DestroyFlags
)

 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 Invoke 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 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
Public struct FCreateNetRefHandleParams    
Public struct FCreationHeader    

Typedefs

Name Description
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.

Constants

Name Description
DefaultCreateNetRefHandleParams  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page