NetworkPrediction

Windows
MacOS
Linux

Filters

Classes

Name

Description

Public struct

FConditionalAutoConsoleRegister

This is required because these cvars live in header files that will be included across different compilation units Just using standard FAutoConsoleVariableRef will cause multiple registrations of the same variable

Public struct

FLogCategoryLogNetInterpolation

Public struct

FLogCategoryLogNetworkSimDebug

Public struct

FNetSerializeParams

The parameters for NetSerialize that are passed around the system. Everything should use this, expecting to have to add more.

Public struct

FNetSimProcessedFrameDebugInfo

Public struct

FNetSimTickParameters

Ticking parameters use to drive the simulation

Public struct

FNetworkSimTime

The main Simulation time type. All sims use this to talk about time.

Public struct

FNetworkSimulationModelDebuggerManager

Public struct

FNetworkSimulationModelInitParameters

Public struct

FNetworkSimulationSerialization

Public struct UStruct

FReplicationProxy

FReplicationProxyReplicated USTRUCT that point to the IReplicationProxy to do the replication.

Public struct

FScopedBandwidthLimitBypass

Helper struct to bypass the bandwidth limit imposed by the engine's NetDriver (QueuedBits, NetSpeed, etc).

Public struct UStruct

FServerReplicationRPCParameter

FServerRPCProxyParameter Used for the client->Server RPC.

Public struct

FStandardLoggingParameters

Public struct

FVisualLoggingParameters

Public class

INetworkPredictionModule

Public class

INetworkSimulationModel

Public struct

INetworkSimulationModelDebugger

Debugger support classes

Public class

IReplicationProxy

Interface that the proxy talks to. This is what will implement the replication.

Public struct

TBufferGetterHelper

Helper struct for enum-based access. This has to be done in an outside struct because we cant specialize inside TNetworkSimBufferContainer on all compilers.

Public struct

TFrameCmd

Wraps an input command (BaseType) in a NetworkSimulation time.

Public struct

TInternalBufferTypes

Helper to turn user supplied buffer types into the "real" buffer types: the InputCmd struct is wrapped in TFrameCmd.

Public struct

TInterpolator

Public class

TNetworkedSimulationModel

TNetworkedSimulationModel

Public struct

TNetworkSimBufferContainer

Public struct

TNetworkSimBufferTypes

A collection of the system's buffer types. This allows us to collapse the 4 types into a single type to use a template argument elsewhere.

Public class

TNetworkSimDriverInterfaceBase

Interface base for the simulation driver.

Public struct

TNetworkSimTickSettings

Holds per-simulation settings about how ticking is supposed to happen.

Public struct

TNetworkSimulationModelDebugger

Public struct

TRealTimeAccumulator

Accumulator: Helper for accumulating real time into sim time based on TickSettings

Public struct

TReplicationBuffer

TReplicationBuffer

Public struct

TReplicator_Autonomous

Replicates TSyncState and does basic reconciliation.

Public struct

TReplicator_Debug

Special replicator for debug buffer, this preserves the local buffer and receives into a replicator-owned buffer (we want these buffers to be distinct/not merged)

Public struct

TReplicator_Sequence

Replicates a sequence of elements.

Public struct

TReplicator_Server

Default Replicator for the Server: Replicates the InputBuffer client->server.

Public struct

TReplicator_SimTime

Just serializes simulation time. Can be disabled by Enabled templated parameter. Used as base class in other classes below.

Public struct

TReplicator_Simulated

Simulated: "non locally controlled" simulations.

Public struct

TReplicator_Single

Replicates only the latest single element in the selected buffer.

Public struct

TReplicatorBase

This is the "templated base class" for replicators but is not required (i.e., this not an official interface used by TNetworkedSimulation model. Just a base implementation you can start with)

Public struct

TReplicatorEmpty

Templated Replicators

Public struct

TSelectTypeHelper

Helper needed to specialize TNetworkSimBufferTypes::Get (must be done outside of templated struct)

Public struct

