FNetworkPredictionProxy

Windows
MacOS
Linux

References

Module

NetworkPrediction

Header

/Engine/Plugins/Runtime/NetworkPrediction/Source/NetworkPrediction/Public/NetworkPredictionProxy.h

Include

#include "NetworkPredictionProxy.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FNetworkPredictionProxy

Functions

Name Description

Public function

void

 

Configure

(
    const FNetworkPredictionInstanceCon...
)

Call to change local configuration of proxy. Not networked.

Public function

void

 

EndPlay()

Unregisters from NetworkPrediction System.

Public function Const

bool

 

GetCachedHasNetConnection()

Public function Const

ENetRole

 

GetCachedNetRole()

Public function Const

FNetSimCueDi...

 

GetCueDispatcher()

Public function Const

int32

 

GetPendingFrame()

Public function Const

int32

 

GetTotalSimTimeMS()

Public function Const

bool

 

Identical

(
    const FNetworkPredictionProxy*...,
    uint32 PortFlags
)

Public function

void

 

Init

(
    UWorld* World,
    const FReplicationProxySet& RepPro...,
    typename ModelDef::Simulation*...,
    typename ModelDef::Driver* Dri...
)

The init function that you need to call. This is defined in NetworkPredictionProxyInit.h (which should only be included by your .cpp file)

Public function

void

 

InitForNetworkRole

(
    ENetRole Role,
    bool bHasNetConnection
)

When network role changes, initializes role storage and logic controller.

Public function

bool

 

NetSerialize

(
    FArchive& Ar,
    UPackageMap* Map,
    bool& bOutSuccess
)

Public function Const

const TAuxSt...

 

ReadAuxState

(
    ENetworkPredictionStateRead ReadTyp...
)

Returns Presentation AuxState by default, if it is set. Otherwise returns pending Simulation value.

Public function Const

const TInput...

 

ReadInputCmd()

Returns pending InputCmd. (.

Public function Const

const TSyncS...

 

ReadSyncState

(
    ENetworkPredictionStateRead ReadTyp...
)

Returns Presentation SyncState by default, if it is set. Otherwise returns pending Simulation value.

Public function

void

 

SetArchetype

(
    const FNetworkPredictionInstanceArc...,
    const FNetworkPredictionInstanceCon...
)

Should only be called on the authority. Changes what how this instance is allowed to be configured.

Public function

const TAuxSt...

 

WriteAuxState

(
    TFunctionRef< void> Wr...,
    const FAnsiStringView& TraceMsg
)

Public function

const TInput...

 

WriteInputCmd

(
    TFunctionRef< void> Wr...,
    const FAnsiStringView& TraceMsg
)

Writes - must include NetworkPredictionProxyWrite.h in places that call this.

Public function

const TSyncS...

 

WriteSyncState

(
    TFunctionRef< void> W...,
    const FAnsiStringView& TraceMsg
)

Enums

Name

Description

Private enum

EConfigAction

Allows ConfigFunc to be invoked to "do a thing" instead of set a new config/id.

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