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 > Runtime > Engine > GameFramework > FRootMotionSourceGroup

Light Theme

Dark Theme

FRootMotionSourceGroup

Group of Root Motion Sources that are applied

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/GameFramework/RootMotionSource.h
Include	#include "GameFramework/RootMotionSource.h"

Syntax

struct FRootMotionSourceGroup

Remarks

Group of Root Motion Sources that are applied

Variables

	Name	Description
uint8: 1	bHasAdditiveSources	Whether this group has additive root motion sources
uint8: 1	bHasOverrideSources	Whether this group has override root motion sources
uint8: 1	bHasOverrideSourcesWithIgnoreZAccumulate	Whether this group has override root motion sources that have IgnoreZAccumulate flag
uint8: 1	bIsAdditiveVelocityApplied	True when we had additive velocity applied last tick, checked to know if we should restore LastPreAdditiveVelocity before a Velocity computation
FRootMotionSour...	LastAccumulatedSettings	Aggregate Settings of the last group of accumulated sources
FVector_NetQuan...	LastPreAdditiveVelocity	Saved off pre-additive-applied Velocity, used for being able to reliably add/remove additive velocity from currently computed Velocity (otherwise we would be removing additive velocity that no longer exists, like if you run into a wall and your Velocity becomes 0 - subtracting the velocity that we added heading into the wall last tick would make you go backwards. With this method we override that resulting Velocity due to obstructions
TArray< TShared...	PendingAddRootMotionSources	Root Motion Sources to be added next frame
TArray< TShared...	RootMotionSources	Root Motion Sources currently applied in this Group

Constructors

	Name	Description
	FRootMotionSourceGroup()

Destructors

	Name	Description
	~FRootMotionSourceGroup()

Functions

	Name	Description
void	AccumulateAdditiveRootMotionVelocity ( float DeltaTime, const ACharacter& Character, const UCharacterMovementComponent&..., FVector& InOutVelocity )	Helper function for accumulating additive velocity into InOutVelocity
void	AccumulateOverrideRootMotionVelocity ( float DeltaTime, const ACharacter& Character, const UCharacterMovementComponent&..., FVector& InOutVelocity )	Helper function for accumulating override velocity into InOutVelocity
void	AccumulateRootMotionVelocity ( ERootMotionAccumulateMode RootMotio..., float DeltaTime, const ACharacter& Character, const UCharacterMovementComponent&..., FVector& InOutVelocity )	Accumulates contributions for velocity into InOutVelocity for a given type of root motion from this group
void	AccumulateRootMotionVelocityFromSource ( const FRootMotionSource& RootMotio..., float DeltaTime, const ACharacter& Character, const UCharacterMovementComponent&..., FVector& InOutVelocity )	Accumulates contributions for velocity into InOutVelocity for a given type of root motion from this group
void	AddStructReferencedObjects ( FReferenceCollector& Collector )	Exposes references to GC system
uint16	ApplyRootMotionSource ( TSharedPtr< FRootMotionSource > Sou... )	Apply a RootMotionSource to this Group
void	ApplyTimeStampReset ( float DeltaTime )	Applies a reset to the start time for each root motion when the time stamp is reset
void	CleanUpInvalidRootMotion ( float DeltaTime, const ACharacter& Character, UCharacterMovementComponent& MoveC... )
void	Clear()	Clear the contents to return it to "empty"
void	CullInvalidSources()	Removes any Sources without a valid ID
bool	GetOverrideRootMotionRotation ( float DeltaTime, const ACharacter& Character, const UCharacterMovementComponent&..., FQuat& OutRotation )	Get rotation output of current override root motion source, returns true if OutRotation was filled
TSharedPtr< ...	GetRootMotionSource ( FName InstanceName )	Get a RootMotionSource from this Group by name
TSharedPtr< ...	GetRootMotionSourceByID ( uint16 RootMotionSourceID )	Get a RootMotionSource from this Group by ID
bool	HasActiveRootMotionSources()
bool	HasAdditiveVelocity()
bool	HasOverrideVelocity()
bool	HasOverrideVelocityWithIgnoreZAccumulate()
bool	HasRootMotionToApply()
bool	HasVelocity()
bool	NeedsSimulatedSmoothing()	Gets whether any active root motion source has been marked to need NetworkSmoothing as a SimulatedProxy
bool	NetSerialize ( FArchive& Ar, UPackageMap* Map, bool& bOutSuccess )	Serialize the root motion sources and their states for this group
void	NetSerializeRMSArray ( FArchive& Ar, UPackageMap* Map, bool& bOutSuccess, TArray< TSharedPtr< FRootMotionSour... )	Helper function for serializing array of root motion sources
void	PrepareRootMotion ( float DeltaTime, const ACharacter& Character, const UCharacterMovementComponent&..., bool bForcePrepareAll )	Generates root motion by accumulating transforms through current root motion sources.
void	RemoveRootMotionSource ( FName InstanceName )	Remove a RootMotionSource from this Group by name
void	RemoveRootMotionSourceByID ( uint16 RootMotionSourceID )	Remove a RootMotionSource from this Group by ID
void	SetPendingRootMotionSourceMinStartTimes ( float NewStartTime )	Sets the StartTime of all pending root motion sources to be at least this time, can be used on servers to match client-side start times
void	UpdateStateFrom ( const FRootMotionSourceGroup& Grou..., bool bMarkForSimulatedCatchup )	Update contained Sources to state in matching sources from other group.

Operators

	Name	Description
bool	operator!= ( const FRootMotionSourceGroup& Othe... )	Comparison operator
FRootMotionS...	operator= ( const FRootMotionSourceGroup& Othe... )	Copy operator - deep copy so it can be used for archiving/saving off moves
bool	operator== ( const FRootMotionSourceGroup& Othe... )	Comparison operator - needs matching Sources along with identical states in those sources

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

Take our survey

Dismiss