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 > NetworkPredictionExtras > UMockRootMotionComponent

Light Theme

Dark Theme

UMockRootMotionComponent

This component acts as the Driver for the [FMockRootMotionSimulation](API\Plugins\NetworkPredictionExtras\FMockRootMotionSimulation) It is essentially a standin for the movement component, and would be replaced by "new movement system" component.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UNetworkPredictionComponent

UBaseMovementComponent

UMockRootMotionComponent

References

Module	NetworkPredictionExtras
Header	/Engine/Plugins/Runtime/NetworkPredictionExtras/Source/NetworkPredictionExtras/Public/MockRootMotionComponent.h
Include	#include "MockRootMotionComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Meta=(BlueprintSpawnableComponent))
class UMockRootMotionComponent :
public UBaseMovementComponent,
public IRootMotionSourceStore

Remarks

This component acts as the Driver for the FMockRootMotionSimulation It is essentially a standin for the movement component, and would be replaced by "new movement system" component. If we support "root motion without movement component" then this could either be that component, or possibly built into or inherit from a USkeletalMeshComponent.

The main thing this provides is: -Interface for initiating root motions through the NP system (via client Input and via server "OOB" writes) -FinalizeFrame: take the output of the NP simulation and push it to the movement/animation components -Place holder implementation of IRootMotionSourceStore

Variables

	Name	Description
UAnimInstance &...	AnimInstance
TUniquePtr< FMo...	OwnedMockRootMotionSimulation
FMockRootMotion...	PendingInputCmd	Next local InputCmd that will be submitted. This is a simple way of getting input to the system.

Functions

	Name	Description
UMockRootMot...	CreateRootMotionSource ( TSubclassOf< UMockRootMotionSource ... )
void	FinalizeFrame ( const FMockRootMotionSyncState..., const FMockRootMotionAuxState... )
void	FindAndCacheAnimInstance()
void	InitializeSimulationState ( FMockRootMotionSyncState* Sync..., FMockRootMotionAuxState* AuxSt... )
void	Input_PlayRootMotionSource ( UMockRootMotionSource* Source )
void	Input_PlayRootMotionSourceByClass ( TSubclassOf< UMockRootMotionSource ... )
void	PlayRootMotionSource ( UMockRootMotionSource* Source )	Callable by authority.
void	PlayRootMotionSourceByClass ( TSubclassOf< UMockRootMotionSource ... )
void	ProduceInput ( const int32 SimTimeMS, FMockRootMotionInputCmd* Cmd )
void	RestoreFrame ( const FMockRootMotionSyncState..., const FMockRootMotionAuxState... )

Overridden from UBaseMovementComponent

		Name	Description
	void	SetUpdatedComponent ( USceneComponent* NewUpdatedCom... )	Basic "Update Component/Ticking".

Overridden from UNetworkPredictionComponent

		Name	Description
	void	InitializeNetworkPredictionProxy()	Classes must initialize the NetworkPredictionProxy (register with the NetworkPredictionSystem) here. EndPlay will unregister.

Overridden from IRootMotionSourceStore

		Name	Description
	UMockRootMot...	ResolveRootMotionSource ( int32 ID, const TArrayView< const uint8 >& D... )	Root Motion Object store.
	void	StoreRootMotionSource ( int32 ID, UMockRootMotionSource* Source )

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

Take our survey

Dismiss