Version: 2020.3
  • C#
Experimental: this API is experimental and might be changed or removed in the future.


class in UnityEngine.UIElements.Experimental


Implemented in:UnityEngine.UIElementsModule

Implements interfaces:IValueAnimation

Suggest a change


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.


Submission failed

For 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.




Implementation object for transition animations.


autoRecycleReturns true if this animation object will be automatically returned to the instance pool after the animation has completed.
durationMsDuration of the animation in milliseconds.
easingCurveSmoothing function related to this animation. Default value is Easing.OutQuad.
fromThe animation start value.
initialValueCallback invoked when the from field has not been set, in order to retrieve the starting state of this animation.
interpolatorValue interpolation method.
isRunningTells if the animation is currently active.
onAnimationCompletedCallback invoked when this animation has completed.
toThe animation end value.
valueUpdatedCallback invoked after every value interpolation.



Public Methods

EaseSets the easing function.
KeepAliveWill not return the object to the instance pool when the animation has completed.
OnCompletedSets a callback invoked when this animation has completed.
RecycleReturns this animation object into its object pool.
StartStarts the animation using this object's values.
StopStops this animation.

Static Methods

CreateCreates a new ValueAnimation object or returns an available one from it's instance pool.