1. Epic GamesDeveloper
  3. FNetworkPredictionDriverBase

FNetworkPredictionDriverBase

API > API/Plugins > API/Plugins/NetworkPrediction

   
Name FNetworkPredictionDriverBase
Type struct
Header File /Engine/Plugins/Runtime/NetworkPrediction/Source/NetworkPrediction/Public/NetworkPredictionDriver.h
Include Path #include "NetworkPredictionDriver.h"

Syntax

template<typename ModelDef>  
struct FNetworkPredictionDriverBase

Derived Classes

Structs

Name Remarks
CCallServerRPCMemberFuncable  
CFinalizeFrameMemberFuncable  
CFinalizeSmoothingFrameMemberFuncable  
CGetPhysicsBodyInstanceMemberFuncable GetPhysicsBodyInstance
CGetPhysicsPrimitiveComponentMemberFuncable Physics
CInitializeSimulationStateFuncable  
CProduceInputMemberFuncable  
CRestoreFrameMemberFuncable  
CSetHiddenForInterpolationFuncable  

Typedefs

Name Type Remarks Include Path
AuxType typename StateTypes::AuxType   NetworkPredictionDriver.h
DriverType typename ModelDef::Driver   NetworkPredictionDriver.h
InputType typename StateTypes::InputType   NetworkPredictionDriver.h
PhysicsState typename ModelDef::PhysicsState   NetworkPredictionDriver.h
Simulation typename ModelDef::Simulation   NetworkPredictionDriver.h
StateTypes typename ModelDef::StateTypes   NetworkPredictionDriver.h
SyncType typename StateTypes::SyncType   NetworkPredictionDriver.h

Constants

Name Type Remarks Include Path
HasCallServerRPC bool   NetworkPredictionDriver.h
HasFinalizeFrame bool   NetworkPredictionDriver.h
HasFinalizeSmoothingFrame bool   NetworkPredictionDriver.h
HasGetBodyInstance bool   NetworkPredictionDriver.h
HasGetPrimitiveComp bool   NetworkPredictionDriver.h
HasInitializeSimulationState bool   NetworkPredictionDriver.h
HasProduceInput bool   NetworkPredictionDriver.h
HasRestoreFrame bool   NetworkPredictionDriver.h
HasSetHiddenForInterpolation bool   NetworkPredictionDriver.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static TEnableIf::Type BeginInterpolatedPhysics ( DriverType* Driver
)

   NetworkPredictionDriver.h  

static TEnableIf< bEnable >::Type BeginInterpolatedPhysics ( DriverType* Driver
)

 BeginInterpolatedPhysics - turn off physics simulation so that NP can interpolate the physics state NetworkPredictionDriver.h  

static TEnableIf< HasFunc >::Type CallFinalizeFrameMemberFunc ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

   NetworkPredictionDriver.h  

static TEnableIf::Type CallFinalizeFrameMemberFunc ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

   NetworkPredictionDriver.h  

static TEnableIf< HasFunc >::Type CallFinalizeSmoothingFrameMemberFunc ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

   NetworkPredictionDriver.h  

static TEnableIf::Type CallFinalizeSmoothingFrameMemberFunc ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

   NetworkPredictionDriver.h  

static TEnableIf::Type CallInitializeSimulationStateMemberFunc ( DriverType* Driver,
SyncType* Sync,
AuxType* Aux
)

   NetworkPredictionDriver.h  

static TEnableIf< HasFunc >::Type CallInitializeSimulationStateMemberFunc ( DriverType* Driver,
SyncType* Sync,
AuxType* Aux
)

   NetworkPredictionDriver.h  

static TEnableIf< HasFunc >::Type CallProduceInputMemberFunc ( DriverType* Driver,
int32 DeltaTimeMS,
InputType* InputCmd
)

   NetworkPredictionDriver.h  

static TEnableIf::Type CallProduceInputMemberFunc ( DriverType* Driver,
int32 DeltaTimeMS,
InputType* InputCmd
)

   NetworkPredictionDriver.h  

static TEnableIf::Type CallRestoreFrameMemberFunc ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

   NetworkPredictionDriver.h  

static TEnableIf< HasFunc >::Type CallRestoreFrameMemberFunc ( DriverType* Driver,
const SyncType* SyncState,
const AuxType* AuxState
)

   NetworkPredictionDriver.h  

static void CallServerRPC ( DriverType* Driver
)

 CallServerRPC NetworkPredictionDriver.h  

static TEnableIf::Type CallServerRPCMemberFunc ( DriverType* Driver
)

   NetworkPredictionDriver.h  

static TEnableIf< HasFunc >::Type CallServerRPCMemberFunc ( DriverType* Driver
)

   NetworkPredictionDriver.h  

static TEnableIf< HasFunc >::Type CallSetHiddenForInterpolation ( DriverType* Driver,
bool bHide
)

   NetworkPredictionDriver.h  

static TEnableIf::Type CallSetHiddenForInterpolation ( DriverType* Driver,
bool bHide
)

   NetworkPredictionDriver.h  

static void CallSetHiddenForInterpolationFallback ( AActor* Driver,
bool bHide
)

   NetworkPredictionDriver.h  

static void CallSetHiddenForInterpolationFallback ( UActorComponent* Driver,
bool bHide
)

   NetworkPredictionDriver.h  

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

   NetworkPredictionDriver.h  

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. NetworkPredictionDriver.h  

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

   NetworkPredictionDriver.h  

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

   NetworkPredictionDriver.h  

static TEnableIf< bEnable >::Type EndInterpolatedPhysics ( DriverType* Driver
)

 EndInterpolatedPhysics - turn on physics simulation NetworkPredictionDriver.h  

static TEnableIf::Type EndInterpolatedPhysics ( DriverType* Driver
)

   NetworkPredictionDriver.h  

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 NetworkPredictionDriver.h  

static TEnableIf::Type FinalizeInterpolatedPhysics ( DriverType* Driver,
TConditionalState< PhysicsState >& Physics
)

   NetworkPredictionDriver.h  

static TEnableIf< bEnable >::Type FinalizeInterpolatedPhysics ( DriverType* Driver,
TConditionalState< PhysicsState >& Physics
)

 FinalizeInterpolatedPhysics Only called when needing to push NP interpolated physics state to the driver. NetworkPredictionDriver.h  

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. NetworkPredictionDriver.h  

static FNetworkPredictionModelDefCapabilities GetCapabilities()

 Defines what the ModelDef can do. This is a compile time thing only. NetworkPredictionDriver.h  

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. NetworkPredictionDriver.h  

static FBox GetDebugBoundingBox ( void* NoDriver
)

   NetworkPredictionDriver.h  

static FBox GetDebugBoundingBox ( AActor* DriverActor
)

   NetworkPredictionDriver.h  

static FBox GetDebugBoundingBox ( UActorComponent* DriverComponent
)

   NetworkPredictionDriver.h  

static void GetDebugString ( AActor* Actor,
FStringBuilderBase& Builder
)

 Basic string/debug info NetworkPredictionDriver.h  

static void GetDebugString ( UActorComponent* ActorComp,
FStringBuilderBase& Builder
)

   NetworkPredictionDriver.h  

static void GetDebugString ( void* NoDriver,
FStringBuilderBase& Builder
)

   NetworkPredictionDriver.h  

static void GetDebugStringFull ( void* NoDriver,
FStringBuilderBase& Builder
)

   NetworkPredictionDriver.h  

static void GetDebugStringFull ( UActorComponent* ActorComp,
FStringBuilderBase& Builder
)

   NetworkPredictionDriver.h  

static void GetDebugStringFull ( AActor* Actor,
FStringBuilderBase& Builder
)

   NetworkPredictionDriver.h  

static FTransform GetDebugWorldTransform ( AActor* DriverActor
)

   NetworkPredictionDriver.h  

static FTransform GetDebugWorldTransform ( UActorComponent* DriverComponent
)

   NetworkPredictionDriver.h  

static FTransform GetDebugWorldTransform ( void* NoDriver
)

   NetworkPredictionDriver.h  

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

 Defines the default settings for a spawn instance. NetworkPredictionDriver.h  

