DOTween

Update type

Updates every frame during Update calls

Updates every frame during LateUpdate calls

Updates using FixedUpdate calls

Path mode (used to determine correct LookAt orientation)

Ignores the path mode (and thus LookAt behaviour)

Regular 3D path

2D top-down path

2D side-scroller path

Used internally

This class serves only as a utility class to store tween settings to apply on multiple tweens. It is in no way needed otherwise, since you can directly apply tween settings to a tween via chaining

A variable you can eventually Clear and reuse when needed, to avoid instantiating TweenParams objects

Creates a new TweenParams object, which you can use to store tween settings to pass to multiple tweens via myTween.SetAs(myTweenParms)

Clears and resets this TweenParams instance using default values, so it can be reused without instantiating another one

Sets the autoKill behaviour of the tween. Has no effect if the tween has already started

If TRUE the tween will be automatically killed when complete

Sets an ID for the tween, which can then be used as a filter with DOTween's static methods.

The ID to assign to this tween. Can be an int, a string, an object or anything else.

Sets the target for the tween, which can then be used as a filter with DOTween's static methods. IMPORTANT: use it with caution. If you just want to set an ID for the tween use SetId instead. When using shorcuts the shortcut target is already assigned as the tween's target, so using this method will overwrite it and prevent shortcut-operations like myTarget.DOPause from working correctly.

The target to assign to this tween. Can be an int, a string, an object or anything else.

Sets the looping options for the tween. Has no effect if the tween has already started

Number of cycles to play (-1 for infinite - will be converted to 1 in case the tween is nested in a Sequence) Loop behaviour type (default: LoopType.Restart)

Sets the ease of the tween. If applied to Sequences eases the whole sequence animation

Eventual overshoot or amplitude to use with Back or Elastic easeType (default is 1.70158) Eventual period to use with Elastic easeType (default is 0)

Sets the ease of the tween using an AnimationCurve. If applied to Sequences eases the whole sequence animation

Sets the ease of the tween using a custom ease function. If applied to Sequences eases the whole sequence animation

Sets the recycling behaviour for the tween.

If TRUE the tween will be recycled after being killed, otherwise it will be destroyed.

Sets the update type to the one defined in DOTween.defaultUpdateType (UpdateType.Normal unless changed) and lets you choose if it should be independent from Unity's Time.timeScale

If TRUE the tween will ignore Unity's Time.timeScale

Sets the type of update (default or independent) for the tween

The type of update (default: UpdateType.Normal) If TRUE the tween will ignore Unity's Time.timeScale

Sets the onStart callback for the tween. Called the first time the tween is set in a playing state, after any eventual delay

Sets the onPlay callback for the tween. Called when the tween is set in a playing state, after any eventual delay. Also called each time the tween resumes playing from a paused state

Sets the onRewind callback for the tween. Called when the tween is rewinded, either by calling Rewind or by reaching the start position while playing backwards. Rewinding a tween that is already rewinded will not fire this callback

Sets the onUpdate callback for the tween. Called each time the tween updates

Sets the onStepComplete callback for the tween. Called the moment the tween completes one loop cycle, even when going backwards

Sets the onComplete callback for the tween. Called the moment the tween reaches its final forward position, loops included

Sets the onKill callback for the tween. Called the moment the tween is killed

Sets the onWaypointChange callback for the tween. Called when a path tween reaches a new waypoint

Sets a delayed startup for the tween. Has no effect on Sequences or if the tween has already started

If isRelative is TRUE sets the tween as relative (the endValue will be calculated as startValue + endValue instead than being used directly). Has no effect on Sequences or if the tween has already started

If isSpeedBased is TRUE sets the tween as speed based (the duration will represent the number of units the tween moves x second). Has no effect on Sequences, nested tweens, or if the tween has already started

Used to separate DOTween class from the MonoBehaviour instance (in order to use static constructors on DOTween). Contains all instance-based methods

Used to allow method chaining with DOTween.Init

Directly sets the current max capacity of Tweeners and Sequences (meaning how many Tweeners and Sequences can be running at the same time), so that DOTween doesn't need to automatically increase them in case the max is reached (which might lead to hiccups when that happens). Sequences capacity must be less or equal to Tweeners capacity (if you pass a low Tweener capacity it will be automatically increased to match the Sequence's). Beware: use this method only when there are no tweens running.

Max Tweeners capacity. Default: 200 Max Sequences capacity. Default: 50

Used internally inside Unity Editor, as a trick to update DOTween's inspector at every frame

Max Tweeners capacity. Default: 200 Max Sequences capacity. Default: 50

Public so it can be used by lose scripts related to DOTween (like DOTweenAnimation)

Controls other tweens as a group

Indicates either a Tweener or a Sequence

Called the first time the tween is set in a playing state, after any eventual delay

TimeScale for the tween

If TRUE the tween wil go backwards

Id (usable for filtering with DOTween static methods). Can be an int, a string, an object, or anything else

Tween target (usable for filtering with DOTween static methods). Automatically set by tween creation shorcuts

Called when the tween is set in a playing state, after any eventual delay. Also called each time the tween resumes playing from a paused state

Called when the tween state changes from playing to paused. If the tween has autoKill set to FALSE, this is called also when the tween reaches completion.

Called when the tween is rewinded, either by calling Rewind or by reaching the start position while playing backwards. Rewinding a tween that is already rewinded will not fire this callback

Called each time the tween updates

Called the moment the tween completes one loop cycle

Called the moment the tween reaches completion (loops included)

Called the moment the tween is killed

Called when a path tween's current waypoint changes

Gets and sets the time position (loops included, delays excluded) of the tween

Rotation mode used with DORotate methods

Fastest way that never rotates beyond 360°

Fastest way that rotates beyond 360°

Adds the given rotation to the transform using world axis and an advanced precision mode (like when using transform.Rotate(Space.World)). In this mode the end value is is always considered relative

Adds the given rotation to the transform's local axis (like when rotating an object with the "local" switch enabled in Unity's editor or using transform.Rotate(Space.Self)). In this mode the end value is is always considered relative

This plugin generates some GC allocations at startup

Don't assign this! It's assigned automatically when creating 0 duration tweens

Don't assign this! It's assigned automatically when setting the ease to an AnimationCurve or to a custom ease function

Types of log behaviours

Log only warnings and errors

Log warnings, errors and additional infos

Log only errors

Methods that extend Tween objects and allow to set their parameters

Sets the autoKill behaviour of the tween. Has no effect if the tween has already started

If TRUE the tween will be automatically killed when complete

Sets an ID for the tween, which can then be used as a filter with DOTween's static methods.

The ID to assign to this tween. Can be an int, a string, an object or anything else.

The target to assign to this tween. Can be an int, a string, an object or anything else.

Sets the looping options for the tween. Has no effect if the tween has already started

Number of cycles to play (-1 for infinite - will be converted to 1 in case the tween is nested in a Sequence)

Sets the looping options for the tween. Has no effect if the tween has already started

Number of cycles to play (-1 for infinite - will be converted to 1 in case the tween is nested in a Sequence) Loop behaviour type (default: LoopType.Restart)

Sets the ease of the tween. If applied to Sequences eases the whole sequence animation

Eventual overshoot to use with Back ease (default is 1.70158)

Sets the ease of the tween. If applied to Sequences eases the whole sequence animation

Eventual amplitude to use with Elastic easeType (default is 1.70158) Eventual period to use with Elastic easeType (default is 0)

Sets the ease of the tween using an AnimationCurve. If applied to Sequences eases the whole sequence animation

Sets the ease of the tween using a custom ease function (which must return a value between 0 and 1). If applied to Sequences eases the whole sequence animation

Allows the tween to be recycled after being killed.

Sets the recycling behaviour for the tween.

If TRUE the tween will be recycled after being killed, otherwise it will be destroyed.

Sets the update type to UpdateType.Normal and lets you choose if it should be independent from Unity's Time.timeScale

If TRUE the tween will ignore Unity's Time.timeScale

Sets the type of update for the tween

The type of update (defalt: UpdateType.Normal)

Sets the type of update for the tween and lets you choose if it should be independent from Unity's Time.timeScale

The type of update If TRUE the tween will ignore Unity's Time.timeScale

Sets the onStart callback for the tween. Called the first time the tween is set in a playing state, after any eventual delay

Sets the onPlay callback for the tween. Called when the tween is set in a playing state, after any eventual delay. Also called each time the tween resumes playing from a paused state

Sets the onPlay callback for the tween. Called when the tween state changes from playing to paused. If the tween has autoKill set to FALSE, this is called also when the tween reaches completion.

Sets the onUpdate callback for the tween. Called each time the tween updates

Sets the onStepComplete callback for the tween. Called the moment the tween completes one loop cycle, even when going backwards

Sets the onComplete callback for the tween. Called the moment the tween reaches its final forward position, loops included

Sets the onKill callback for the tween. Called the moment the tween is killed

Sets the onWaypointChange callback for the tween. Called when a path tween's current waypoint changes

Sets the parameters of the tween (id, ease, loops, delay, timeScale, callbacks, etc) as the parameters of the given one. Doesn't copy specific SetOptions settings: those will need to be applied manually each time. Has no effect if the tween has already started. NOTE: the tween's target will not be changed

Tween from which to copy the parameters

Sets the parameters of the tween (id, ease, loops, delay, timeScale, callbacks, etc) as the parameters of the given TweenParams. Has no effect if the tween has already started.

TweenParams from which to copy the parameters

Adds the given tween to the end of the Sequence. Has no effect if the Sequence has already started

The tween to append

Adds the given tween to the beginning of the Sequence, pushing forward the other nested content. Has no effect if the Sequence has already started

The tween to prepend

Inserts the given tween at the same time position of the last tween added to the Sequence. Has no effect if the Sequence has already started

Inserts the given tween at the given time position in the Sequence, automatically adding an interval if needed. Has no effect if the Sequence has already started

The time position where the tween will be placed The tween to insert

Adds the given interval to the end of the Sequence. Has no effect if the Sequence has already started

The interval duration

Adds the given interval to the beginning of the Sequence, pushing forward the other nested content. Has no effect if the Sequence has already started

The interval duration

Adds the given callback to the end of the Sequence. Has no effect if the Sequence has already started

The callback to append

Adds the given callback to the beginning of the Sequence, pushing forward the other nested content. Has no effect if the Sequence has already started

The callback to prepend

Inserts the given callback at the given time position in the Sequence, automatically adding an interval if needed. Has no effect if the Sequence has already started

The time position where the callback will be placed The callback to insert

Changes a TO tween into a FROM tween: sets the current target's position as the tween's endValue then immediately sends the target to the previously set endValue.

If TRUE the FROM value will be calculated as relative to the current one

Sets a delayed startup for the tween. Has no effect on Sequences or if the tween has already started

Sets the tween as relative (the endValue will be calculated as startValue + endValue instead than being used directly). Has no effect on Sequences or if the tween has already started

Options for float tweens

If TRUE the tween will smoothly snap all values to integers

Options for Vector2 tweens

If TRUE the tween will smoothly snap all values to integers

Options for Vector2 tweens

Selecting an axis will tween the vector only on that axis, leaving the others untouched If TRUE the tween will smoothly snap all values to integers

Options for Vector3 tweens

If TRUE the tween will smoothly snap all values to integers

Options for Vector3 tweens

Selecting an axis will tween the vector only on that axis, leaving the others untouched If TRUE the tween will smoothly snap all values to integers

Options for Vector4 tweens

If TRUE the tween will smoothly snap all values to integers

Options for Vector4 tweens

Selecting an axis will tween the vector only on that axis, leaving the others untouched If TRUE the tween will smoothly snap all values to integers

Options for Quaternion tweens

If TRUE (default) the rotation will take the shortest route, and will not rotate more than 360°. If FALSE the rotation will be fully accounted. Is always FALSE if the tween is set as relative

Options for Color tweens

If TRUE only the alpha value of the color will be tweened

Options for Vector4 tweens

If TRUE the tween will smoothly snap all values to integers

Options for Vector4 tweens

If TRUE, rich text will be interpreted correctly while animated, otherwise all tags will be considered as normal text The type of scramble to use, if any A string containing the characters to use for scrambling. Use as many characters as possible (minimum 10) because DOTween uses a fast scramble mode which gives better results with more characters. Leave it to NULL to use default ones

Options for Vector3Array tweens

If TRUE the tween will smoothly snap all values to integers

Options for Vector3Array tweens

If TRUE the tween will smoothly snap all values to integers

Options for Path tweens (created via the DOPath shortcut)

The eventual movement axis to lock. You can input multiple axis if you separate them like this: AxisConstrain.X | AxisConstraint.Y The eventual rotation axis to lock. You can input multiple axis if you separate them like this: AxisConstrain.X | AxisConstraint.Y

Options for Path tweens (created via the DOPath shortcut)

If TRUE the path will be automatically closed The eventual movement axis to lock. You can input multiple axis if you separate them like this: AxisConstrain.X | AxisConstraint.Y The eventual rotation axis to lock. You can input multiple axis if you separate them like this: AxisConstrain.X | AxisConstraint.Y

Additional LookAt options for Path tweens (created via the DOPath shortcut). Orients the target towards the given position. Must be chained directly to the tween creation method or to a SetOptions

The position to look at The eventual direction to consider as "forward". If left to NULL defaults to the regular forward side of the transform The vector that defines in which direction up is (default: Vector3.up)

Additional LookAt options for Path tweens (created via the DOPath shortcut). Orients the target towards another transform. Must be chained directly to the tween creation method or to a SetOptions

The transform to look at The eventual direction to consider as "forward". If left to NULL defaults to the regular forward side of the transform The vector that defines in which direction up is (default: Vector3.up)

Additional LookAt options for Path tweens (created via the DOPath shortcut). Orients the target to the path, with the given lookAhead. Must be chained directly to the tween creation method or to a SetOptions

The percentage of lookAhead to use (0 to 1) The eventual direction to consider as "forward". If left to NULL defaults to the regular forward side of the transform The vector that defines in which direction up is (default: Vector3.up)

Methods that extend Tween objects and allow to control or get data from them

Completes the tween

Flips the direction of this tween (backwards if it was going forward or viceversa)

Forces the tween to initialize its settings immediately

Send the tween to the given position in time

Time position to reach (if higher than the whole tween duration the tween will simply reach its end) If TRUE will play the tween after reaching the given position, otherwise it will pause it

Kills the tween

If TRUE completes the tween before killing it

Pauses the tween

Plays the tween

Sets the tween in a backwards direction and plays it

Sets the tween in a forward direction and plays it

Restarts the tween from the beginning

If TRUE includes the eventual tween delay, otherwise skips it

Rewinds the tween

If TRUE includes the eventual tween delay, otherwise skips it

Plays the tween if it was paused, pauses it if it was playing

