Skip to content

Documentation / scene / CopyHumanoidAnimationOptions

Type Alias: CopyHumanoidAnimationOptions

CopyHumanoidAnimationOptions = object

Defined in: libs/scene/src/animation/animationset.ts:485

Properties

targetName?

optional targetName?: string

Defined in: libs/scene/src/animation/animationset.ts:489

Name for the new clip. Ignored when the legacy third targetName argument is a string.


rootMotion?

optional rootMotion?: HumanoidRootMotionMode

Defined in: libs/scene/src/animation/animationset.ts:498

How root translation should be handled.

  • scaled: retarget and scale root motion to the destination rig size.
  • copy: retarget root motion without scale.
  • locked: write a constant destination bind-pose root translation.
  • none: do not create a root translation track.

rootMotionScale?

optional rootMotionScale?: HumanoidRootMotionScaleMode

Defined in: libs/scene/src/animation/animationset.ts:502

Scale used when rootMotion is scaled.


lockRootMotionAxes?

optional lockRootMotionAxes?: HumanoidRetargetAxisLocks

Defined in: libs/scene/src/animation/animationset.ts:506

Axis locks applied after root motion retargeting. Locked axes stay at the destination bind pose.


jointTranslations?

optional jointTranslations?: "skip" | "preserve"

Defined in: libs/scene/src/animation/animationset.ts:511

Whether to preserve non-root humanoid translation tracks. These are skipped by default because retargeting humanoid joints should normally keep the destination skeleton lengths intact.

Released under the MIT License.