public enum RootMotionModeWhat to do with the motion baked into a clip's root joint.
No guide page documents this yet — the page shows what the code says about itself.
Remarks
An artist animating a run cycle moves the character forward, because that is the only way the feet can be planted. What the game wants is a character whose feet are planted and whose position is decided by gameplay. Root motion is the reconciliation: the root joint's per-frame movement is taken out of the pose and handed to whoever owns the entity's transform.
Which is why this is a mode and not a flag. A character controller that owns its own velocity wants Extract — give me the delta, I will decide what to do with it, and I will not be teleported through a wall by an animation. A cutscene or a traversal animation wants Apply. And a clip authored in place wants Disabled, where the root joint is just another joint.
Fields and properties (3)
DisabledThe root joint animates like any other. Nothing is taken out of the pose.
ExtractThe delta is taken out of the pose and reported, and nothing is moved. The caller applies it — after collision, after a speed multiplier, or not at all.
ApplyThe delta is taken out of the pose and written straight to the entity's transform.
Used by (4)
- AnimationSystemVixen.Animation
- AnimatorVixen.Animation
- AnimatorTestsVixen.Animation.Tests
- EcsIntegrationTestsVixen.Animation.Tests