Navigation
API > API/Plugins > API/Plugins/NetworkPrediction
| Name | FNetworkPredictionProxy |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/NetworkPrediction/Source/NetworkPrediction/Public/NetworkPredictionProxy.h |
| Include Path | #include "NetworkPredictionProxy.h" |
Syntax
USTRUCT ()
struct FNetworkPredictionProxy
Structs
| Name | Remarks |
|---|---|
| FInitParams | Parameter struct to be used with the Init function overload below, when a UWorld isn't available, such as in unit tests. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ArchetypeDirtyCount | uint8 | NetworkPredictionProxy.h | ||
| bCachedHasNetConnection | bool | NetworkPredictionProxy.h | ||
| CachedArchetype | FNetworkPredictionInstanceArchetype | NetworkPredictionProxy.h | ||
| CachedConfig | FNetworkPredictionInstanceConfig | NetworkPredictionProxy.h | ||
| CachedNetRole | ENetRole | NetworkPredictionProxy.h | ||
| ConfigFunc | TFunction< void(FNetworkPredictionProxy *const, FNetworkPredictionID NewID, EConfigAction Action)> | NetworkPredictionProxy.h | ||
| ID | FNetworkPredictionID | NetworkPredictionProxy.h | ||
| View | FNetworkPredictionStateView | NetworkPredictionProxy.h | ||
| WorldManager | TObjectPtr< UNetworkPredictionWorldManager > | NetworkPredictionProxy.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Configure
(
const FNetworkPredictionInstanceConfig& Config |
Call to change local configuration of proxy. Not networked. | NetworkPredictionProxy.h | |
void EndPlay() |
Unregisters from NetworkPrediction System. | NetworkPredictionProxy.h | |
bool GetCachedHasNetConnection() |
NetworkPredictionProxy.h | ||
ENetRole GetCachedNetRole() |
NetworkPredictionProxy.h | ||
FNetSimCueDispatcher * GetCueDispatcher() |
NetworkPredictionProxy.h | ||
int32 GetPendingFrame() |
NetworkPredictionProxy.h | ||
int32 GetTotalSimTimeMS() |
NetworkPredictionProxy.h | ||
bool Identical
(
const FNetworkPredictionProxy* Other, |
NetworkPredictionProxy.h | ||
void Init
(
const FInitParams< ModelDef >& Params |
The init function binds to the templated methods on UNetworkPredictionMAnager. | NetworkPredictionProxy.h | |
void Init
(
UWorld* World, |
The init function that you need to call. This is defined in NetworkPredictionProxyInit.h (which should only be included by your .cpp file) | NetworkPredictionProxy.h | |
void InitForNetworkRole
(
ENetRole Role, |
When network role changes, initializes role storage and logic controller. | NetworkPredictionProxy.h | |
bool NetSerialize
(
FArchive& Ar, |
NetworkPredictionProxy.h | ||
const TAuxState * ReadAuxState
(
ENetworkPredictionStateRead ReadType |
Returns Presentation AuxState by default, if it is set. Otherwise returns pending Simulation value. | NetworkPredictionProxy.h | |
const TInputCmd * ReadInputCmd () |
Returns pending InputCmd. (Note there is no Presentation version of InputCmds) | NetworkPredictionProxy.h | |
const TAuxState * ReadPrevPresentationAuxState() |
Returns Prev Presentation AuxState by default, if it is set. Otherwise returns pending Simulation value. | NetworkPredictionProxy.h | |
const TSyncState * ReadPrevPresentationSyncState() |
Returns Prev Presentation SyncState by default, if it is set. Otherwise returns pending Simulation value. | NetworkPredictionProxy.h | |
const TSyncState * ReadSyncState
(
ENetworkPredictionStateRead ReadType |
Returns Presentation SyncState by default, if it is set. Otherwise returns pending Simulation value. | NetworkPredictionProxy.h | |
void SetArchetype
(
const FNetworkPredictionInstanceArchetype& Archetype, |
Should only be called on the authority. Changes what how this instance is allowed to be configured. | NetworkPredictionProxy.h | |
const TAuxState * WriteAuxState
(
TFunctionRef< void(TAuxState&)> WriteFunc, |
NetworkPredictionProxy.h | ||
const TInputCmd * WriteInputCmd
(
TFunctionRef< void(TInputCmd&)> WriteFunc, |
Writes - must include NetworkPredictionProxyWrite.h in places that call this Note that writes are implicitly done on the simulation state. | NetworkPredictionProxy.h | |
const TAuxState * WritePresentationAuxState
(
TFunctionRef< void(TAuxState&)> WriteFunc, |
NetworkPredictionProxy.h | ||
const TSyncState * WritePresentationSyncState
(
TFunctionRef< void(TSyncState&)> WriteFunc, |
NetworkPredictionProxy.h | ||
const TAuxState * WritePrevPresentationAuxState
(
TFunctionRef< void(TAuxState&)> WriteFunc, |
NetworkPredictionProxy.h | ||
const TSyncState * WritePrevPresentationSyncState
(
TFunctionRef< void(TSyncState&)> WriteFunc, |
NetworkPredictionProxy.h | ||
const TSyncState * WriteSyncState
(
TFunctionRef< void(TSyncState&)> WriteFunc, |
NetworkPredictionProxy.h |