UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FPhysicsPredictionSettings Struct Reference

#include <PhysicsSettings.h>

Public Member Functions

 GENERATED_BODY ()
 
 UPROPERTY (EditAnywhere, Category="Replication", meta=(DisplayName="Default Resimulation Replication Settings (EPhysicsReplicationMode::Resimulation)")) FPhysicsReplicationResimulationSettings ResimulationSettings
 
 FPhysicsPredictionSettings ()
 

Public Attributes

bool bEnablePhysicsResimulation_DEPRECATED
 
float ResimulationErrorThreshold_DEPRECATED
 
bool bEnablePhysicsPrediction
 
bool bEnablePhysicsHistoryCapture
 
float MaxSupportedLatencyPrediction
 
FPhysicsReplicationLODSettings PhysicsReplicationLODSettings
 

Detailed Description

Physics Prediction Settings

Constructor & Destructor Documentation

◆ FPhysicsPredictionSettings()

FPhysicsPredictionSettings::FPhysicsPredictionSettings ( )
inline

Member Function Documentation

◆ GENERATED_BODY()

FPhysicsPredictionSettings::GENERATED_BODY ( )

◆ UPROPERTY()

FPhysicsPredictionSettings::UPROPERTY ( EditAnywhere  ,
Category  = "Replication",
meta  = (DisplayName="Default Resimulation Replication Settings (EPhysicsReplicationMode::Resimulation)") 
)

Default settings for physics replication using EPhysicsReplicationMode::Resimulation.

Member Data Documentation

◆ bEnablePhysicsHistoryCapture

bool FPhysicsPredictionSettings::bEnablePhysicsHistoryCapture

Enables FRewindData to cache physics history Note: This is not recommended for networked physics unless developing a custom resimulation solution since this starts caching physics on both client and server, instead only enable bEnablePhysicsPrediction which will automatically enable FRewindData caching on the client if needed by the chosen replication mode.

◆ bEnablePhysicsPrediction

bool FPhysicsPredictionSettings::bEnablePhysicsPrediction

Enable networked physics prediction (experimental) This syncs the physics tick number between client and server and keeps it in sync via time dilation performed on the client, see APlayerController::GetPhysicsTimestamp(). If an AActor::PhysicsReplicationMode is set to use Resimulation this will also enable RewindData to cache physics history on the client which is required by resimulation replication. IMPORTANT: Physics Prediction needs Physics -> Framerate -> Tick Physics Async enabled to function as intended.

◆ bEnablePhysicsResimulation_DEPRECATED

bool FPhysicsPredictionSettings::bEnablePhysicsResimulation_DEPRECATED

bEnablePhysicsResimulation has been renamed, please use bEnablePhysicsHistoryCapture

◆ MaxSupportedLatencyPrediction

float FPhysicsPredictionSettings::MaxSupportedLatencyPrediction

Amount of RTT (Round Trip Time) latency for the prediction to support in milliseconds.

◆ PhysicsReplicationLODSettings

FPhysicsReplicationLODSettings FPhysicsPredictionSettings::PhysicsReplicationLODSettings

Default settings for physics replication LOD.

◆ ResimulationErrorThreshold_DEPRECATED

float FPhysicsPredictionSettings::ResimulationErrorThreshold_DEPRECATED

ResimulationErrorThreshold has been renamed and moved, please use FPhysicsReplicationResimulationSettings.ResimulationErrorPositionThreshold


The documentation for this struct was generated from the following file: