class 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.
CloseUsed to communicate between scripting and an AnimatorController.
You can add an AnimatorControllerParameter to an AnimatorController in the Animator window or with the function AnimatorController.AddParameter in script. At runtime, use the following functions to set the value of a parameter in the Animator:
You can also set parameter values in the Animation window based on Animation Curves in Animation Clips.
using UnityEditor; using UnityEditor.Animations; using UnityEngine; // This example demonstrates how to create an AnimatorController with some default parameters. public static class AnimatorControllerParameterExample { [MenuItem("Example/Create Animator Controller With Default Parameters")] public static void CreateAnimatorControllerWithDefaultParameters() { // Create a new AnimatorController. var controller = AnimatorController.CreateAnimatorControllerAtPath("Assets/NewControllerWithParameters.controller"); // Add a new parameter to the controller. var speedParameter = new AnimatorControllerParameter { name = "Speed", type = AnimatorControllerParameterType.Float }; controller.AddParameter(speedParameter); // Add another parameter to the controller with a default value. var isGroundedParameter = new AnimatorControllerParameter { name = "IsGrounded", type = AnimatorControllerParameterType.Bool, defaultBool = true }; controller.AddParameter(isGroundedParameter); // Save the controller. AssetDatabase.SaveAssetIfDirty(controller); } }
Additional resources: AnimationParameters manual. AnimatorController.RemoveParameter for removing parameters. AnimatorController.parameters for accessing the list of parameters.
defaultBool | The default bool value for the parameter. |
defaultFloat | The default float value for the parameter. |
defaultInt | The default int value for the parameter. |
name | The name of the parameter. |
nameHash | Returns the hash of the parameter based on its name. |
type | The type of the parameter. |
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.