1. Epic GamesDeveloper
  3. FNetworkPredictionDriverBase

FNetworkPredictionDriverBase

API > API/Plugins > API/Plugins/NetworkPrediction

Inheritance Hierarchy

References

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

Syntax

template<typename ModelDef>  
struct FNetworkPredictionDriverBase

Functions

  Type Name Description
Public function Static TEnableIf::Type  
Public function Static TEnableIf< bEnable >::Type BeginInterpolatedPhysics - turn off physics simulation so that NP can interpolate the physics state
Public function Static TEnableIf< HasFunc >::Type

CallFinalizeFrameMemberFunc ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

  
Public function Static TEnableIf::Type

CallFinalizeFrameMemberFunc ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

  
Public function Static TEnableIf< HasFunc >::Type

CallFinalizeSmoothingFrameMemberFunc ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

  
Public function Static TEnableIf::Type

CallFinalizeSmoothingFrameMemberFunc ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

  
Public function Static TEnableIf::Type  
Public function Static TEnableIf< HasFunc >::Type  
Public function Static TEnableIf< HasFunc >::Type

CallProduceInputMemberFunc ( DriverType* Driver,
int32 DeltaTimeMS,
InputType* InputCmd
)

  
Public function Static TEnableIf::Type

CallProduceInputMemberFunc ( DriverType* Driver,
int32 DeltaTimeMS,
InputType* InputCmd
)

  
Public function Static TEnableIf::Type

CallRestoreFrameMemberFunc ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

  
Public function Static TEnableIf< HasFunc >::Type

CallRestoreFrameMemberFunc ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

  
Public function Static void CallServerRPC
Public function Static TEnableIf::Type  
Public function Static TEnableIf< HasFunc >::Type  
Public function Static TEnableIf< HasFunc >::Type

CallSetHiddenForInterpolation ( DriverType* Driver,
bool bHide
)

  
Public function Static TEnableIf::Type

CallSetHiddenForInterpolation ( DriverType* Driver,
bool bHide
)

  
Public function Static void

CallSetHiddenForInterpolationFallback ( AActor* Driver,
bool bHide
)

  
Public function Static void

CallSetHiddenForInterpolationFallback ( UActorComponent* Driver,
bool bHide
)

  
Public function Static void

DispatchCues ( TNetSimCueDispatcher< ModelDef >* CueDispatcher,
void* Driver,
int32 SimFrame,
int32 SimTimeMS,
const int32 FixedStepMS
)

  
Public function Static void

DispatchCues ( TNetSimCueDispatcher< ModelDef >* CueDispatcher,
InDriverType* Driver,
int32 SimFrame,
int32 SimTimeMS,
const int32 FixedStepMS
)

 Dispatch CuesForwards call to CueDispatche's DispatchCueRecord which will invoke the queued HandleCue events to the driver.
Public function Static void

DrawDebugOutline ( DriverType* Driver,
FColor Color,
float Lifetime
)

  
Public function Static void

DrawDebugText3D ( DriverType* Driver,
const TCHAR* Str,
FColor Color,
float Lifetime,
float ZOffset
)

  
Public function Static TEnableIf< bEnable >::Type EndInterpolatedPhysics - turn on physics simulation
Public function Static TEnableIf::Type  
Public function Static void

FinalizeFrame ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

 FinalizeFrameCalled every engine frame to push the final result of the NetworkPrediction system to the driver
Public function Static TEnableIf::Type  
Public function Static TEnableIf< bEnable >::Type FinalizeInterpolatedPhysics Only called when needing to push NP interpolated physics state to the driver.
Public function Static void

FinalizeSmoothingFrame ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

 FinalizeSmoothingFrameWhen a smoothing service is active, this is called every engine frame to push the final smoothed state to the driver.
Public function Static FNetworkPredictionModelDefCapabilities Defines what the ModelDef can do. This is a compile time thing only.
Public function Static FNetworkPredictionInstanceConfig

GetConfig ( const FNetworkPredictionInstanceArchetype& Archetype,
const FNetworkPredictionSettings& GlobalSettings,
ENetRole Role,
bool bHasNetConnection
)

 Defines the default config for an instance, given their archetype and Role/NetConnection.
Public function Static FBox

GetDebugBoundingBox ( void* NoDriver
)

  
Public function Static FBox

GetDebugBoundingBox ( AActor* DriverActor
)

  
Public function Static FBox

GetDebugBoundingBox ( UActorComponent* DriverComponent
)

  
Public function Static void

GetDebugString ( AActor* Actor,
FStringBuilderBase& Builder
)

 Basic string/debug info
Public function Static void

GetDebugString ( UActorComponent* ActorComp,
FStringBuilderBase& Builder
)

  
Public function Static void

GetDebugString ( void* NoDriver,
FStringBuilderBase& Builder
)

  
Public function Static void

GetDebugStringFull ( void* NoDriver,
FStringBuilderBase& Builder
)

  
Public function Static void

GetDebugStringFull ( UActorComponent* ActorComp,
FStringBuilderBase& Builder
)

  
Public function Static void

GetDebugStringFull ( AActor* Actor,
FStringBuilderBase& Builder
)

  
Public function Static FTransform

GetDebugWorldTransform ( AActor* DriverActor
)

  
Public function Static FTransform

GetDebugWorldTransform ( UActorComponent* DriverComponent
)

  
Public function Static FTransform

GetDebugWorldTransform ( void* NoDriver
)

  
Public function Static bool

GetDefaultArchetype ( FNetworkPredictionInstanceArchetype& Archetype,
ENetworkPredictionTickingPolicy PreferredTickingPolicy,
bool bCanPhysicsTickPhysics
)

 Defines the default settings for a spawn instance.
Public function Static TEnableIf::Type  
Public function Static TEnableIf< HasFunc, FBodyInstance * >::Type  
Public function Static TEnableIf::Type  
Public function Static TEnableIf< HasFunc, UPrimitiveComponent * >::Type  
Public function Static void

GetTraceString ( void* NoDriver,
FStringBuilderBase& Builder
)

  
Public function Static void

GetTraceString ( AActor* Actor,
FStringBuilderBase& Builder
)

  
Public function Static void

GetTraceString ( UActorComponent* ActorComp,
FStringBuilderBase& Builder
)

  
Public function Static bool  
Public function Static bool  
Public function Static bool  
Public function Static bool  
Public function Static bool  
Public function Static void InitializeSimulationState
Public function Static void  
Public function Static void

Interpolate ( const TSyncAuxPair< StateTypes >& From,
const TSyncAuxPair< StateTypes >& To,
const float PCT,
SyncType* SyncOut,
AuxType* AuxOut
)

 InterpolateBlend between From/To set of Sync/Aux states
Public function Static TEnableIf::Type  
Public function Static TEnableIf< bEnable >::Type InterpolatePhysics
Public function Static void

InterpolateState ( const StateType* From,
const StateType* To,
const float PCT,
StateType* Out
)

  
Public function Static void

InterpolateState ( const void* From,
const void* To,
const float PCT,
void* Out
)

  
Public function Static TEnableIf< bEnable >::Type

LogPhysicsState ( TConditionalState< PhysicsState >& RecvState,
FOutputDevice& Ar
)

 LogPhysicsState
Public function Static TEnableIf< bEnable >::Type

LogPhysicsState ( int32 PhysicsFrame,
Chaos::FRewindData* RewindData,
DriverType* Driver,
FOutputDevice& Ar
)

  
Public function Static TEnableIf::Type

LogPhysicsState ( int32 PhysicsFrame,
Chaos::FRewindData* RewindData,
DriverType* Driver,
FOutputDevice& Ar
)

  
Public function Static TEnableIf::Type

LogPhysicsState ( TConditionalState< PhysicsState >& RecvState,
FOutputDevice& Ar
)

  
Public function Static void

LogUserState ( const StateType* State,
FOutputDevice& Ar
)

  
Public function Static void

LogUserStates ( const TNetworkPredictionState< StateTypes >& UserStates,
FOutputDevice& Ar
)

 ToString
Public function Static TEnableIf< bEnable >::Type MarshalPhysicsToComponent
Public function Static TEnableIf::Type  
Public function Static void

NetSerialize ( TConditionalState< void >& State,
const FNetSerializeParams& P
)

  
Public function Static void

NetSerialize ( TConditionalState< StateType >& State,
const FNetSerializeParams& P
)

 NetSerializeForwards NetSerialize call to the user type.
Public function Static TEnableIf< bEnable >::Type PerformPhysicsRollback
Public function Static TEnableIf::Type  
Public function Static TEnableIf< bEnable >::Type PhysicsNetRecv
Public function Static TEnableIf::Type  
Public function Static TEnableIf::Type  
Public function Static TEnableIf< bEnable >::Type PhysicsNetSend
Public function Static TEnableIf::Type  
Public function Static TEnableIf< bEnable, bool >::Type PhysicsStateIsConsistent Only used in debugging - checks if UPrimitiveComponent and FPhysicsBody state are in sync with each other
Public function Static TEnableIf::Type  
Public function Static TEnableIf< bEnable >::Type PostPhysicsResimulate
Public function Static void

