UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Net::FReplicationStateDescriptorBuilder Class Reference

#include <ReplicationStateDescriptorBuilder.h>

Classes

struct  FParameters
 

Public Types

typedef TArray< TRefCountPtr< const FReplicationStateDescriptor > > FResult
 

Static Public Member Functions

static IRISCORE_API SIZE_T CreateDescriptorsForClass (FResult &OutCreatedDescriptors, UClass *InClass, const FParameters &Parameters=FParameters())
 
static IRISCORE_API TRefCountPtr< const FReplicationStateDescriptorCreateDescriptorForStruct (const UStruct *InStruct, const FParameters &Parameters=FParameters())
 
static IRISCORE_API TRefCountPtr< const FReplicationStateDescriptorCreateDescriptorForFunction (const UFunction *Function, const FParameters &Parameters=FParameters())
 

Member Typedef Documentation

◆ FResult

Member Function Documentation

◆ CreateDescriptorForFunction()

TRefCountPtr< const FReplicationStateDescriptor > UE::Net::FReplicationStateDescriptorBuilder::CreateDescriptorForFunction ( const UFunction Function,
const FParameters Parameters = FParameters() 
)
static

Create ReplicationStateDescriptor for a function

If a descriptor registry is provided, the function below will search the registry before creating a new ReplicationStateDescriptor. Any new created ReplicationStateDescriptor will be registered in the provided registry.

◆ CreateDescriptorForStruct()

TRefCountPtr< const FReplicationStateDescriptor > UE::Net::FReplicationStateDescriptorBuilder::CreateDescriptorForStruct ( const UStruct InStruct,
const FParameters Parameters = FParameters() 
)
static

Create ReplicationStateDescriptor for a struct

If a descriptor registry is provided, the functions below will search the registry before creating a new ReplicationStateDescriptor. Any new created ReplicationStateDescriptor will be registered in the provided registry.

FReplicationStateDescriptorBuilder Implementation

◆ CreateDescriptorsForClass()

SIZE_T UE::Net::FReplicationStateDescriptorBuilder::CreateDescriptorsForClass ( FResult OutCreatedDescriptors,
UClass InClass,
const FParameters Parameters = FParameters() 
)
static

Create the descriptors from an optional template or the class CDO.

Done by processing reflection information at runtime for existing replicated properties.

Since we want to allow ReplicationStates to be shared as much as possible between different connection we do split them up based on feature requirements, filtering, conditionals etc. We also keep Init states separate.

If a descriptor registry is provided, the functions below will search the registry before creating a new ReplicationStateDescriptor. Any created ReplicationStateDescriptor will be registered in the provided registry.

Returns number of states created for the provided class.


The documentation for this class was generated from the following files: