Skip to content

Api > Animator > SetIKPositionWeight()


Animator.SetIKPositionWeight(AvatarIKGoal goal, number value)⚓︎

Sets the translative weight of an IK goal (0 = at the original animation before IK, 1 = at the goal).

Parameters:⚓︎

Name Type Description
goal AvatarIKGoal The AvatarIKGoal that is set.
value number The translative weight.

Usage⚓︎

---@type Animator
local animator;

---@type AvatarIKGoal
local goal;

---@type number
local value;


animator.SetIKPositionWeight(goal, value)

Extra Detail⚓︎

An IK goal is a target position and rotation for a specific body part. Unity can calculate how to move the part toward the target from the starting point (ie, the current position and rotation obtained from the animation). This function sets a weight value in the range 0..1 to determine how far between the start and goal positions the IK will aim. The position itself is set separately using SetIKPosition.