Send a path tween to the given waypoint. Has no effect if this is not a path tween. BEWARE, this is a special utility method: it works only with Linear eases. Also, the lookAt direction might be wrong after calling this and might need to be set manually (because it relies on a smooth path movement and doesn't work well with jumps that encompass dramatic direction changes)

Waypoint index to reach (if higher than the max waypoint index the tween will simply go to the last one) If TRUE will play the tween after reaching the given waypoint, otherwise it will pause it

Creates a yield instruction that waits until the tween is killed or complete. It can be used inside a coroutine as a yield. Example usage:yield return myTween.WaitForCompletion();

Creates a yield instruction that waits until the tween is killed or rewinded. It can be used inside a coroutine as a yield. Example usage:yield return myTween.WaitForRewind();

Creates a yield instruction that waits until the tween is killed. It can be used inside a coroutine as a yield. Example usage:yield return myTween.WaitForKill();

Creates a yield instruction that waits until the tween is killed or has gone through the given amount of loops. It can be used inside a coroutine as a yield. Example usage:yield return myTween.WaitForElapsedLoops(2);

Elapsed loops to wait for

Creates a yield instruction that waits until the tween is killed or has reached the given position (loops included, delays excluded). It can be used inside a coroutine as a yield. Example usage:yield return myTween.WaitForPosition(2.5f);

Position (loops included, delays excluded) to wait for

Creates a yield instruction that waits until the tween is killed or started (meaning when the tween is set in a playing state the first time, after any eventual delay). It can be used inside a coroutine as a yield. Example usage:yield return myTween.WaitForStart();

Returns the total number of loops completed by this tween

Returns the eventual delay set for this tween

Returns the duration of this tween (delays excluded). NOTE: when using settings like SpeedBased, the duration will be recalculated when the tween starts

If TRUE returns the full duration loops included, otherwise the duration of a single loop cycle

Returns the elapsed time for this tween (delays exluded)

If TRUE returns the elapsed time since startup loops included, otherwise the elapsed time within the current loop cycle

Returns the elapsed percentage (0 to 1) of this tween (delays exluded)

If TRUE returns the elapsed percentage since startup loops included, otherwise the elapsed percentage within the current loop cycle

Returns the elapsed percentage (0 to 1) of this tween (delays exluded), based on a single loop, and calculating eventual backwards Yoyo loops as 1 to 0 instead of 0 to 1

Returns FALSE if this tween has been killed. BEWARE: if this tween is recyclable it might have been spawned again for another use and thus return TRUE anyway. When working with recyclable tweens you should take care to know when a tween has been killed and manually set your references to NULL. If you want to be sure your references are set to NULL when a tween is killed you can use the OnKill callback like this: .OnKill(()=> myTweenReference = null)

Returns TRUE if this tween was reversed and is set to go backwards

Returns TRUE if the tween is complete (silently fails and returns FALSE if the tween has been killed)

Returns TRUE if this tween has been initialized

Returns TRUE if this tween is playing

Returns a point on a path based on the given path percentage (returns Vector3.zero if this is not a path tween, if the tween is invalid, or if the path is not yet initialized) A path is initialized after its tween starts, or immediately if the tween was created with the Path Editor (DOTween Pro feature). You can force a path to be initialized by calling myTween.ForceInit().

Percentage of the path (0 to 1) on which to get the point

Returns the length of a path (returns -1 if this is not a path tween, if the tween is invalid, or if the path is not yet initialized). A path is initialized after its tween starts, or immediately if the tween was created with the Path Editor (DOTween Pro feature). You can force a path to be initialized by calling myTween.ForceInit().

Used for tween callbacks

Used for custom and animationCurve-based ease functions. Must return a value between 0 and 1.

Used in place of System.Func, which is not available in mscorlib.

Used in place of System.Action.

Types of autoPlay behaviours

No tween is automatically played

Only Sequences are automatically played

Only Tweeners are automatically played

All tweens are automatically played

Methods that extend known Unity objects and allow to directly create and control tweens from their instances

Tweens an AudioSource's volume to the given value. Also stores the AudioSource as the tween's target so it can be used for filtered operations

The end value to reach (0 to 1)The duration of the tween

Tweens an AudioSource's pitch to the given value. Also stores the AudioSource as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Camera's aspect to the given value. Also stores the camera as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Camera's backgroundColor to the given value. Also stores the camera as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Camera's farClipPlane to the given value. Also stores the camera as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Camera's fieldOfView to the given value. Also stores the camera as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Camera's nearClipPlane to the given value. Also stores the camera as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Camera's orthographicSize to the given value. Also stores the camera as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Camera's pixelRect to the given value. Also stores the camera as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Camera's rect to the given value. Also stores the camera as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Shakes a Camera's localPosition along its relative X Y axes with the given values. Also stores the camera as the tween's target so it can be used for filtered operations

The duration of the tween The shake strength Indicates how much will the shake vibrate Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware). Setting it to 0 will shake along a single direction.

Shakes a Camera's localPosition along its relative X Y axes with the given values. Also stores the camera as the tween's target so it can be used for filtered operations

The duration of the tween The shake strength on each axis Indicates how much will the shake vibrate Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware). Setting it to 0 will shake along a single direction.

Shakes a Camera's localRotation. Also stores the camera as the tween's target so it can be used for filtered operations

Tweens a Light's color to the given value. Also stores the light as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Light's intensity to the given value. Also stores the light as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Light's shadowStrength to the given value. Also stores the light as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a LineRenderer's color to the given value. Also stores the LineRenderer as the tween's target so it can be used for filtered operations. Note that this method requires to also insert the start colors for the tween, since LineRenderers have no way to get them.

The start value to tween from The end value to reachThe duration of the tween

Tweens a Material's color to the given value. Also stores the material as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Material's named color property to the given value. Also stores the material as the tween's target so it can be used for filtered operations

The end value to reach The name of the material property to tween (like _Tint or _SpecColor) The duration of the tween

Tweens a Material's alpha color to the given value (will have no effect unless your material supports transparency). Also stores the material as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

The end value to reach The name of the material property to tween (like _Tint or _SpecColor) The duration of the tween

Tweens a Material's named float property to the given value. Also stores the material as the tween's target so it can be used for filtered operations

The end value to reach The name of the material property to tween The duration of the tween

Tweens a Material's texture offset to the given value. Also stores the material as the tween's target so it can be used for filtered operations

The end value to reach The duration of the tween

Tweens a Material's named texture offset property to the given value. Also stores the material as the tween's target so it can be used for filtered operations

The end value to reach The name of the material property to tween The duration of the tween

Tweens a Material's texture scale to the given value. Also stores the material as the tween's target so it can be used for filtered operations

The end value to reach The duration of the tween

Tweens a Material's named texture scale property to the given value. Also stores the material as the tween's target so it can be used for filtered operations

The end value to reach The name of the material property to tween The duration of the tween

Tweens a Material's named Vector property to the given value. Also stores the material as the tween's target so it can be used for filtered operations

The end value to reach The name of the material property to tween The duration of the tween

Tweens a Rigidbody's position to the given value. Also stores the rigidbody as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween If TRUE the tween will smoothly snap all values to integers

Tweens a Rigidbody's X position to the given value. Also stores the rigidbody as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween If TRUE the tween will smoothly snap all values to integers

Tweens a Rigidbody's Y position to the given value. Also stores the rigidbody as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween If TRUE the tween will smoothly snap all values to integers

Tweens a Rigidbody's Z position to the given value. Also stores the rigidbody as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween If TRUE the tween will smoothly snap all values to integers

Tweens a Rigidbody's rotation to the given value. Also stores the rigidbody as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween Rotation mode

Tweens a Rigidbody's rotation so that it will look towards the given position. Also stores the rigidbody as the tween's target so it can be used for filtered operations

The position to look atThe duration of the tween Eventual axis constraint for the rotation The vector that defines in which direction up is (default: Vector3.up)

