ObjectReplicationBridgeConfig.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/ContainersFwd.h"
#include "UObject/ObjectMacros.h"
 
#include "Iris/ReplicationSystem/ObjectReferenceTypes.h"
 
#include "ObjectReplicationBridgeConfig.generated.h"
 
USTRUCT()
struct FObjectReplicationBridgePollConfig
{
    GENERATED_BODY()
 
    
    UPROPERTY()
    FName ClassName;
 
    UPROPERTY()
    float PollFrequency = 0.0f;
    
 
    UPROPERTY()
    bool bIncludeSubclasses = true;
};
 
USTRUCT()
struct FObjectReplicationBridgeFilterConfig
{
    GENERATED_BODY()
 
    
    UPROPERTY()
    FName ClassName;
 
    UPROPERTY()
    FName DynamicFilterName;
 
    UPROPERTY()
    FName FilterProfile;
 
    UPROPERTY()
    bool bForceEnableOnAllInstances = false;
};
 
USTRUCT()
struct FObjectReplicationBridgePrioritizerConfig
{
    GENERATED_BODY()
 
    
    UPROPERTY()
    FName ClassName;
 
    UPROPERTY()
    FName PrioritizerName;
 
    UPROPERTY()
    bool bForceEnableOnAllInstances = false;
};
 
USTRUCT()
struct FObjectReplicationBridgeDeltaCompressionConfig
{
    GENERATED_BODY()
 
    
    UPROPERTY()
    FName ClassName;
 
    UPROPERTY()
    bool bEnableDeltaCompression = true;
};
 
USTRUCT()
struct FObjectReplicatedBridgeCriticalClassConfig
{
    GENERATED_BODY()
 
    
    UPROPERTY()
    FName ClassName;
 
    UPROPERTY()
    bool bDisconnectOnProtocolMismatch = true;
};
 
USTRUCT()
struct FObjectReplicationBridgeAsyncLoadingClassConfig
{
    GENERATED_BODY()
 
    
    UPROPERTY()
    FName ClassName;
 
    UPROPERTY()
    EIrisAsyncLoadingPriority IrisAsyncLoadingPriority = EIrisAsyncLoadingPriority::Default;
};
 
USTRUCT()
struct FObjectReplicationBridgeTypeStatsConfig
{
    GENERATED_BODY()
 
    
    UPROPERTY()
    FName ClassName;
 
    UPROPERTY()
    FName TypeStatsName;
 
    UPROPERTY()
    bool bIncludeInMinimalCSVStats = false;
};
 
UCLASS(transient, config=Engine)
class UObjectReplicationBridgeConfig : public UObject
{
    GENERATED_BODY()
 
public:
 
    IRISCORE_API static const UObjectReplicationBridgeConfig* GetConfig();
 
    IRISCORE_API TConstArrayView<FObjectReplicationBridgePollConfig> GetPollConfigs() const;
    IRISCORE_API TConstArrayView<FObjectReplicationBridgeFilterConfig> GetFilterConfigs() const;
    IRISCORE_API TConstArrayView<FObjectReplicationBridgePrioritizerConfig> GetPrioritizerConfigs() const;
    IRISCORE_API TConstArrayView<FObjectReplicationBridgeDeltaCompressionConfig> GetDeltaCompressionConfigs() const;
    IRISCORE_API TConstArrayView<FObjectReplicatedBridgeCriticalClassConfig> GetCriticalClassConfigs() const;
    IRISCORE_API TConstArrayView<FObjectReplicationBridgeTypeStatsConfig> GetTypeStatsConfigs() const;
    IRISCORE_API TConstArrayView<FObjectReplicationBridgeAsyncLoadingClassConfig> GetAsyncLoadingClassConfigs() const;
 
    FName GetDefaultSpatialFilterName() const;
    FName GetRequiredNetDriverChannelClassName() const;
 
    bool AreAllClassesCritical() const { return bAllClassesCritical; }
 
protected:
    UObjectReplicationBridgeConfig();
 
private:
    UPROPERTY(Config)
    TArray<FObjectReplicationBridgePollConfig> PollConfigs;
 
    UPROPERTY(Config)
    TArray<FObjectReplicationBridgeFilterConfig> FilterConfigs;
 
    UPROPERTY(Config)
    TArray<FObjectReplicationBridgePrioritizerConfig> PrioritizerConfigs;
 
    UPROPERTY(Config)
    TArray<FObjectReplicationBridgeDeltaCompressionConfig> DeltaCompressionConfigs;
 
    UPROPERTY(Config)
    TArray<FObjectReplicatedBridgeCriticalClassConfig> CriticalClassConfigs;
 
    UPROPERTY(Config)
    bool bAllClassesCritical = false;
 
    UPROPERTY(Config)
    TArray<FObjectReplicationBridgeTypeStatsConfig> TypeStatsConfigs;
 
    UPROPERTY(Config)
    FName DefaultSpatialFilterName;
 
    UPROPERTY(Config)
    TArray<FObjectReplicationBridgeAsyncLoadingClassConfig> AsyncLoadingClassConfigs;
 
    UPROPERTY(Config)
    FName RequiredNetDriverChannelClassName;
 
    UPROPERTY(Config)
    TArray<FName> CriticalActorClasses;
};
 
inline FName UObjectReplicationBridgeConfig::GetDefaultSpatialFilterName() const
{
    return DefaultSpatialFilterName;
}
 
inline FName UObjectReplicationBridgeConfig::GetRequiredNetDriverChannelClassName() const
{
    return RequiredNetDriverChannelClassName;
}