AnimatorState

Description

Represents a state in a state machine.

Each state contains an (AnimationClip or a BlendTree) which plays while the character is in the state. When a state transition is triggered, the character adopts a new state. The (AnimationClip or BlendTree) for the new state takes over.

The following example illustrates how to create a simple state machine using an editor script. It creates three states, "Idle", "Run", and "Jump", and transitions between them. This example does not set the Motion. You can create a new state with AnimatorController.AddMotion, or you can assign a motion to an existing state using AnimatorState.motion.

using UnityEditor;
using UnityEditor.Animations;
using UnityEngine;

static class AnimatorStateExample
{
    [MenuItem("Example/Create Simple State Machine")]
    static void CreateSimpleController()
    {
        // Create the controller
        var controllerPath = AssetDatabase.GenerateUniqueAssetPath("Assets/SimpleController.controller");
        var controller = AnimatorController.CreateAnimatorControllerAtPath(controllerPath);

        var stateMachine = controller.layers[0].stateMachine;

        // Create the states. First state (Idle) becomes the default state
        var idleState = stateMachine.AddState("Idle", new Vector2(300, 200));
        var runState = stateMachine.AddState("Run", new Vector2(150, 350));
        var jumpState = stateMachine.AddState("Jump", new Vector2(450, 350));

        // Create the transition parameters
        controller.AddParameter("Speed", AnimatorControllerParameterType.Float);
        controller.AddParameter("Jump", AnimatorControllerParameterType.Trigger);

        // Create the transitions
        var idleToRun = idleState.AddTransition(runState);
        idleToRun.AddCondition(AnimatorConditionMode.Greater, 0.1f, "Speed");

        var runToIdle = runState.AddTransition(idleState);
        runToIdle.AddCondition(AnimatorConditionMode.Less, 0.1f, "Speed");

        var runToJump = runState.AddTransition(jumpState);
        runToJump.AddCondition(AnimatorConditionMode.If, 0, "Jump");
        runToJump.duration = 0;

        var jumpToRun = jumpState.AddTransition(runState);
        jumpToRun.duration = 0;

        var idleToJump = idleState.AddTransition(jumpState);
        idleToJump.AddCondition(AnimatorConditionMode.If, 0, "Jump");
    }
}

Additional resources: AnimatorController.AddMotion, AnimatorStateMachine.AddState, AnimatorStateMachine.states.

Properties

Public Methods

Inherited Members