static TEnableIfFBodyInstance * >::Type GetPhysicsBodyInstance ( DriverType* Driver
)

   NetworkPredictionDriver.h  

static TEnableIf< HasFunc, FBodyInstance * >::Type GetPhysicsBodyInstance ( DriverType* Driver
)

   NetworkPredictionDriver.h  

static TEnableIfUPrimitiveComponent * >::Type GetPhysicsPrimitiveComponent ( DriverType* Driver
)

   NetworkPredictionDriver.h  

static TEnableIf< HasFunc, UPrimitiveComponent * >::Type GetPhysicsPrimitiveComponent ( DriverType* Driver
)

   NetworkPredictionDriver.h  

static void GetTraceString ( void* NoDriver,
FStringBuilderBase& Builder
)

   NetworkPredictionDriver.h  

static void GetTraceString ( AActor* Actor,
FStringBuilderBase& Builder
)

   NetworkPredictionDriver.h  

static void GetTraceString ( UActorComponent* ActorComp,
FStringBuilderBase& Builder
)

   NetworkPredictionDriver.h  

static bool HasDriver()

   NetworkPredictionDriver.h  

static bool HasInput()

   NetworkPredictionDriver.h  

static bool HasNpState()

   NetworkPredictionDriver.h  

static bool HasPhysics()

   NetworkPredictionDriver.h  

static bool HasSimulation()

   NetworkPredictionDriver.h  

static void InitializeSimulationState ( DriverType* Driver,
FNetworkPredictionStateView* View
)

 InitializeSimulationState NetworkPredictionDriver.h  

static void InitializeSimulationState ( DriverType* Driver,
SyncType* Sync,
AuxType* Aux
)

   NetworkPredictionDriver.h  

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 NetworkPredictionDriver.h  

static TEnableIf::Type InterpolatePhysics ( TConditionalState< PhysicsState >& FromState,
TConditionalState< PhysicsState >& ToState,
float PCT,
TConditionalState< PhysicsState >& OutState
)

   NetworkPredictionDriver.h  

static TEnableIf< bEnable >::Type InterpolatePhysics ( TConditionalState< PhysicsState >& FromState,
TConditionalState< PhysicsState >& ToState,
float PCT,
TConditionalState< PhysicsState >& OutState
)

 InterpolatePhysics NetworkPredictionDriver.h  

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

   NetworkPredictionDriver.h  

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

   NetworkPredictionDriver.h  

static TEnableIf< bEnable >::Type LogPhysicsState ( TConditionalState< PhysicsState >& RecvState,
FOutputDevice& Ar
)

 LogPhysicsState NetworkPredictionDriver.h  

static TEnableIf< bEnable >::Type LogPhysicsState ( int32 PhysicsFrame,
Chaos::FRewindData* RewindData,
DriverType* Driver,
FOutputDevice& Ar
)

   NetworkPredictionDriver.h  

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

   NetworkPredictionDriver.h  

static TEnableIf::Type LogPhysicsState ( TConditionalState< PhysicsState >& RecvState,
FOutputDevice& Ar
)

   NetworkPredictionDriver.h  

static void LogUserState ( const StateType* State,
FOutputDevice& Ar
)

   NetworkPredictionDriver.h  

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

 ToString NetworkPredictionDriver.h  

static TEnableIf< bEnable >::Type MarshalPhysicsToComponent ( DriverType* Driver
)

 MarshalPhysicsToComponent NetworkPredictionDriver.h  

static TEnableIf::Type MarshalPhysicsToComponent ( DriverType* Driver
)

   NetworkPredictionDriver.h  

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

   NetworkPredictionDriver.h  

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

 NetSerializeForwards NetSerialize call to the user type. NetworkPredictionDriver.h  

static TEnableIf< bEnable >::Type PerformPhysicsRollback ( DriverType* Driver,
TConditionalState< PhysicsState >& RecvState
)

 PerformPhysicsRollback NetworkPredictionDriver.h  

static TEnableIf::Type PerformPhysicsRollback ( DriverType* Driver,
TConditionalState< PhysicsState >& RecvState
)

   NetworkPredictionDriver.h  

