Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


OnStateIK

Invoked during the Animator IK pass. Implement this message to modify the result of the animation after the evaluation of the state machine on a state by state basis.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.AnimationModule

OnStateIK(Animator, AnimatorStateInfo, int)

Invoked during the Animator IK pass. Implement this message to modify the result of the animation after the evaluation of the state machine on a state by state basis.
public virtual void OnStateIK(Animator animator, AnimatorStateInfo stateInfo, int layerIndex)

Parameters

animator

The Animator evaluating this state machine.

Information about the state being evaluated.

layerIndex

The current layer being evaluated.

Remarks

OnStateIK is invoked every frame for the currently evaluated state, as well the next state and the interrupted state if applicable. It will be invoked after OnAnimatorIK.
Note: OnStateIK may be invoked multiple times on the same state if that state is synchronized on multiple layers.

OnStateIK(Animator, AnimatorStateInfo, int, AnimatorControllerPlayable)

Invoked during the Animator IK pass. Implement this message to modify the result of the animation after the evaluation of the state machine on a state by state basis.
public virtual void OnStateIK(Animator animator, AnimatorStateInfo stateInfo, int layerIndex, AnimatorControllerPlayable controller)

Parameters

animator

The Animator evaluating this state machine.

Information about the state being evaluated.

layerIndex

The current layer being evaluated.

Remarks

OnStateIK is invoked every frame for the currently evaluated state, as well the next state and the interrupted state if applicable. It will be invoked after OnAnimatorIK.
Note: OnStateIK may be invoked multiple times on the same state if that state is synchronized on multiple layers.