Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > NetworkPrediction > UNetworkPredictionComponent

Light Theme

Dark Theme

UNetworkPredictionComponent

[UNetworkPredictionComponent](API\Plugins\NetworkPrediction\UNetworkPredictionComponent) This is the base component for running a [TNetworkedSimulationModel](API\Plugins\NetworkPrediction\TNetworkedSimulationModel) through an actor component.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UNetworkPredictionComponent

UBaseMovementComponent

UFlyingMovementComponent

UMockFlyingAbilityComponent

UParametricMovementComponent

UMockNetworkSimulationComponent

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract)
class UNetworkPredictionComponent : public UActorComponent

Remarks

UNetworkPredictionComponent This is the base component for running a TNetworkedSimulationModel through an actor component. This contains the boiler plate hooks into getting the system initialized and plugged into the UE4 replication system.

This is an abstract component and cannot function on its own. It must be subclassed and InstantiateNetworkedSimulation must be implemented. Ticking and RPC sending will be handled automatically, but the subclass will need to supply input to the simulation (via TNetworkedSimulationModelDriver::ProduceInput).

Its also worth pointing out that nothing about being a UActorComponent is essential here. All that this component does could be done within an AActor itself. An actor component makes sense for flexible/reusable code provided by the plugin. But there is nothing stopping you from copying this directly into an actor if you had reason to.

Variables

	Name	Description
TUniquePtr< INe...	NetSimModel	The Network sim that this component is managing. This is what is doing all the work.
ENetRole	OwnerCachedNetRole
FReplicationPro...	ReplicationProxy_ServerRPC	ReplicationProxies are just pointers to the data/NetSerialize functions within the NetworkSim.
FDelegateHandle	ServerRPCHandle

Constructors

	Name	Description
	UNetworkPredictionComponent()

Functions

	Name	Description
bool	CheckOwnerRoleChange()	Helper: Checks if the owner's role has changed and calls InitializeForNetworkRole if necessary.
INetworkedSi...	GetNetworkSimulation()
FNetworkSimu...	GetSimulationInitParameters ( ENetRole Role )	Doesn't need to be overridden. Expected to be used in ::InitializeForNetworkRole implementation.
void	InitializeForNetworkRole ( ENetRole Role )	Finalizes initialization when NetworkRole changes. Does not need to be overridden.
INetworkedSi...	InstantiateNetworkedSimulation()	Classes must instantiate their own NetworkSim here. The UNetworkPredictionComponent will manage its lifetime.
bool	IsLocallyControlled()	Attempts to determine if the component is locally controlled or not, meaning we expect input cmds to be generated locally (and hence need to prepare the input buffer for that)
void	Reconcile()
void	RegisterServerRPCDelegate()
void	ServerRecieveClientInput ( const FServerReplicationRPCParamete... )	The actual ServerRPC. This needs to be a UFUNCTION but is generic and not dependent on the simulation instance.
void	TickServerRPC ( float DeltaSeconds )	Called via ServerRPCDelegate, ticks serverRPC timing and decides whether to send the RPC or not.
void	TickSimulation ( float DeltaTimeSeconds )
void	UnregisterServerRPCDelegate()

Overridden from UActorComponent

	Name	Description
void	InitializeComponent()	Initializes the component.
void	PreReplication ( IRepChangedPropertyTracker& Change... )	Called on the component right before replication occurs
void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.
void	UninitializeComponent()	Handle this component being Uninitialized.

Overridden from UObject

		Name	Description
	void	PreNetReceive()	Called right before receiving a bunch

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

Take our survey

Dismiss