1. Epic GamesDeveloper
  3. FRootMotionSourceGroup

FRootMotionSourceGroup

Group of Root Motion Sources that are applied

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/GameFramework

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

  Type Name Description
Public variable uint8: 1 bHasAdditiveSources Whether this group has additive root motion sources
Public variable uint8: 1 bHasOverrideSources Whether this group has override root motion sources
Public variable uint8: 1 bHasOverrideSourcesWithIgnoreZAccumulate Whether this group has override root motion sources that have IgnoreZAccumulate flag
Public variable uint8: 1 bIsAdditiveVelocityApplied True when we had additive velocity applied last tick, checked to know if we should restore LastPreAdditiveVelocity before a Velocity computation
Public variable FRootMotionSourceSettings LastAccumulatedSettings Aggregate Settings of the last group of accumulated sources
Public variable FVector_NetQuantize10 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
Public variable TArray< TSharedPtr< FRootMotionSource > > PendingAddRootMotionSources Root Motion Sources to be added next frame
Public variable TArray< TSharedPtr< FRootMotionSource > > RootMotionSources Root Motion Sources currently applied in this Group

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const void

AccumulateAdditiveRootMotionVelocity ( float DeltaTime,
const ACharacter& Character,
const UCharacterMovementComponent& MoveComponent,
FVector& InOutVelocity
)

 Helper function for accumulating additive velocity into InOutVelocity
Public function Const void

AccumulateOverrideRootMotionVelocity ( float DeltaTime,
const ACharacter& Character,
const UCharacterMovementComponent& MoveComponent,
FVector& InOutVelocity
)

 Helper function for accumulating override velocity into InOutVelocity
Protected function Const void

AccumulateRootMotionVelocity ( ERootMotionAccumulateMode RootMotionType,
float DeltaTime,
const ACharacter& Character,
const UCharacterMovementComponent& MoveComponent,
FVector& InOutVelocity
)

 Accumulates contributions for velocity into InOutVelocity for a given type of root motion from this group
Protected function Const void

AccumulateRootMotionVelocityFromSource ( const FRootMotionSource& RootMotionSource,
float DeltaTime,
const ACharacter& Character,
const UCharacterMovementComponent& MoveComponent,
FVector& InOutVelocity
)

 Accumulates contributions for velocity into InOutVelocity for a given type of root motion from this group
Public function Const void Exposes references to GC system
Public function uint16 Apply a RootMotionSource to this Group
Public function void

ApplyTimeStampReset ( float DeltaTime
)

 Applies a reset to the start time for each root motion when the time stamp is reset
Public function void

CleanUpInvalidRootMotion ( float DeltaTime,
const ACharacter& Character,
UCharacterMovementComponent& MoveComponent
)

  
Public function void

Clear ()

 Clear the contents to return it to "empty"
Public function void Removes any Sources without a valid ID
Public function Const bool

GetOverrideRootMotionRotation ( float DeltaTime,
const ACharacter& Character,
const UCharacterMovementComponent& MoveComponent,
FQuat& OutRotation
)

 Get rotation output of current override root motion source, returns true if OutRotation was filled
Public function TSharedPtr< FRootMotionSource >

GetRootMotionSource ( FName InstanceName
)

 Get a RootMotionSource from this Group by name
Public function TSharedPtr< FRootMotionSource >

GetRootMotionSourceByID ( uint16 RootMotionSourceID
)

 Get a RootMotionSource from this Group by ID
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Gets whether any active root motion source has been marked to need NetworkSmoothing as a SimulatedProxy
Public function bool

NetSerialize ( FArchive& Ar,
UPackageMap* Map,
bool& bOutSuccess,
uint8 MaxNumRootMotionSourcesToSerialize
)

 Serialize the root motion sources and their states for this group
Protected function Static void

NetSerializeRMSArray ( FArchive& Ar,
UPackageMap* Map,
bool& bOutSuccess,
TArray< TSharedPtr< FRootMotionSource > >& RootMotionSourceArray,
uint8 MaxNumRootMotionSourcesToSerialize
)

 Helper function for serializing array of root motion sources
Public function void

PrepareRootMotion ( float DeltaTime,
const ACharacter& Character,
const UCharacterMovementComponent& InMoveComponent,
bool bForcePrepareAll
)

 Generates root motion by accumulating transforms through current root motion sources.
Public function void

RemoveRootMotionSource ( FName InstanceName
)

 Remove a RootMotionSource from this Group by name
Public function void

RemoveRootMotionSourceByID ( uint16 RootMotionSourceID
)

 Remove a RootMotionSource from this Group by ID
Public function void 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
Public function void

UpdateStateFrom ( const FRootMotionSourceGroup& GroupToTakeStateFrom,
bool bMarkForSimulatedCatchup
)

 Update contained Sources to state in matching sources from other group.

Operators

  Type Name Description
Public function Const bool Comparison operator
Public function FRootMotionSourceGroup & Copy operator - deep copy so it can be used for archiving/saving off moves
Public function Const bool Comparison operator - needs matching Sources along with identical states in those sources

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page