ProduceInput ( DriverType* Driver,
int32 DeltaTimeMS,
InputType* InputCmd
)

 ProduceInput
Public function Static void

RestoreFrame ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

 RestoreFrame
Public function Static UPrimitiveComponent *

SafeCastDriverToPrimitiveComponent ( InDriverType* Driver
)

  
Public function Static UPrimitiveComponent *

SafeCastDriverToPrimitiveComponent ( UPrimitiveComponent* Driver
)

  
Public function Static void

SetHiddenForInterpolation ( DriverType* Driver,
bool bHide
)

 Show/Hide ForInterpolationInterpolated sims are initially hidden until there are two valid states to interpolate between
Public function Static bool

ShouldReconcile ( const TSyncAuxPair< StateTypes >& Predicted,
const TSyncAuxPair< StateTypes >& Authority
)

 ShouldReconcile
Public function Static bool

ShouldReconcile ( const StateType* Predicted,
const StateType* Authority
)

  
Public function Static bool

ShouldReconcile ( const void* Predicted,
const void* Authority
)

  
Public function Static TEnableIf< bEnable, bool >::Type

ShouldReconcilePhysics ( int32 PhysicsFrame,
Chaos::FRewindData* RewindData,
DriverType* Driver,
TConditionalState< PhysicsState >& RecvState
)

 ShouldReconcilePhysics
Public function Static TEnableIf::Type

ShouldReconcilePhysics ( int32 PhysicsFrame,
Chaos::FRewindData* RewindData,
DriverType* Driver,
TConditionalState< PhysicsState >& RecvState
)

  
Public function Static void

ToString ( const StateType* State,
FAnsiStringBuilderBase& Builder
)

  
Public function Static void

ToString ( const void* State,
FAnsiStringBuilderBase& Builder
)

  
Public function Static TEnableIf< bEnable >::Type

TracePhysicsState ( DriverType* Driver,
FAnsiStringBuilderBase& Builder
)

 Current latest physics state.
Public function Static TEnableIf::Type

TracePhysicsState ( DriverType* Driver,
FAnsiStringBuilderBase& Builder
)

  
Public function Static TEnableIf< bEnable >::Type

TracePhysicsState ( int32 PhysicsFrame,
Chaos::FRewindData* RewindData,
DriverType* Driver,
FAnsiStringBuilderBase& Builder
)

 Local historic physics state.
Public function Static TEnableIf::Type

TracePhysicsState ( int32 PhysicsFrame,
Chaos::FRewindData* RewindData,
DriverType* Driver,
FAnsiStringBuilderBase& Builder
)

  
Public function Static TEnableIf< bEnable >::Type

TracePhysicsStateRecv ( const TConditionalState< PhysicsState >& RecvState,
FAnsiStringBuilderBase& Builder
)

 Received physics state.
Public function Static TEnableIf::Type

TracePhysicsStateRecv ( const TConditionalState< PhysicsState >& RecvState,
FAnsiStringBuilderBase& Builder
)

  
Public function Static void

TraceUserStateString ( const StateType* State,
FAnsiStringBuilderBase& Builder
)

  

Classes

  Type Name Description
Public struct CCallServerRPCMemberFuncable    
Public struct CFinalizeFrameMemberFuncable    
Public struct CFinalizeSmoothingFrameMemberFuncable    
Public struct CGetPhysicsBodyInstanceMemberFuncable GetPhysicsBodyInstance  
Public struct CGetPhysicsPrimitiveComponentMemberFuncable Physics  
Public struct CInitializeSimulationStateFuncable    
Public struct CProduceInputMemberFuncable    
Public struct CRestoreFrameMemberFuncable    
Public struct CSetHiddenForInterpolationFuncable    

Typedefs

Name Description
AuxType  
DriverType  
InputType  
PhysicsState  
Simulation  
StateTypes  
SyncType  

Constants

Name Description
HasCallServerRPC  
HasFinalizeFrame  
HasFinalizeSmoothingFrame  
HasGetBodyInstance  
HasGetPrimitiveComp  
HasInitializeSimulationState  
HasProduceInput  
HasRestoreFrame  
HasSetHiddenForInterpolation  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page