static TEnableIf< bEnable >::Type PhysicsNetRecv ( const FNetSerializeParams& P,
TConditionalState< PhysicsState >& RecvState
)

 PhysicsNetRecv NetworkPredictionDriver.h  

static TEnableIf::Type PhysicsNetRecv ( const FNetSerializeParams& P,
TConditionalState< PhysicsState >& RecvState
)

   NetworkPredictionDriver.h  

static TEnableIf::Type PhysicsNetSend ( const FNetSerializeParams& P,
DriverType* Driver
)

   NetworkPredictionDriver.h  

static TEnableIf< bEnable >::Type PhysicsNetSend ( const FNetSerializeParams& P,
DriverType* Driver
)

 PhysicsNetSend NetworkPredictionDriver.h  

static TEnableIf::Type PhysicsStateIsConsistent ( DriverType* Driver
)

   NetworkPredictionDriver.h  

static TEnableIf< bEnable, bool >::Type PhysicsStateIsConsistent ( DriverType* Driver
)

 PhysicsStateIsConsistent Only used in debugging - checks if UPrimitiveComponent and FPhysicsBody state are in sync with each other NetworkPredictionDriver.h  

static TEnableIf::Type PostPhysicsResimulate ( DriverType* Driver
)

   NetworkPredictionDriver.h  

static TEnableIf< bEnable >::Type PostPhysicsResimulate ( DriverType* Driver
)

 PostPhysicsResimulate NetworkPredictionDriver.h  

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

 ProduceInput NetworkPredictionDriver.h  

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

 RestoreFrame NetworkPredictionDriver.h  

static UPrimitiveComponent * SafeCastDriverToPrimitiveComponent ( InDriverType* Driver
)

   NetworkPredictionDriver.h  
  NetworkPredictionDriver.h  

static void SetHiddenForInterpolation ( DriverType* Driver,
bool bHide
)

 Show/Hide ForInterpolationInterpolated sims are initially hidden until there are two valid states to interpolate between NetworkPredictionDriver.h  

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

 ShouldReconcile NetworkPredictionDriver.h  

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

   NetworkPredictionDriver.h  

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

   NetworkPredictionDriver.h  

static TEnableIf< bEnable, bool >::Type ShouldReconcilePhysics ( int32 PhysicsFrame,
Chaos::FRewindData* RewindData,
DriverType* Driver,
TConditionalState< PhysicsState >& RecvState
)

 ShouldReconcilePhysics NetworkPredictionDriver.h  

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

   NetworkPredictionDriver.h  

static void ToString ( const StateType* State,
FAnsiStringBuilderBase& Builder
)

   NetworkPredictionDriver.h  

static void ToString ( const void* State,
FAnsiStringBuilderBase& Builder
)

   NetworkPredictionDriver.h  

static TEnableIf< bEnable >::Type TracePhysicsState ( DriverType* Driver,
FAnsiStringBuilderBase& Builder
)

 Current latest physics state. NetworkPredictionDriver.h  

static TEnableIf::Type TracePhysicsState ( DriverType* Driver,
FAnsiStringBuilderBase& Builder
)

   NetworkPredictionDriver.h  

static TEnableIf< bEnable >::Type TracePhysicsState ( int32 PhysicsFrame,
Chaos::FRewindData* RewindData,
DriverType* Driver,
FAnsiStringBuilderBase& Builder
)

 Local historic physics state. NetworkPredictionDriver.h  

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

   NetworkPredictionDriver.h  

static TEnableIf< bEnable >::Type TracePhysicsStateRecv ( const TConditionalState< PhysicsState >& RecvState,
FAnsiStringBuilderBase& Builder
)

 Received physics state. NetworkPredictionDriver.h  

static TEnableIf::Type TracePhysicsStateRecv ( const TConditionalState< PhysicsState >& RecvState,
FAnsiStringBuilderBase& Builder
)

   NetworkPredictionDriver.h  

static void TraceUserStateString ( const StateType* State,
FAnsiStringBuilderBase& Builder
)

   NetworkPredictionDriver.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page