Documentation / scene / CopyHumanoidAnimationOptions

Type Alias: CopyHumanoidAnimationOptions

CopyHumanoidAnimationOptions = object

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

Properties

targetName?

optional targetName?: string

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

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:501

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:505

Scale used when rootMotion is scaled.

---

lockRootMotionAxes?

optional lockRootMotionAxes?: HumanoidRetargetAxisLocks

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

Axis locks applied after root motion retargeting. Locked axes stay at the destination bind pose. Y is locked by default when the rig has a separate root and hips joint.

---

hipsTranslation?

optional hipsTranslation?: HumanoidHipsTranslationMode

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

How local hips translation should be handled when the rig has a separate root joint. Hips motion is measured from the source retarget pose and applied on top of the destination bind pose, so character height is never copied from the source asset.

---

hipsTranslationScale?

optional hipsTranslationScale?: HumanoidRootMotionScaleMode

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

Scale used when hipsTranslation is scaled. Defaults to destination/source bind-pose leg length.

---

jointTranslations?

optional jointTranslations?: "skip" | "preserve"

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

Whether to preserve humanoid translation tracks other than root and hips. These are skipped by default because retargeting humanoid joints should normally keep destination bone lengths intact.