1. Epic GamesDeveloper
  3. UReplicationSystem

UReplicationSystem

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/ReplicationSystem.h
Include #include "Iris/ReplicationSystem/ReplicationSystem.h"

Syntax

class UReplicationSystem : public UObject

Constructors

No constructors are accessible with public or protected access.

Destructors

No destructors are accessible with public or protected access.

Functions

  Type Name Description
Public function void

AddConnection ( uint32 ConnectionId
)

 Notify that a connection was added.
Public function void

AddGroupFilter ( FNetObjectGroupHandle GroupHandle
)

 Add a group to the filtering system.
Public function void

AddToGroup ( FNetObjectGroupHandle GroupHandle,
FNetRefHandle Handle
)

 Add an object to a group.
Public function void Clears any previously set squared cull distance for an object.
Public function FNetObjectGroupHandle Create a group which can be used to logically group objects together.
Public function void

DestroyGroup ( FNetObjectGroupHandle GroupHandle
)

 Destroy a group.
Public function void Force the passed object to be considered for replication this frame.
Public function Const UObject *

GetConnectionUserData ( uint32 ConnectionId
)

 Retrieve the user data associated with a connection.
Public function Const float

GetCullDistanceSqrOverride ( FNetRefHandle Handle,
float DefaultValue
)

 Returns the previously set squared cull distance for an object, or DefaultValue if it wasn't or the Handle isn't valid.
Public function Const double Returns elapsed time in seconds since ReplicatonSystem was created
Public function Const UNetObjectFilter *

GetFilter ( const FName FilterName
)

 Gets the filter with a given name.
Public function Const UE::Net::FNetObjectFilterHandle

GetFilterHandle ( const FName FilterName
)

 Gets the handle for a filter with a given name.
Public function Const FName

GetFilterName ( UE::Net::FNetObjectFilterHandle Filter
)

 Returns the name of the filter associated to this handle.
Public function Const uint32

GetId ()

  
Public function Const uint32  
Public function Const const UE::Net::FNetCullDistanceOverrides & Retrieve the NetCullDistanceOverrides instance which holds cull distances for objects that have explicitly overriden it.
Public function FNetObjectGroupHandle SubObject filtering.
Public function Const uint32 Get the owning net connection for an object.
Public function Const int32  
Public function Const UNetObjectPrioritizer *

GetPrioritizer ( const FName PrioritizerName
)

 Gets the prioritizer with a given name.
Public function Const UE::Net::FNetObjectPrioritizerHandle

GetPrioritizerHandle ( const FName PrioritizerName
)

 Gets the handle for a prioritizer with a given name.
Public function Const UReplicationBridge *  
Public function Const T *  
Public function Const const UE::Net::FReplicationProtocol * Get the ReplicationProtocol for a handle.
Public function Const const UE::Net::Private::FReplicationSystemInternal *  
Public function UE::Net::Private::FReplicationSystemInternal *  
Public function UE::Net::FStringTokenStore *  
Public function Const const UE::Net::FStringTokenStore *  
Public function Const FNetObjectGroupHandle Returns the FNetObjectGroupHandle used by a named SubObjectFilter
Public function Const const UE::Net::FWorldLocations & Retrieve the WorldLocations instance which holds world locations for all objects that support it.
Public function void

InitDataStreams ( uint32 ConnectionId,
UDataStreamManager* DataStreamManager
)

 Init data streams for a connection. For internal use by UDataStreamChannel.
Public function Const bool

IsInGroup ( FNetObjectGroupHandle GroupHandle,
FNetRefHandle Handle
)

 Check whether an objects belongs to a particular group or not.
Public function Const bool

IsReplicationEnabledForConnection ( uint32 ConnectionId
)

 Check whether object replication is enabled for a particular connection.
Public function Const bool  
Public function Const bool

IsValidConnection ( uint32 ConnectionId
)

 Verify if a connection is valid, that is has been added to the system.
Public function Const bool

IsValidGroup ( FNetObjectGroupHandle GroupHandle
)

 Check if a group handle is valid.
Public function Const bool Check whether a FNetRefHandle is still associated with a replicated object.
Public function void Explicitly mark object as having dirty properties.
Public function void Cleanup temporaries and prepare for the next send update.
Public function void

PreSendUpdate ( float DeltaSeconds
)

 PreSendUpdate performs all the necessary work, such as filtering and prioritization of objects, so that each connection will be properly updated with all the information needed in order to replicate.
Public function bool

