Skip to content

Api > Animator > GetIKPosition()


Animator.GetIKPosition(AvatarIKGoal goal)⚓︎

Gets the position of an IK goal.

Parameters:⚓︎

Name Type Description
goal AvatarIKGoal The AvatarIKGoal that is queried.

Returns:⚓︎

type Description
Vector3 Return the current position of this IK goal in world space.

Usage⚓︎

---@type Animator
local animator;

---@type AvatarIKGoal
local goal;


local val0 = animator.GetIKPosition(goal)

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 gets the current position of the specified goal in world space.