FRootMotionMovementParams

Utility struct to accumulate root motion.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Animation/AnimationAsset.h

Include

#include "Animation/AnimationAsset.h"

Syntax

struct FRootMotionMovementParams

Remarks

Utility struct to accumulate root motion.

Variables

Name Description

Public variable

bool

 

bHasRootMotion

Public variable

float

 

BlendWeight

Constructors

Name Description

Public function

FRootMotionMovementParams()

Public function

FRootMotionMovementParams

(
    const FRootMotionMovementParams & O...
)

Copy/Move constructors and assignment operator added for deprecation support Could be removed once RootMotionTransform is made private

Public function

FRootMotionMovementParams

(
    const FRootMotionMovementParams && ...
)

Functions

Name Description

Public function

void

 

Accumulate

(
    const FTransform & InTransform
)

Public function

void

 

Accumulate

(
    const FRootMotionMovementParams & M...
)

Public function

void

 

AccumulateWithBlend

(
    const FTransform & InTransform,
    float InBlendWeight
)

Public function

void

 

AccumulateWithBlend

(
    const FRootMotionMovementParams & M...,
    float InBlendWeight
)

Public function

void

 

Clear()

Public function

FRootMotionM ...

 

ConsumeRootMotion

(
    float Alpha
)

Public function Const

const FTrans ...

 

GetRootMotionTransform()

Public function

void

 

MakeUpToFullWeight()

Public function

void

 

ScaleRootMotionTranslation

(
    float TranslationScale
)

Public function

void

 

Set

(
    const FTransform & InTransform
)

Operators

Name Description

Public function

FRootMotionM ...

 

operator=

(
    const FRootMotionMovementParams & O...
)

Constants

Name

Description

RootMotionScale

Deprecated Variables

Name Description

Public variable

FTransform

 

RootMotionTransform

RootMotionTransform should not be accessed directly, please use GetRootMotionTransform() to read it or one of the set/accumulate functions to modify it

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback