Viewing: docs.unity3d.com

Description

The Animator Controller controls animation through layers with state machines, controlled by parameters.

using UnityEngine;
using UnityEditor;
using UnityEditor.Animations;
using System.Collections;

// Create a menu item that causes a new controller and statemachine to be created.

public class SM : MonoBehaviour
{
    [MenuItem("MyMenu/Create Controller")]
    static void CreateController()
    {
        // Creates the controller
        var controller = UnityEditor.Animations.AnimatorController.CreateAnimatorControllerAtPath("Assets/Mecanim/StateMachineTransitions.controller");

        // Add parameters
        controller.AddParameter("TransitionNow", AnimatorControllerParameterType.Trigger);
        controller.AddParameter("Reset", AnimatorControllerParameterType.Trigger);
        controller.AddParameter("GotoB1", AnimatorControllerParameterType.Trigger);
        controller.AddParameter("GotoC", AnimatorControllerParameterType.Trigger);

        // Add StateMachines
        var rootStateMachine = controller.layers[0].stateMachine;
        var stateMachineA = rootStateMachine.AddStateMachine("smA");
        var stateMachineB = rootStateMachine.AddStateMachine("smB");
        var stateMachineC = stateMachineB.AddStateMachine("smC");

        // Add States
        var stateA1 = stateMachineA.AddState("stateA1");
        var stateB1 = stateMachineB.AddState("stateB1");
        var stateB2 = stateMachineB.AddState("stateB2");
        stateMachineC.AddState("stateC1");
        var stateC2 = stateMachineC.AddState("stateC2"); // dont add an entry transition, should entry to state by default

        // Add Transitions
        var exitTransition = stateA1.AddExitTransition();
        exitTransition.AddCondition(UnityEditor.Animations.AnimatorConditionMode.If, 0, "TransitionNow");
        exitTransition.duration = 0;

        var resetTransition = rootStateMachine.AddAnyStateTransition(stateA1);
        resetTransition.AddCondition(UnityEditor.Animations.AnimatorConditionMode.If, 0, "Reset");
        resetTransition.duration = 0;

        var transitionB1 = stateMachineB.AddEntryTransition(stateB1);
        transitionB1.AddCondition(UnityEditor.Animations.AnimatorConditionMode.If, 0, "GotoB1");
        stateMachineB.AddEntryTransition(stateB2);
        stateMachineC.defaultState = stateC2;
        var exitTransitionC2 = stateC2.AddExitTransition();
        exitTransitionC2.AddCondition(UnityEditor.Animations.AnimatorConditionMode.If, 0, "TransitionNow");
        exitTransitionC2.duration = 0;

        var stateMachineTransition = rootStateMachine.AddStateMachineTransition(stateMachineA, stateMachineC);
        stateMachineTransition.AddCondition(UnityEditor.Animations.AnimatorConditionMode.If, 0, "GotoC");
        rootStateMachine.AddStateMachineTransition(stateMachineA, stateMachineB);
    }
}

Properties

Property	Description
evaluateEntryTransitionsOnStart	Configures the initialization of the controller.
layers	The layers in the controller.
parameters	Parameters are used to communicate between scripting and the controller. They are used to drive transitions and blendtrees for example.

Constructors

Constructor	Description
AnimatorController	Constructor.

Public Methods

Method	Description
AddEffectiveStateMachineBehaviour	Adds a state machine behaviour class of a specific type to the AnimatorState for layer layerIndex. This method should be used when you are dealing with synchronized layer and would like to add a state machine behaviour on a synchronized layer. Note that there is no corresponding "Remove" method. To remove a state machine behaviour, use Object.Destroy.
AddLayer	Utility function to add a layer to the controller.
AddMotion	Utility function that creates a new state with the motion in it.
AddParameter	Utility function to add a parameter to the controller.
CreateBlendTreeInController	Creates a BlendTree in a new AnimatorState.
GetBehaviours	Returns all StateMachineBehaviour that match type T or are derived from T.
GetStateEffectiveBehaviours	Gets the effective state machine behaviour list for the AnimatorState. Behaviours are either stored in the AnimatorStateMachine or in the AnimatorLayer's ovverrides. Use this function to get Behaviour list that is effectively used.
GetStateEffectiveMotion	Gets the effective Motion for the AnimatorState. The Motion is either stored in the AnimatorStateMachine or in the AnimatorLayer's ovverrides. Use this function to get the Motion that is effectively used.
MakeUniqueLayerName	Creates a unique name for the layers.
MakeUniqueParameterName	Creates a unique name for the parameter.
RemoveLayer	Utility function to remove a layer from the controller.
RemoveParameter	Utility function to remove a parameter from the controller.
SetStateEffectiveBehaviours	Sets the effective state machine Behaviour list for the AnimatorState. The Behaviour list is either stored in the AnimatorStateMachine or in the AnimatorLayer's ovverrides. Use this function to set the Behaviour list that is effectively used.
SetStateEffectiveMotion	Sets the effective Motion for the AnimatorState. The Motion is either stored in the AnimatorStateMachine or in the AnimatorLayer's ovverrides. Use this function to set the Motion that is effectively used.

Static Methods

Method	Description
CreateAnimatorControllerAtPath	Creates an AnimatorController at the given path.
CreateAnimatorControllerAtPathWithClip	Creates an AnimatorController at the given path, and automatically create an AnimatorLayer with an AnimatorStateMachine that will add a State with the AnimationClip in it.
CreateNewStateMachineBehaviour	This function will create a StateMachineBehaviour instance based on the class define in this script.
FindStateMachineBehaviourContext	Use this function to retrieve the owner of this behaviour.

Inherited Members

Properties

Property	Description
hideFlags	Controls whether the object is hidden, saved with the scene, and editable by the user.
name	The name of the object.
animationClips	Retrieves all AnimationClip used by the controller.

Public Methods

Method	Description
GetEntityId	Gets the EntityId of the object.
GetHashCode	Returns the hash code for the object.
ToString	Returns the name of the object.

Static Methods

Method	Description
Destroy	Removes a GameObject, component, or asset.
DestroyImmediate	Destroys the specified object immediately. Use with caution and in Edit mode only.
DontDestroyOnLoad	Do not destroy the target Object when loading a new Scene.
FindAnyObjectByType	Retrieves any active loaded object of Type T.
FindObjectsByType	Retrieves a list of all loaded objects of Type type.
Instantiate	Clones the object original and returns the clone.
InstantiateAsync	Captures a snapshot of the original object that's related to another GameObject and obtains an AsyncInstantiateOperation instance of the resulting objects.

Operators

Operator	Description
bool	Determines whether the object exists.
operator !=	Compares if two objects refer to a different object.
operator ==	Compares two object references to see if they refer to the same object.

Scripting API

AnimatorController

Success!

Submission failed

Description

Properties

Constructors

Public Methods

Static Methods

Inherited Members

Properties

Public Methods

Static Methods

Operators