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.
CloseThe Animation module implements Unity's animation system.
AimConstraint | Constrains the orientation of an object relative to the position of one or more source objects, such that the object is facing the average position of the sources. |
Animation | The animation component is used to play back animations. |
AnimationClip | Stores keyframe based animations. |
AnimationEvent | AnimationEvent lets you call a script function similar to SendMessage as part of playing back an animation. |
AnimationPlayableBinding | A PlayableBinding that contains information representing an AnimationPlayableOutput. |
AnimationPlayableOutputExtensions | Static class providing experimental extension methods for AnimationPlayableOutput . |
AnimationPlayableUtilities | Implements high-level utility methods to simplify use of the Playable API with Animations. |
AnimationSceneHandleUtility | Static class providing utility functions for animation scene handles. |
AnimationState | The AnimationState gives full control over animation blending. |
AnimationStreamHandleUtility | Static class providing utility functions for animation stream handles. |
Animator | Interface to control the Mecanim animation system. |
AnimatorControllerParameter | Used to communicate between scripting and the controller. Some parameters can be set in scripting and used by the controller, while other parameters are based on Custom Curves in Animation Clips and can be sampled using the scripting API. |
AnimatorJobExtensions | Static class providing extension methods for Animator and the animation C# jobs. |
AnimatorOverrideController | Interface to control Animator Override Controller. |
AnimatorUtility | Various utilities for animator manipulation. |
Avatar | Avatar definition. |
AvatarBuilder | Class to build avatars from user scripts. |
AvatarMask | AvatarMask is used to mask out humanoid body parts and transforms. |
DiscreteEvaluationAttribute | Use this attribute to indicate that a property will be evaluated as a discrete value during animation playback. |
GenericBindingUtility | Animation utility functions for reading and writing values from Unity components. |
HumanPoseHandler | Use this class to create, read, and write the HumanPose for a humanoid avatar skeleton hierarchy or an avatar pose. |
HumanTrait | Details of all the human bone and muscle types defined by Mecanim. |
LookAtConstraint | Constrains the orientation of an object relative to the position of one or more source objects, such that the object is facing the average position of the sources. The LookAtConstraint is a simplified AimConstraint typically used with a Camera. |
Motion | Base class for AnimationClips and BlendTrees. |
NotKeyableAttribute | Use this attribute in a script to mark a property as non-animatable. |
ParentConstraint | Constrains the orientation and translation of an object to one or more source objects. The constrained object behaves as if it is in the hierarchy of the sources. |
PositionConstraint | Constrains the position of an object relative to the position of one or more source objects. |
RotationConstraint | Constrains the rotation of an object relative to the rotation of one or more source objects. |
RuntimeAnimatorController | The runtime representation of the AnimatorController. Use this representation to change the Animator Controller during runtime. |
ScaleConstraint | Constrains the scale of an object relative to the scale of one or more source objects. |
SharedBetweenAnimatorsAttribute | The SharedBetweenAnimatorsAttribute specifies that this StateMachineBehaviour is instantiated only once and shared by all Animator instances. This attribute reduces the memory footprint for each controller instance. |
StateMachineBehaviour | StateMachineBehaviour is a component that can be added to a state machine state. It's the base class any script on a state must derive from. |
AnimationClipPlayable | A Playable that controls an AnimationClip. |
AnimationHumanStream | The humanoid stream of animation data passed from one Playable to another. |
AnimationLayerMixerPlayable | An implementation of IPlayable that controls an animation layer mixer. |
AnimationMixerPlayable | An implementation of IPlayable that controls an animation mixer. |
AnimationPlayableOutput | A IPlayableOutput implementation that connects the PlayableGraph to an Animator in the Scene. |
AnimationScriptPlayable | A Playable that can run a custom, multi-threaded animation job. |
AnimationStream | The stream of animation data passed from one Playable to another. |
AnimatorClipInfo | Information about clip being played and blended by the Animator. |
AnimatorControllerPlayable | An implementation of IPlayable that controls an animation RuntimeAnimatorController. |
AnimatorStateInfo | Information about the current or next state. |
AnimatorTransitionInfo | Information about the current transition. |
BoundProperty | A BoundProperty is a safe handle to read and write value in a generic way from any Unity components. |
ConstraintSource | Represents a source for the constraint. |
GenericBinding | Defines an animatable property on a Unity Component. |
HumanBone | The mapping between a bone in the model and the conceptual bone in the Mecanim human anatomy. |
HumanDescription | Class that holds humanoid avatar parameters to pass to the AvatarBuilder.BuildHumanAvatar function. |
HumanLimit | This class stores the rotation limits that define the muscle for a single human bone. |
HumanPose | Retargetable humanoid pose. |
MatchTargetWeightMask | Use this struct to specify the position and rotation weight mask for Animator.MatchTarget. |
MuscleHandle | Handle for a muscle in the AnimationHumanStream. |
PropertySceneHandle | Handle to read a Component property on an object in the Scene. |
PropertyStreamHandle | Handle for a Component property on an object in the AnimationStream. |
SkeletonBone | Details of the Transform name mapped to the skeleton bone of a model and its default position and rotation in the T-pose. |
TransformSceneHandle | Handle to read position, rotation and scale of an object in the Scene. |
TransformStreamHandle | Position, rotation and scale of an object in the AnimationStream. |
AnimationBlendMode | Used by Animation.Play function. |
AnimationCullingType | This enum controlls culling of Animation component. |
AnimationStreamSource | Describes how an AnimationStream is initialized |
AnimationUpdateMode | The update mode of the Animation component. |
AnimatorControllerParameterType | The type of the parameter. |
AnimatorCullingMode | Culling mode for the Animator. |
AnimatorRecorderMode | The mode of the Animator's recorder. |
AnimatorUpdateMode | The update mode of the Animator. |
ArmDof | Enumeration of all the muscles in an arm. |
AvatarIKGoal | IK Goal. |
AvatarIKHint | IK Hint. |
AvatarMaskBodyPart | Avatar body part. |
AvatarTarget | Target. |
Axis | Represents the axes used in 3D space. |
BodyDof | Enumeration of all the muscles in the body. |
CustomStreamPropertyType | The type of custom stream property to create using BindCustomStreamProperty |
DurationUnit | Describe the unit of a duration. |
FingerDof | Enumeration of all the muscles in a finger. |
HeadDof | Enumeration of all the muscles in the head. |
HumanBodyBones | Human Body Bones. |
HumanPartDof | Enumeration of all the parts in a human. |
LegDof | Enumeration of all the muscles in a leg. |
PlayMode | Used by Animation.Play function. |
QueueMode | Used by Animation.Play function. |
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.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.