TSimulationTickState

Holds active state for simulation ticking: what inputs we have processed, how time we have simulated, how much we are allowed to, etc.

Public class UClass Abstract

UNetworkPredictionComponent

UNetworkPredictionComponent This is the base component for running a TNetworkedSimulationModel through an actor component.

Public class UClass

UNetworkSimulationGlobalManager

Constants

Enums

Name

Description

Public enum

ENetworkSimBufferTypeId

Enum to refer to buffer type. These are used as template arguments to write generic code that can act on any of the buffers.

Public enum UEnum

EReplicationProxyTarget

Public enum UEnum

ESimulatedUpdateMode

Public enum

EStandardLoggingContext

Public enum UEnum

EVisualLoggingContext

Public enum

EVisualLoggingDrawType

Public enum

EVisualLoggingLifetime

Functions

Name Description

Public function

UObject *

 

FindReplicatedObjectOnPIEServer

(
    UObject* ClientObject
)

Public function

FString

 

LexToString

(
    EVisualLoggingContext A
)

Public function

FString

 

LexToString

Public function

FString

 

LexToString

(
    ESimulatedUpdateMode A
)

Public function

FString

 

LexToString

Public function

float

 

NetworkInterpolationDebugCVars::CatchUpFactor()

Public function Static

FConditionalAutoConsoleRegister

 

NetworkInterpolationDebugCVars::CatchUpFactorAuto

(
    TEXT("ni.CatchUpFactor"),
    (float) 1. 25,
    TEXT("Factor we [use](API\Runtime\Engine\use) to catch up")
)

Public function

float

 

NetworkInterpolationDebugCVars::CatchUpGoal()

Public function Static

FConditionalAutoConsoleRegister

 

NetworkInterpolationDebugCVars::CatchUpGoalAuto

(
    TEXT("ni.CatchUpGoal"),
    (float) 0. 100,
    TEXT("When we stop cathcing up (seconds from head)")
)

Public function

float

 

NetworkInterpolationDebugCVars::CatchUpThreshold()

Public function Static

FConditionalAutoConsoleRegister

 

NetworkInterpolationDebugCVars::CatchUpThresholdAuto

(
    TEXT("ni.CatchUpThreshold"),
    (float) 0. 200,
    TEXT("When we start catching up (seconds from head)")
)

Public function

int32

 

NetworkInterpolationDebugCVars::Disable()

Public function Static

FConditionalAutoConsoleRegister

 

NetworkInterpolationDebugCVars::DisableAuto

(
    TEXT("ni.Disable"),
    (int32) 0,
    TEXT("Disables Network Interpolation")
)

Public function

void

 

NetworkInterpolationDebugCVars::SetCatchUpFactor

(
    float V
)

Public function

void

 

NetworkInterpolationDebugCVars::SetCatchUpGoal

(
    float V
)

Public function

void

 

NetworkInterpolationDebugCVars::SetCatchUpThreshold

(
    float V
)

Public function

void

 

NetworkInterpolationDebugCVars::SetDisable

(
    int32 V
)

Public function

void

 

NetworkInterpolationDebugCVars::SetVLog

(
    int32 V
)

Public function

void

 

NetworkInterpolationDebugCVars::SetWaitSlack

(
    float V
)

Public function

int32

 

NetworkInterpolationDebugCVars::VLog()

Public function Static

FConditionalAutoConsoleRegister

 

NetworkInterpolationDebugCVars::VLogAuto

(
    TEXT("ni.VLog"),
    (int32) 0,
    TEXT("Enables Network Interpolation VLog ")
)

Public function

float

 

NetworkInterpolationDebugCVars::WaitSlack()

Public function Static

FConditionalAutoConsoleRegister

 

NetworkInterpolationDebugCVars::WaitSlackAuto

(
    TEXT("ni.WaitSlack"),
    (float) 0. 05,
    TEXT("How much slack to wait for when waiting")
)

Public function

int32

 

NetworkSimulationModelCVars::EnableLocalPrediction()

