Skip to content

Api > Animator > SetIKPosition()


Animator.SetIKPosition(AvatarIKGoal goal, Vector3 goalPosition)⚓︎

Sets the position of an IK goal.

Parameters:⚓︎

Name Type Description
goal AvatarIKGoal The AvatarIKGoal that is set.
goalPosition Vector3 The position in world space.

Usage⚓︎

---@type Animator
local animator;

---@type AvatarIKGoal
local goal;

---@type Vector3
local goalPosition;


animator.SetIKPosition(goal, goalPosition)

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 the position of the ultimate goal in world space; the actual point in space where the body part ends up is also influenced by a weight parameter that specifies how far between the start and the goal the IK should aim (a value in the range 0..1).