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

Switch to Manual
SetIKPositionWeight(goal: AvatarIKGoal, value: float): void;
void SetIKPositionWeight(AvatarIKGoal goal, float value);
def SetIKPositionWeight(goal as AvatarIKGoal, value as float) as void

Parameters

goalThe AvatarIKGoal that is set.
valueThe translative weight.

Description

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

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.

var objToPickUp: Transform;

private var animator: Animator;


function Start() {
	animator = GetComponent.<Animator>();
}


function OnAnimatorIK(layerIndex: int) {
	var reach: float = animator.GetFloat("RightHandReach");
	animator.SetIKPositionWeight(AvatarIKGoal.RightHand, reach);
	animator.SetIKPosition(AvatarIKGoal.RightHand, objToPickUp.position);                    
}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public Transform objToPickUp;
    private Animator animator;
    void Start() {
        animator = GetComponent<Animator>();
    }
    void OnAnimatorIK(int layerIndex) {
        float reach = animator.GetFloat("RightHandReach");
        animator.SetIKPositionWeight(AvatarIKGoal.RightHand, reach);
        animator.SetIKPosition(AvatarIKGoal.RightHand, objToPickUp.position);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public objToPickUp as Transform

	private animator as Animator

	def Start() as void:
		animator = GetComponent[of Animator]()

	def OnAnimatorIK(layerIndex as int) as void:
		reach as float = animator.GetFloat('RightHandReach')
		animator.SetIKPositionWeight(AvatarIKGoal.RightHand, reach)
		animator.SetIKPosition(AvatarIKGoal.RightHand, objToPickUp.position)