Public function Static

FConditionalAutoConsoleRegister

 

NetworkSimulationModelCVars::EnableLocalPredictionAuto

(
    TEXT("ns.EnableLocalPrediction"),
    (int32) 1,
    TEXT("Toggle local prediction.")
)

Public function

int32

 

NetworkSimulationModelCVars::EnableSimulatedExtrapolation()

Public function Static

FConditionalAutoConsoleRegister

 

NetworkSimulationModelCVars::EnableSimulatedExtrapolationAuto

(
    TEXT("ns.EnableSimulatedExtrapolation"),
    (int32) 1,
    TEXT("Toggle simulated proxy extrapolation.")
)

Public function

int32

 

NetworkSimulationModelCVars::EnableSimulatedReconcile()

Public function Static

FConditionalAutoConsoleRegister

 

NetworkSimulationModelCVars::EnableSimulatedReconcileAuto

(
    TEXT("ns.EnableSimulatedReconcile"),
    (int32) 1,
    TEXT("Toggle simulated proxy reconciliation.")
)

Public function

int32

 

NetworkSimulationModelCVars::ForceReconcile()

Public function Static

FConditionalAutoConsoleRegister

 

NetworkSimulationModelCVars::ForceReconcileAuto

(
    TEXT("ns.ForceReconcile"),
    (int32) 0,
    TEXT("Forces reconcile even if state does not differ. E.g, force resimulation after every netupdate.")
)

Public function

int32

 

NetworkSimulationModelCVars::ForceReconcileSingle()

Public function Static

FConditionalAutoConsoleRegister

 

NetworkSimulationModelCVars::ForceReconcileSingleAuto

(
    TEXT("ns.ForceReconcileSingle"),
    (int32) 0,
    TEXT("Forces a since reconcile to happen on the next frame")
)

Public function

void

 

NetworkSimulationModelCVars::SetEnableLocalPrediction

(
    int32 V
)

Public function

void

 

NetworkSimulationModelCVars::SetEnableSimulatedExtrapolation

(
    int32 V
)

Public function

void

 

NetworkSimulationModelCVars::SetEnableSimulatedReconcile

(
    int32 V
)

Public function

void

 

NetworkSimulationModelCVars::SetForceReconcile

(
    int32 V
)

Public function

void

 

NetworkSimulationModelCVars::SetForceReconcileSingle

(
    int32 V
)

Public function

int32

 

NetworkSimulationModelDebugCVars::DrawKeyframes()

Public function Static

FConditionalAutoConsoleRegister

 

NetworkSimulationModelDebugCVars::DrawKeyframesAuto

(
    TEXT("nsm.debug.DrawKeyFrames"),
    (int32) 1,
    TEXT("Draws keyframe data (text) in debug graphs")
)

Public function

int32

 

NetworkSimulationModelDebugCVars::DrawNetworkSendLines()

Public function Static

FConditionalAutoConsoleRegister

 

NetworkSimulationModelDebugCVars::DrawNetworkSendLinesAuto

(
    TEXT("nsm.debug.DrawNetworkSendLines"),
    (int32) 1,
    TEXT("Draws lines representing network traffic in debugger")
)

Public function

int32

 

NetworkSimulationModelDebugCVars::GatherServerSidePIE()

Public function Static

FConditionalAutoConsoleRegister

 

NetworkSimulationModelDebugCVars::GatherServerSidePIEAuto

(
    TEXT("nsm.debug.GatherServerSide"),
    (int32) 1,
    TEXT("Whenever we gather debug info from a client side actor, also gather server side equivelent. Only works in PIE.")
)

Public function

void

 

NetworkSimulationModelDebugCVars::SetDrawKeyframes

(
    int32 V
)

Public function

void

 

NetworkSimulationModelDebugCVars::SetDrawNetworkSendLines

(
    int32 V
)

Public function

void

 

NetworkSimulationModelDebugCVars::SetGatherServerSidePIE

(
    int32 V
)

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback