UnityEngine.AnimationModule

Leave feedback

Suggest a change

Description

The Animation module implements Unity's animation system.

Classes

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.

Structs

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.

Enumerations

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.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Scripting API

UnityEngine.AnimationModule

Success!

Submission failed

Description

Classes

Structs

Enumerations