Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > NetworkPrediction > FNetworkPredictionDriverBase

Light Theme

Dark Theme

FNetworkPredictionDriverBase

Windows

MacOS

Linux

Inheritance Hierarchy

	FNetworkPredictionDriver
	FNetworkPredictionDriver< FGenericKinematicActorDef >

References

Module	NetworkPrediction
Header	/Engine/Plugins/Runtime/NetworkPrediction/Source/NetworkPrediction/Public/NetworkPredictionDriver.h
Include	#include "NetworkPredictionDriver.h"

Syntax

template<typename ModelDef>
struct FNetworkPredictionDriverBase

Functions

	Name	Description
TEnableIf< b...	BeginInterpolatedPhysics ( DriverType* Driver )	BeginInterpolatedPhysics - turn off physics simulation so that NP can interpolate the physics state
TEnableIf<&#...	BeginInterpolatedPhysics ( DriverType* Driver )
TEnableIf< H...	CallFinalizeFrameMemberFunc ( DriverType* Driver, const SyncType* SyncState, const AuxType* AuxState )
TEnableIf<&#...	CallFinalizeFrameMemberFunc ( DriverType* Driver, const SyncType* SyncState, const AuxType* AuxState )
TEnableIf< H...	CallInitializeSimulationStateMemberFunc ( DriverType* Driver, SyncType* Sync, AuxType* Aux )
TEnableIf<&#...	CallInitializeSimulationStateMemberFunc ( DriverType* Driver, SyncType* Sync, AuxType* Aux )
TEnableIf<&#...	CallProduceInputMemberFunc ( DriverType* Driver, int32 DeltaTimeMS, InputType* InputCmd )
TEnableIf< H...	CallProduceInputMemberFunc ( DriverType* Driver, int32 DeltaTimeMS, InputType* InputCmd )
TEnableIf<&#...	CallRestoreFrameMemberFunc ( DriverType* Driver, const SyncType* SyncState, const AuxType* AuxState )
TEnableIf< H...	CallRestoreFrameMemberFunc ( DriverType* Driver, const SyncType* SyncState, const AuxType* AuxState )
void	CallServerRPC ( DriverType* Driver )	CallServerRPC
TEnableIf< H...	CallServerRPCMemberFunc ( DriverType* Driver )
TEnableIf<&#...	CallServerRPCMemberFunc ( DriverType* Driver )
TEnableIf< H...	CallSetHiddenForInterpolation ( DriverType* Driver, bool bHide )
TEnableIf<&#...	CallSetHiddenForInterpolation ( DriverType* Driver, bool bHide )
void	CallSetHiddenForInterpolationFallback ( AActor* Driver, bool bHide )
void	CallSetHiddenForInterpolationFallback ( UActorComponent* Driver, bool bHide )
void	DispatchCues ( TNetSimCueDispatcher< ModelDef >&#..., void* Driver, int32 SimFrame, int32 SimTimeMS, const int32 FixedStepMS )
void	DispatchCues ( TNetSimCueDispatcher< ModelDef >&#..., InDriverType* Driver, int32 SimFrame, int32 SimTimeMS, const int32 FixedStepMS )	Dispatch Cues
void	DrawDebugOutline ( DriverType* Driver, FColor Color, float Lifetime )
void	DrawDebugText3D ( DriverType* Driver, const TCHAR* Str, FColor Color, float Lifetime, float ZOffset )
TEnableIf< b...	EndInterpolatedPhysics ( DriverType* Driver )	EndInterpolatedPhysics - turn on physics simulation
TEnableIf<&#...	EndInterpolatedPhysics ( DriverType* Driver )
void	FinalizeFrame ( DriverType* Driver, const SyncType* SyncState, const AuxType* AuxState )	FinalizeFrame
TEnableIf< b...	FinalizeInterpolatedPhysics ( DriverType* Driver, TConditionalState< PhysicsState >&... )	FinalizeInterpolatedPhysics Only called when needing to push NP interpolated physics state to the driver.
TEnableIf<&#...	FinalizeInterpolatedPhysics ( DriverType* Driver, TConditionalState< PhysicsState >&... )
constexpr FN...	GetCapabilities()	Defines what the ModelDef can do. This is a compile time thing only.
FNetworkPred...	GetConfig ( const FNetworkPredictionInstanceArc..., const FNetworkPredictionSettings& ..., ENetRole Role, bool bHasNetConnection )	Defines the default config for an instance, given their archetype and Role/NetConnection.
FBox	GetDebugBoundingBox ( void* NoDriver )
FBox	GetDebugBoundingBox ( UActorComponent* DriverCompone... )
FBox	GetDebugBoundingBox ( AActor* DriverActor )
void	GetDebugString ( UActorComponent* ActorComp, FStringBuilderBase& Builder )
void	GetDebugString ( void* NoDriver, FStringBuilderBase& Builder )
void	GetDebugString ( AActor* Actor, FStringBuilderBase& Builder )	Basic string/debug info
void	GetDebugStringFull ( UActorComponent* ActorComp, FStringBuilderBase& Builder )
void	GetDebugStringFull ( AActor* Actor, FStringBuilderBase& Builder )
void	GetDebugStringFull ( void* NoDriver, FStringBuilderBase& Builder )
FTransform	GetDebugWorldTransform ( void* NoDriver )
FTransform	GetDebugWorldTransform ( UActorComponent* DriverCompone... )
FTransform	GetDebugWorldTransform ( AActor* DriverActor )
bool	GetDefaultArchetype ( FNetworkPredictionInstanceArchetype..., ENetworkPredictionTickingPolicy Pre..., bool bCanPhysicsTickPhysics )	Defines the default settings for a spawn instance.
TEnableIf<&#...	GetPhysicsBodyInstance ( DriverType* Driver )
TEnableIf< H...	GetPhysicsBodyInstance ( DriverType* Driver )
TEnableIf<&#...	GetPhysicsPrimitiveComponent ( DriverType* Driver )
TEnableIf< H...	GetPhysicsPrimitiveComponent ( DriverType* Driver )
void	GetTraceString ( void* NoDriver, FStringBuilderBase& Builder )
void	GetTraceString ( AActor* Actor, FStringBuilderBase& Builder )
void	GetTraceString ( UActorComponent* ActorComp, FStringBuilderBase& Builder )
constexpr bo...	HasDriver()
constexpr bo...	HasInput()
constexpr bo...	HasNpState()
constexpr bo...	HasPhysics()
constexpr bo...	HasSimulation()
void	InitializeSimulationState ( DriverType* Driver, SyncType* Sync, AuxType* Aux )
void	InitializeSimulationState ( DriverType* Driver, FNetworkPredictionStateView* V... )	InitializeSimulationState
void	Interpolate ( const TSyncAuxPair< StateTypes >& ..., const TSyncAuxPair< StateTypes >& ..., const float PCT, SyncType* SyncOut, AuxType* AuxOut )	Interpolate Blend between From/To set of Sync/Aux states
TEnableIf<&#...	InterpolatePhysics ( TConditionalState< PhysicsState >&..., TConditionalState< PhysicsState >&..., float PCT, TConditionalState< PhysicsState >&... )
TEnableIf< b...	InterpolatePhysics ( TConditionalState< PhysicsState >&..., TConditionalState< PhysicsState >&..., float PCT, TConditionalState< PhysicsState >&... )	InterpolatePhysics
void	InterpolateState ( const void* From, const void* To, const float PCT, void* Out )
void	InterpolateState ( const StateType* From, const StateType* To, const float PCT, StateType* Out )
TEnableIf< b...	LogPhysicsState ( TConditionalState< PhysicsState >&..., FOutputDevice& Ar )	LogPhysicsState
TEnableIf< b...	LogPhysicsState ( int32 PhysicsFrame, Chaos::FRewindData* RewindData, DriverType* Driver, FOutputDevice& Ar )
TEnableIf<&#...	LogPhysicsState ( int32 PhysicsFrame, Chaos::FRewindData* RewindData, DriverType* Driver, FOutputDevice& Ar )
TEnableIf<&#...	LogPhysicsState ( TConditionalState< PhysicsState >&..., FOutputDevice& Ar )
void	LogUserState ( const StateType* State, FOutputDevice& Ar )
void	LogUserStates ( const TNetworkPredictionState< Stat..., FOutputDevice& Ar )	ToString
TEnableIf< b...	MarshalPhysicsToComponent ( DriverType* Driver )	MarshalPhysicsToComponent
TEnableIf<&#...	MarshalPhysicsToComponent ( DriverType* Driver )
void	NetSerialize ( TConditionalState< void >& State, const FNetSerializeParams& P )
void	NetSerialize ( TConditionalState< StateType >& St..., const FNetSerializeParams& P )	NetSerialize Forwards NetSerialize call to the user type.
TEnableIf< b...	PerformPhysicsRollback ( DriverType* Driver, TConditionalState< PhysicsState >&... )	PerformPhysicsRollback
TEnableIf<&#...	PerformPhysicsRollback ( DriverType* Driver, TConditionalState< PhysicsState >&... )
TEnableIf< b...	PhysicsNetRecv ( const FNetSerializeParams& P, TConditionalState< PhysicsState >&... )	PhysicsNetRecv
TEnableIf<&#...	PhysicsNetRecv ( const FNetSerializeParams& P, TConditionalState< PhysicsState >&... )
TEnableIf<&#...	PhysicsNetSend ( const FNetSerializeParams& P, DriverType* Driver )
TEnableIf< b...	PhysicsNetSend ( const FNetSerializeParams& P, DriverType* Driver )	PhysicsNetSend
TEnableIf<&#...	PhysicsStateIsConsistent ( DriverType* Driver )
TEnableIf< b...	PhysicsStateIsConsistent ( DriverType* Driver )	PhysicsStateIsConsistent Only used in debugging - checks if UPrimitiveComponent and FPhysicsBody state are in sync with each other
TEnableIf<&#...	PostPhysicsResimulate ( DriverType* Driver )
TEnableIf< b...	PostPhysicsResimulate ( DriverType* Driver )	PostPhysicsResimulate
void	ProduceInput ( DriverType* Driver, int32 DeltaTimeMS, InputType* InputCmd )	ProduceInput
void	RestoreFrame ( DriverType* Driver, const SyncType* SyncState, const AuxType* AuxState )	RestoreFrame
UPrimitiveCo...	SafeCastDriverToPrimitiveComponent ( InDriverType* Driver )
UPrimitiveCo...	SafeCastDriverToPrimitiveComponent ( UPrimitiveComponent* Driver )
void	SetHiddenForInterpolation ( DriverType* Driver, bool bHide )	Show/Hide ForInterpolation
bool	ShouldReconcile ( const TSyncAuxPair< StateTypes >& ..., const TSyncAuxPair< StateTypes >& ... )	ShouldReconcile
bool	ShouldReconcile ( const StateType* Predicted, const StateType* Authority )
bool	ShouldReconcile ( const void* Predicted, const void* Authority )
TEnableIf< b...	ShouldReconcilePhysics ( int32 PhysicsFrame, Chaos::FRewindData* RewindData, DriverType* Driver, TConditionalState< PhysicsState >&... )	ShouldReconcilePhysics
TEnableIf<&#...	ShouldReconcilePhysics ( int32 PhysicsFrame, Chaos::FRewindData* RewindData, DriverType* Driver, TConditionalState< PhysicsState >&... )
void	ToString ( const StateType* State, FAnsiStringBuilderBase& Builder )
void	ToString ( const void* State, FAnsiStringBuilderBase& Builder )
TEnableIf< b...	TracePhysicsState ( DriverType* Driver, FAnsiStringBuilderBase& Builder )	Current latest physics state.
TEnableIf<&#...	TracePhysicsState ( DriverType* Driver, FAnsiStringBuilderBase& Builder )
TEnableIf< b...	TracePhysicsState ( int32 PhysicsFrame, Chaos::FRewindData* RewindData, DriverType* Driver, FAnsiStringBuilderBase& Builder )	Local historic physics state.
TEnableIf<&#...	TracePhysicsState ( int32 PhysicsFrame, Chaos::FRewindData* RewindData, DriverType* Driver, FAnsiStringBuilderBase& Builder )
TEnableIf< b...	TracePhysicsStateRecv ( const TConditionalState< PhysicsSta..., FAnsiStringBuilderBase& Builder )	Received physics state.
TEnableIf<&#...	TracePhysicsStateRecv ( const TConditionalState< PhysicsSta..., FAnsiStringBuilderBase& Builder )
void	TraceUserStateString ( const StateType* State, FAnsiStringBuilderBase& Builder )

Classes

	Name	Description
	CCallServerRPCMemberFuncable
	CFinalizeFrameMemberFuncable
	CGetPhysicsBodyInstanceMemberFuncable	GetPhysicsBodyInstance
	CGetPhysicsPrimitiveComponentMemberFuncable	Physicseffectively be off.
	CInitializeSimulationStateFuncable
	CProduceInputMemberFuncable
	CRestoreFrameMemberFuncable
	CSetHiddenForInterpolationFuncable

Typedefs

Name	Description
AuxType
DriverType
InputType
PhysicsState
Simulation
StateTypes
SyncType

Constants

Name	Description
HasCallServerRPC
HasFinalizeFrame
HasGetBodyInstance
HasGetPrimitiveComp
HasInitializeSimulationState
HasProduceInput
HasRestoreFrame
HasSetHiddenForInterpolation

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss