Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Animator.GetIKPositionWeight

Switch to Manual
GetIKPositionWeight(goal: AvatarIKGoal): float;
float GetIKPositionWeight(AvatarIKGoal goal);
def GetIKPositionWeight(goal as AvatarIKGoal) as float

Parameters

goalThe AvatarIKGoal that is queried.

Description

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

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).

The point calculated by the IK is also influenced by a weight value in the range 0..1 that determines how far between the start and the goal to aim. This function returns the current weight value for the position of the goal.

See Also: GetIKPosition, SetIKPosition.