QueueNetObjectAttachment ( uint32 ConnectionId,
const UE::Net::FNetObjectReference& TargetRef,
const TRefCountPtr< UE::Net::FNetObjectAttachment >& Attachment
)

 Queue an attachment for replication with an object.
Public function bool Registers a NetBlobHandler so that its NetBlob type can be sent and received.
Public function void

RemoveConnection ( uint32 ConnectionId
)

 Notify that a connection was removed.
Public function void Removes an object from all groups it's part of.
Public function void

RemoveFromGroup ( FNetObjectGroupHandle GroupHandle,
FNetRefHandle Handle
)

 Removes an object from a group.
Public function void

RemoveGroupFilter ( FNetObjectGroupHandle GroupHandle
)

 Remove group from filtering system, will cancel effects of the group.
Public function void Remove group from filtering system, will cancel effects of the group.
Public function bool

SendRPC ( uint32 ConnectionId,
const UObject* Object,
const UObject* SubObject,
const UFunction* Function,
const void* Parameters
)

 Unicast an RPC targeting a object/subobject.
Public function bool

SendRPC ( const UObject* Object,
const UObject* SubObject,
const UFunction* Function,
const void* Parameters
)

 Multicast an RPC targeting a object/subobject.
Public function void SendUpdate is currently more of a placeholder for a future where the ReplicationSystem itself is responsible for the low level protocol and sending, rather than having the DataStreamChannel.
Public function bool

SetConnectionFilter ( FNetRefHandle Handle,
const TBitArray<>& Connections,
UE::Net::ENetFilterStatus ReplicationStatus
)

 Set which connections the object is allowed to be replicated to.
Public function void

SetConnectionUserData ( uint32 ConnectionId,
UObject* UserData
)

 Associate data with a connection.
Public function void

SetCullDistanceSqrOverride ( FNetRefHandle Handle,
float DistSqr
)

 Set the squared cull distance for an object.
Public function void Set whether the object allows delta compression when serializing.
Public function bool

SetFilter ( FNetRefHandle Handle,
UE::Net::FNetObjectFilterHandle FilterHandle
)

 Sets a filter for a replicated object which will be used until the next call to SetFilter or SetConnectionFilter.
Public function void

SetGroupFilterStatus ( FNetObjectGroupHandle GroupHandle,
UE::Net::ENetFilterStatus ReplicationStatus
)

 Set status of GroupFilter for all connnections.
Public function void

SetGroupFilterStatus ( FNetObjectGroupHandle GroupHandle,
uint32 ConnectionId,
UE::Net::ENetFilterStatus ReplicationStatus
)

 Set status of GroupFilter for specific connection.
Public function void

SetGroupFilterStatus ( FNetObjectGroupHandle GroupHandle,
const UE::Net::FNetBitArray& Connections,
UE::Net::ENetFilterStatus ReplicationStatus
)

 Set status of GroupFilter for connection marked in the Connections BitArray.
Public function void Mark an object as a net temporary.
Public function void

SetOwningNetConnection ( FNetRefHandle Handle,
uint32 ConnectionId
)

 Sets the owning connection of an object.
Public function bool Sets a prioritizer for a replicated object which will be used until the next call to SetPrioritizer or SetStaticPriority.
Public function bool Enable or disable a replication condition for all connections.
Public function bool

SetReplicationConditionConnectionFilter ( FNetRefHandle Handle,
UE::Net::EReplicationCondition Condition,
uint32 ConnectionId,
bool bEnable
)

 Enable or disable a replication condition for a single connection and do the inverse for all other connections.
Public function void

SetReplicationEnabledForConnection ( uint32 ConnectionId,
bool bReplicationEnabled
)

 Enable or disable the ReplicationDataStream to transmit data for a particular connection.
Public function void

SetReplicationView ( uint32 ConnectionId,
const UE::Net::FReplicationView& View
)

 Set view information for a connection.
Public function void

SetStaticPriority ( FNetRefHandle Handle,
float Priority
)

 Sets a fixed priority for a replicated object which will be used until the next call to SetStaticPriority or SetPrioritizer.
Public function void

SetSubObjectFilterStatus ( FName GroupName,
uint32 ConnectionId,
UE::Net::ENetFilterStatus ReplicationStatus
)

 Set status of GroupFilter for specific connection.
Public function void Mark an object to be torn off next update.

Classes

  Type Name Description
Public struct FReplicationSystemParams    

Typedefs

Name Description
FNetHandle  
FNetObjectGroupHandle  
FNetRefHandle  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page