struct in UnityEngine
/
Implemented in:UnityEngine.AnimationModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseRuntime information on the current or next animation state, managed by an Animator.
Use this struct to obtain information on the current animation state and its transitions. This information includes the name, duration, speed, and the looping status.
You can also use AnimatorStateInfo
to control animation timing and to handle blending, state changes, and event timing.
Additional resources: Animator, AnimatorController, Animator.StringToHash.
The following example demonstrates how to use AnimatorStateInfo
to manage transitions and adjust playback in real-time.
// This script demonstrate using AnimatorStateInfo to modify a parameter during animation. // Ensure Animator has a "Run" state in Base Layer and a "SpeedMultiplier" parameter. using UnityEngine; [RequireComponent(typeof(Animator))] public class AnimatorStateInfoExample : MonoBehaviour { private Animator m_Animator; private readonly int m_RunStateHash = Animator.StringToHash("Base Layer.Run"); void Start() { m_Animator = GetComponent<Animator>(); } void Update() { // Retrieve the current animation state information AnimatorStateInfo stateInfo = m_Animator.GetCurrentAnimatorStateInfo(0); // Use the hashed name for comparison with the current state's full path hash if (stateInfo.fullPathHash == m_RunStateHash) { Debug.Log("Running state active. Normalized time: " + stateInfo.normalizedTime); // Perform actions based on the animation's progress if (stateInfo.normalizedTime > 0.5f && stateInfo.normalizedTime < 0.75f) { Debug.Log("Halfway through the Run animation."); m_Animator.SetFloat("SpeedMultiplier", 1.5f); // Adjust the playback speed } } } }
fullPathHash | The full path hash for this state. |
length | Current duration of the state. |
loop | Is the state looping. |
normalizedTime | Normalized time of the State. |
shortNameHash | The hash is generated using Animator.StringToHash. The hash does not include the name of the parent layer. |
speed | The playback speed of the animation. 1 is the normal playback speed. |
speedMultiplier | The speed multiplier for this state. |
tagHash | The Tag of the State. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.