Tweens a Rigidbody's position to the given value, while also applying a jump effect along the Y axis. Returns a Sequence instead of a Tweener. Also stores the Rigidbody as the tween's target so it can be used for filtered operations

The end value to reach Power of the jump (the max height of the jump is represented by this plus the final Y offset) Total number of jumps The duration of the tween If TRUE the tween will smoothly snap all values to integers

Tweens a TrailRenderer's startWidth/endWidth to the given value. Also stores the TrailRenderer as the tween's target so it can be used for filtered operations

The end startWidth to reachThe end endWidth to reach The duration of the tween

Tweens a TrailRenderer's time to the given value. Also stores the TrailRenderer as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Transform's position to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween If TRUE the tween will smoothly snap all values to integers

Tweens a Transform's X position to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween If TRUE the tween will smoothly snap all values to integers

Tweens a Transform's Y position to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween If TRUE the tween will smoothly snap all values to integers

Tweens a Transform's Z position to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween If TRUE the tween will smoothly snap all values to integers

Tweens a Transform's localPosition to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween If TRUE the tween will smoothly snap all values to integers

Tweens a Transform's X localPosition to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween If TRUE the tween will smoothly snap all values to integers

Tweens a Transform's Y localPosition to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween If TRUE the tween will smoothly snap all values to integers

Tweens a Transform's Z localPosition to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween If TRUE the tween will smoothly snap all values to integers

Tweens a Transform's rotation to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween Rotation mode

Tweens a Transform's localRotation to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween Rotation mode

Tweens a Transform's localScale to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Transform's localScale uniformly to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Transform's X localScale to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Transform's Y localScale to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Transform's Z localScale to the given value. Also stores the transform as the tween's target so it can be used for filtered operations

The end value to reachThe duration of the tween

Tweens a Transform's rotation so that it will look towards the given position. Also stores the transform as the tween's target so it can be used for filtered operations

The position to look atThe duration of the tween Eventual axis constraint for the rotation The vector that defines in which direction up is (default: Vector3.up)

Punches a Transform's localPosition towards the given direction and then back to the starting one as if it was connected to the starting position via an elastic.

The direction and strength of the punch (added to the Transform's current position) The duration of the tween Indicates how much will the punch vibrate Represents how much (0 to 1) the vector will go beyond the starting position when bouncing backwards. 1 creates a full oscillation between the punch direction and the opposite direction, while 0 oscillates only between the punch and the start position If TRUE the tween will smoothly snap all values to integers

Punches a Transform's localScale towards the given size and then back to the starting one as if it was connected to the starting scale via an elastic.

The punch strength (added to the Transform's current scale) The duration of the tween Indicates how much will the punch vibrate Represents how much (0 to 1) the vector will go beyond the starting size when bouncing backwards. 1 creates a full oscillation between the punch scale and the opposite scale, while 0 oscillates only between the punch scale and the start scale

Punches a Transform's localRotation towards the given size and then back to the starting one as if it was connected to the starting rotation via an elastic.

The punch strength (added to the Transform's current rotation) The duration of the tween Indicates how much will the punch vibrate Represents how much (0 to 1) the vector will go beyond the starting rotation when bouncing backwards. 1 creates a full oscillation between the punch rotation and the opposite rotation, while 0 oscillates only between the punch and the start rotation

Shakes a Transform's localPosition with the given values.

Shakes a Transform's localRotation.

Shakes a Transform's localScale.

Tweens a Transform's position to the given value, while also applying a jump effect along the Y axis. Returns a Sequence instead of a Tweener. Also stores the transform as the tween's target so it can be used for filtered operations

Tweens a Transform's localPosition to the given value, while also applying a jump effect along the Y axis. Returns a Sequence instead of a Tweener. Also stores the transform as the tween's target so it can be used for filtered operations

Tweens a Transform's position through the given path waypoints, using the chosen path algorithm. Also stores the transform as the tween's target so it can be used for filtered operations

The waypoints to go through The duration of the tween The type of path: Linear (straight path) or CatmullRom (curved CatmullRom path) The path mode: 3D, side-scroller 2D, top-down 2D The resolution of the path (useless in case of Linear paths): higher resolutions make for more detailed curved paths but are more expensive. Defaults to 10, but a value of 5 is usually enough if you don't have dramatic long curves between waypoints The color of the path (shown when gizmos are active in the Play panel and the tween is running)

Tweens a Transform's localPosition through the given path waypoints, using the chosen path algorithm. Also stores the transform as the tween's target so it can be used for filtered operations

The waypoint to go through The duration of the tween The type of path: Linear (straight path) or CatmullRom (curved CatmullRom path) The path mode: 3D, side-scroller 2D, top-down 2D The resolution of the path: higher resolutions make for more detailed curved paths but are more expensive. Defaults to 10, but a value of 5 is usually enough if you don't have dramatic long curves between waypoints The color of the path (shown when gizmos are active in the Play panel and the tween is running)

Tweens a Light's color to the given value, in a way that allows other DOBlendableColor tweens to work together on the same target, instead than fight each other as multiple DOColor would do. Also stores the Light as the tween's target so it can be used for filtered operations

The value to tween toThe duration of the tween

Tweens a Material's color to the given value, in a way that allows other DOBlendableColor tweens to work together on the same target, instead than fight each other as multiple DOColor would do. Also stores the Material as the tween's target so it can be used for filtered operations

The value to tween toThe duration of the tween

Tweens a Material's named color property to the given value, in a way that allows other DOBlendableColor tweens to work together on the same target, instead than fight each other as multiple DOColor would do. Also stores the Material as the tween's target so it can be used for filtered operations

The value to tween to The name of the material property to tween (like _Tint or _SpecColor) The duration of the tween

Tweens a Transform's position BY the given value (as if you chained a SetRelative), in a way that allows other DOBlendableMove tweens to work together on the same target, instead than fight each other as multiple DOMove would do. Also stores the transform as the tween's target so it can be used for filtered operations

The value to tween byThe duration of the tween If TRUE the tween will smoothly snap all values to integers

Tweens a Transform's localPosition BY the given value (as if you chained a SetRelative), in a way that allows other DOBlendableMove tweens to work together on the same target, instead than fight each other as multiple DOMove would do. Also stores the transform as the tween's target so it can be used for filtered operations

The value to tween byThe duration of the tween If TRUE the tween will smoothly snap all values to integers

EXPERIMENTAL METHOD - Tweens a Transform's rotation BY the given value (as if you chained a SetRelative), in a way that allows other DOBlendableRotate tweens to work together on the same target, instead than fight each other as multiple DORotate would do. Also stores the transform as the tween's target so it can be used for filtered operations

The value to tween byThe duration of the tween Rotation mode

EXPERIMENTAL METHOD - Tweens a Transform's lcoalRotation BY the given value (as if you chained a SetRelative), in a way that allows other DOBlendableRotate tweens to work together on the same target, instead than fight each other as multiple DORotate would do. Also stores the transform as the tween's target so it can be used for filtered operations

The value to tween byThe duration of the tween Rotation mode

Tweens a Transform's localScale BY the given value (as if you chained a SetRelative), in a way that allows other DOBlendableScale tweens to work together on the same target, instead than fight each other as multiple DOScale would do. Also stores the transform as the tween's target so it can be used for filtered operations

The value to tween byThe duration of the tween

Completes all tweens that have this target as a reference (meaning tweens that were started from this target, or that had this target added as an Id) and returns the total number of tweens completed (meaning the tweens that don't have infinite loops and were not already complete)

Kills all tweens that have this target as a reference (meaning tweens that were started from this target, or that had this target added as an Id) and returns the total number of tweens killed.

If TRUE completes the tween before killing it

Flips the direction (backwards if it was going forward or viceversa) of all tweens that have this target as a reference (meaning tweens that were started from this target, or that had this target added as an Id) and returns the total number of tweens flipped.

Sends to the given position all tweens that have this target as a reference (meaning tweens that were started from this target, or that had this target added as an Id) and returns the total number of tweens involved.

Time position to reach (if higher than the whole tween duration the tween will simply reach its end) If TRUE will play the tween after reaching the given position, otherwise it will pause it

Pauses all tweens that have this target as a reference (meaning tweens that were started from this target, or that had this target added as an Id) and returns the total number of tweens paused.

Plays all tweens that have this target as a reference (meaning tweens that were started from this target, or that had this target added as an Id) and returns the total number of tweens played.

Plays backwards all tweens that have this target as a reference (meaning tweens that were started from this target, or that had this target added as an Id) and returns the total number of tweens played.

Plays forward all tweens that have this target as a reference (meaning tweens that were started from this target, or that had this target added as an Id) and returns the total number of tweens played.

Restarts all tweens that have this target as a reference (meaning tweens that were started from this target, or that had this target added as an Id) and returns the total number of tweens restarted.

Rewinds all tweens that have this target as a reference (meaning tweens that were started from this target, or that had this target added as an Id) and returns the total number of tweens rewinded.

Toggles the paused state (plays if it was paused, pauses if it was playing) of all tweens that have this target as a reference (meaning tweens that were started from this target, or that had this target added as an Id) and returns the total number of tweens involved.

Type of path to use with DOPath tweens

Linear, composed of straight segments between each waypoint

Curved path (which uses Catmull-Rom curves)

Main DOTween class. Contains static methods to create and control tweens in a generic way

DOTween's version

If TRUE (default) makes tweens slightly slower but safer, automatically taking care of a series of things (like targets becoming null while a tween is playing). Default: TRUE

If TRUE you will get a DOTween report when exiting play mode (only in the Editor). Useful to know how many max Tweeners and Sequences you reached and optimize your final project accordingly. Beware, this will slightly slow down your tweens while inside Unity Editor. Default: FALSE

Global DOTween timeScale. Default: 1

If TRUE draws path gizmos in Unity Editor (if the gizmos button is active). Deactivate this if you want to avoid gizmos overhead while in Unity Editor

Default updateType for new tweens. Default: UpdateType.Normal

Sets whether Unity's timeScale should be taken into account by default or not. Default: false

Default autoPlay behaviour for new tweens. Default: AutoPlay.All

Default autoKillOnComplete behaviour for new tweens. Default: TRUE

Default loopType applied to all new tweens. Default: LoopType.Restart

If TRUE all newly created tweens are set as recyclable, otherwise not. Default: FALSE

Default ease applied to all new Tweeners (not to Sequences which always have Ease.Linear as default). Default: Ease.InOutQuad

Default overshoot/amplitude used for eases Default: 1.70158f

Default period used for eases Default: 0

Must be called once, before the first ever DOTween call/reference, otherwise it will be called automatically and will use default options. Calling it a second time won't have any effect. You can chain SetCapacity to this method, to directly set the max starting size of Tweeners and Sequences: DOTween.Init(false, false, LogBehaviour.Default).SetCapacity(100, 20);

If TRUE all new tweens will be set for recycling, meaning that when killed, instead of being destroyed, they will be put in a pool and reused instead of creating new tweens. This option allows you to avoid GC allocations by reusing tweens, but you will have to take care of tween references, since they might result active even if they were killed (since they might have been respawned and are now being used for other tweens). If you want to automatically set your tween references to NULL when a tween is killed you can use the OnKill callback like this: .OnKill(()=> myTweenReference = null) You can change this setting at any time by changing the static property, or you can set the recycling behaviour for each tween separately, using: SetRecyclable(bool recyclable) Default: FALSE If TRUE makes tweens slightly slower but safer, automatically taking care of a series of things (like targets becoming null while a tween is playing). You can change this setting at any time by changing the static property. Default: FALSE Type of logging to use. You can change this setting at any time by changing the static property. Default: ErrorsOnly

Max Tweeners capacity. Default: 200 Max Sequences capacity. Default: 50

Kills all tweens, clears all cached tween pools and plugins and resets the max Tweeners/Sequences capacities to the default values.

If TRUE also destroys DOTween's gameObject and resets its initializiation, default settings and everything else (so that next time you use it it will need to be re-initialized)

Clears all cached tween pools.

Checks all active tweens to find and remove eventually invalid ones (usually because their targets became NULL) and returns the total number of invalid tweens found and removed. Automatically called when loading a new scene if is TRUE. BEWARE: this is a slightly expensive operation so use it with care

Tweens a property or field to the given value using default plugins

Tweens a property or field to the given value using a custom plugin

The plugin to use. Each custom plugin implements a static Get() method you'll need to call to assign the correct plugin in the correct way, like this: CustomPlugin.Get() A getter for the field or property to tween. Example usage with lambda:()=> myProperty A setter for the field or property to tween Example usage with lambda:x=> myProperty = x The end value to reachThe tween's duration

Tweens only one axis of a Vector3 to the given value using default plugins.

Tweens only the alpha of a Color to the given value using default plugins

Tweens a virtual property from the given start to the given end value and implements a setter that allows to use that value with an external method or a lambda Example: To(MyMethod, 0, 12, 0.5f); Where MyMethod is a function that accepts a float parameter (which will be the result of the virtual tween)

The action to perform with the tweened value The value to start from The end value to reach The duration of the virtual tween

Punches a Vector3 towards the given direction and then back to the starting one as if it was connected to the starting position via an elastic. This tween type generates some GC allocations at startup

A getter for the field or property to tween. Example usage with lambda:()=> myProperty A setter for the field or property to tween Example usage with lambda:x=> myProperty = x The direction and strength of the punch The duration of the tween Indicates how much will the punch vibrate Represents how much (0 to 1) the vector will go beyond the starting position when bouncing backwards. 1 creates a full oscillation between the direction and the opposite decaying direction, while 0 oscillates only between the starting position and the decaying direction

Shakes a Vector3 with the given values.

A getter for the field or property to tween. Example usage with lambda:()=> myProperty A setter for the field or property to tween Example usage with lambda:x=> myProperty = x The duration of the tween The shake strength Indicates how much will the shake vibrate Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware). Setting it to 0 will shake along a single direction and behave like a random punch. If TRUE only shakes on the X Y axis (looks better with things like cameras).

Shakes a Vector3 with the given values.

A getter for the field or property to tween. Example usage with lambda:()=> myProperty A setter for the field or property to tween Example usage with lambda:x=> myProperty = x The duration of the tween The shake strength on each axis Indicates how much will the shake vibrate Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware). Setting it to 0 will shake along a single direction and behave like a random punch.

Tweens a property or field to the given values using default plugins. Ease is applied between each segment and not as a whole. This tween type generates some GC allocations at startup

A getter for the field or property to tween. Example usage with lambda:()=> myProperty A setter for the field or property to tween Example usage with lambda:x=> myProperty = x The end values to reach for each segment. This array must have the same length as durations The duration of each segment. This array must have the same length as endValues

Returns a new to be used for tween groups

Completes all tweens and returns the number of actual tweens completed (meaning tweens that don't have infinite loops and were not already complete)

Completes all tweens with the given ID or target and returns the number of actual tweens completed (meaning the tweens that don't have infinite loops and were not already complete)

Flips all tweens (changing their direction to forward if it was backwards and viceversa), then returns the number of actual tweens flipped

Flips the tweens with the given ID or target (changing their direction to forward if it was backwards and viceversa), then returns the number of actual tweens flipped

Sends all tweens to the given position (calculating also eventual loop cycles) and returns the actual tweens involved

Sends all tweens with the given ID or target to the given position (calculating also eventual loop cycles) and returns the actual tweens involved

Kills all tweens and returns the number of actual tweens killed

If TRUE completes the tweens before killing them

Kills all tweens with the given ID or target and returns the number of actual tweens killed

If TRUE completes the tweens before killing them

Pauses all tweens and returns the number of actual tweens paused

Pauses all tweens with the given ID or target and returns the number of actual tweens paused (meaning the tweens that were actually playing and have been paused)

Plays all tweens and returns the number of actual tweens played (meaning tweens that were not already playing or complete)

Plays all tweens with the given ID or target and returns the number of actual tweens played (meaning the tweens that were not already playing or complete)

Plays all tweens with the given target and the given ID, and returns the number of actual tweens played (meaning the tweens that were not already playing or complete)

Plays backwards all tweens and returns the number of actual tweens played (meaning tweens that were not already started, playing backwards or rewinded)

Plays backwards all tweens with the given ID or target and returns the number of actual tweens played (meaning the tweens that were not already started, playing backwards or rewinded)

Plays forward all tweens and returns the number of actual tweens played (meaning tweens that were not already playing forward or complete)

Plays forward all tweens with the given ID or target and returns the number of actual tweens played (meaning the tweens that were not already playing forward or complete)

Restarts all tweens, then returns the number of actual tweens restarted

Restarts all tweens with the given ID or target, then returns the number of actual tweens restarted

Restarts all tweens with the given target and the given ID, and returns the number of actual tweens played (meaning the tweens that were not already playing or complete)

Rewinds and pauses all tweens, then returns the number of actual tweens rewinded (meaning tweens that were not already rewinded)

Rewinds and pauses all tweens with the given ID or target, then returns the number of actual tweens rewinded (meaning the tweens that were not already rewinded)

Toggles the play state of all tweens and returns the number of actual tweens toggled (meaning tweens that could be played or paused, depending on the toggle state)

Toggles the play state of all tweens with the given ID or target and returns the number of actual tweens toggled (meaning the tweens that could be played or paused, depending on the toggle state)

Returns TRUE if a tween with the given ID or target is active (regardless if it's playing or not). You can also use this to know if a shortcut tween is active for a given target. Example: transform.DOMoveX(45, 1); // transform is automatically added as the tween target DOTween.IsTweening(transform); // Returns true

Returns the total number of active and playing tweens. A tween is considered as playing even if its delay is actually playing

Returns a list of all active tweens in a playing state. Returns NULL if there are no active playing tweens. Beware: each time you call this method a new list is generated, so use it for debug only

Returns a list of all active tweens in a paused state. Returns NULL if there are no active paused tweens. Beware: each time you call this method a new list is generated, so use it for debug only

Returns a list of all active tweens with the given id. Returns NULL if there are no active tweens with the given id. Beware: each time you call this method a new list is generated If TRUE returns only the tweens with the given ID that are currently playing

Returns a list of all active tweens with the given target. Returns NULL if there are no active tweens with the given target. Beware: each time you call this method a new list is generated If TRUE returns only the tweens with the given target that are currently playing

DOTween's log behaviour. Default: LogBehaviour.ErrorsOnly

Path plugin works exclusively with Transforms

Allows to wrap ease method in special ways, adding extra features

Converts the given ease so that it also creates a stop-motion effect, by playing the tween at the given FPS

FPS at which the tween should be played Ease type

Converts the given ease so that it also creates a stop-motion effect, by playing the tween at the given FPS

FPS at which the tween should be played AnimationCurve to use for the ease

Converts the given ease so that it also creates a stop-motion effect, by playing the tween at the given FPS

FPS at which the tween should be played Custom ease function to use

Types of loop

Each loop cycle restarts from the beginning

The tween moves forward and backwards at alternate cycles

Continuously increments the tween at the end of each loop cycle (A to B, B to B+(A-B), and so on), thus always moving "onward". In case of String tweens works only if the tween is set as relative

Animates a single value

Changes the start value of a tween and rewinds it (without pausing it). Has no effect with tweens that are inside Sequences

The new start value If bigger than 0 applies it as the new tween duration

Changes the end value of a tween and rewinds it (without pausing it). Has no effect with tweens that are inside Sequences

The new end value If bigger than 0 applies it as the new tween duration If TRUE the start value will become the current target's value, otherwise it will stay the same

Changes the end value of a tween and rewinds it (without pausing it). Has no effect with tweens that are inside Sequences

The new end value If TRUE the start value will become the current target's value, otherwise it will stay the same

Changes the start and end value of a tween and rewinds it (without pausing it). Has no effect with tweens that are inside Sequences

The new start value The new end value If bigger than 0 applies it as the new tween duration

Creates virtual tweens that can be used to change other elements via their OnUpdate calls

Tweens a virtual float. You can add regular settings to the generated tween, but do not use SetUpdate or you will overwrite the onVirtualUpdate parameter

The value to start from The value to tween to The duration of the tween A callback which must accept a parameter of type float, called at each update

Returns a value based on the given ease and lifetime percentage (0 to 1)

The value to start from when lifetimePercentage is 0 The value to reach when lifetimePercentage is 1 The time percentage (0 to 1) at which the value should be taken The type of ease

Returns a value based on the given ease and lifetime percentage (0 to 1)

The value to start from when lifetimePercentage is 0 The value to reach when lifetimePercentage is 1 The time percentage (0 to 1) at which the value should be taken The type of ease Eventual overshoot to use with Back ease

Returns a value based on the given ease and lifetime percentage (0 to 1)

The value to start from when lifetimePercentage is 0 The value to reach when lifetimePercentage is 1 The time percentage (0 to 1) at which the value should be taken The AnimationCurve to use for ease

Fires the given callback after the given time.

Callback delay Callback to fire when the delay has expired If TRUE (default) ignores Unity's timeScale

Used to interpret AnimationCurves as eases. Public so it can be used by external ease factories

This class contains a C# port of the easing equations created by Robert Penner (http://robertpenner.com/easing).

Easing equation function for a bounce (exponentially decaying parabolic bounce) easing in: accelerating from zero velocity.

Current time (in frames or seconds). Expected easing duration (in frames or seconds). Unused: here to keep same delegate for all ease types. Unused: here to keep same delegate for all ease types. The eased value.

Easing equation function for a bounce (exponentially decaying parabolic bounce) easing out: decelerating from zero velocity.

Easing equation function for a bounce (exponentially decaying parabolic bounce) easing in/out: acceleration until halfway, then deceleration.

Struct that stores two colors (used for LineRenderer tweens)

What axis to constrain in case of Vector tweens

Type of scramble to apply to string tweens

No scrambling of characters

A-Z + a-z + 0-9 characters

A-Z characters

a-z characters

0-9 characters

Custom characters

Path control point

Returns a value between 0 and 1 (inclusive) based on the elapsed time and ease selected

Returns a Vector3 with z = 0

Returns the 2D angle between two vectors

Gets the point on the path at the given percentage (0 to 1)

The percentage (0 to 1) at which to get the point If TRUE constant speed is taken into account, otherwise not

Public only so custom shortcuts can access some of these methods

Additional notices passed to plugins when updating. Public so it can be used by custom plugins. Internally, only PathPlugin uses it

None

Lets the plugin know that we restarted or rewinded