![readme splash](https://raw.githubusercontent.com/jeffreylanters/unity-tweens/master/.github/WIKI/repository-readme-splash.png) [![openupm](https://camo.githubusercontent.com/81b8eb1f4015e138ac6876d6bb998ba03bf276602993bd6eb38a4402562c8bb2/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f6e6c2e656c726163636f6f6e652e747765656e733f6c6162656c3d55504d2672656769737472795f7572693d68747470733a2f2f7061636b6167652e6f70656e75706d2e636f6d267374796c653d666f722d7468652d626164676526636f6c6f723d323332633337)](https://openupm.com/packages/nl.elraccoone.tweens/) [![size](https://camo.githubusercontent.com/22b32c1f1a27175dce0dd96aca6baf4ad51235a5e8bd03e22ecdaef999d0476c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f6a6566667265796c616e746572732f756e6974792d747765656e733f7374796c653d666f722d7468652d6261646765)](https://github.com/jeffreylanters/unity-tweens/raw/master/Runtime) [![sponsors](https://camo.githubusercontent.com/1c622449236b0648fc28fd8470e8dbcc0fa46ba241167ad2026b0f3795c518f2/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73706f6e736f72732f6a6566667265796c616e746572733f636f6c6f723d453132433941267374796c653d666f722d7468652d6261646765)](https://github.com/sponsors/jeffreylanters) [![donate](https://camo.githubusercontent.com/4378de8a503fb63b99f6aed8864dd8ccee00454d699fb5476ceb06f883e3666d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f646f6e6174652d70617970616c2d4632333135303f7374796c653d666f722d7468652d6261646765)](https://paypal.me/jeffreylanters) An extremely light weight, extendable and customisable tweening engine made for strictly typed script-based animations for user-interfaces and world-space objects optimised for all platforms. [**Installation**](https://github.com/jeffreylanters/unity-tweens/raw/master/#installation) · [**Documentation**](https://github.com/jeffreylanters/unity-tweens/raw/master/#documentation) · [**License**](https://github.com/jeffreylanters/unity-tweens/blob/master/LICENSE.md) **Made with ♥ by Jeffrey Lanters**

# Installation ### Using the Unity Package Manager Install the latest stable release using the Unity Package Manager by adding the following line to your `manifest.json` file located within your project's Packages directory, or by adding the Git URL to the Package Manager Window inside of Unity. ```json "nl.elraccoone.tweens": "git+https://github.com/jeffreylanters/unity-tweens" ``` ### Using OpenUPM The module is availble on the OpenUPM package registry, you can install the latest stable release using the OpenUPM Package manager's Command Line Tool using the following command. ```sh openupm add nl.elraccoone.tweens ``` # Documentation This module is benchmarked against LeanTween and ITween and beats both in Unity 2020.1 with running 1000 complex tweens simulataniously. The power and speed you expect get other tweening engines, with strictly typed, clean and ease-to-use chainable methods for all use cases. - [Getting Started](https://github.com/jeffreylanters/unity-tweens/raw/master/#getting-started) - Code examples on how to create your first Tween - [Tweening Methods](https://github.com/jeffreylanters/unity-tweens/raw/master/#tweening-methods) - Tweening methods available to animate various properties - [Chainable Options](https://github.com/jeffreylanters/unity-tweens/raw/master/#chainable-options) - Chainable options allowing you to alter the Tween's behaviour - [Other Methods](https://github.com/jeffreylanters/unity-tweens/raw/master/#other-methods) - Various other options available on instanciated Tweens ## Getting Started These are some of the endless possibilities using Tweens. Tweens can be invoked on any GameObject and Component and fetches their own required components so you don't have to. Chainable Options can used to customize the behaviour to your needs. ```cs using UnityEngine; using ElRaccoone.Tweens; public class MyGameObject : MonoBehaviour { private void Start () { this.gameObject.TweenLocalRotationX (10, 1).SetFrom (-10).SetDelay (1).SetEaseQuadIn (); this.gameObject.TweenGraphicColor (Color.red, 10).SetPingPong ().SetLoop (10).SetEaseBackInOut (); this.gameObject.TweenValueFloat (0, 2, (value => { })).SetFrom (100).SetEaseSineOut (); this.gameObject.TweenCancelAll (); } private async void AsyncAnimationSequence () { await this.gameObject.TweenPosition (new Vector3 (10, 1, 15), 5).SetEaseSineInOut ().Await (); await this.gameObject.TweenPosition (new Vector3 (25, 5, 30), 5).SetEaseSineInOut ().Await (); await this.gameObject.TweenScaleY (100, 5).SetFrom (1).SetLoopCount (5).Await (); } private IEnumerator RoutineAnimationSequence () { yield return this.gameObject.TweenGraphicColor (Color.red, 5).SetEaseCircInOut ().Yield (); yield return this.gameObject.TweenGraphicColor (Color.green, 5).SetEaseCircInOut ().Yield (); yield return this.gameObject.TweenLocalRotationZ (360, 5).SetFrom (1).SetPingPong ().Yield (); } } ``` ## Tweening Methods #### Tween Position `version 1.0.0` Instantiates a Tween animating the Position. ```cs .TweenPosition (Vector3 to, float duration) : Tween; ``` #### Tween Position X `version 1.0.0` Instantiates a Tween animating the X axis of the Position. ```cs .TweenPositionX (float to, float duration) : Tween; ``` #### Tween Position Y `version 1.0.0` Instantiates a Tween animating the Y axis of the Position. ```cs .TweenPositionY (float to, float duration) : Tween; ``` #### Tween Position Z `version 1.0.0` Instantiates a Tween animating the Z axis of the Position. ```cs .TweenPositionZ (float to, float duration) : Tween; ``` #### Tween Local Position `version 1.0.0` Instantiates a Tween animating the LocalPosition. ```cs .TweenLocalPosition (Vector3 to, float duration) : Tween; ``` #### Tween Local Position X `version 1.0.0` Instantiates a Tween animating the X axis of the LocalPosition. ```cs .TweenLocalPositionX (float to, float duration) : Tween; ``` #### Tween Local Position Y `version 1.0.0` Instantiates a Tween animating the Y axis of the LocalPosition. ```cs .TweenLocalPositionY (float to, float duration) : Tween; ``` #### Tween Local Position Z `version 1.0.0` Instantiates a Tween animating the Z axis of the LocalPosition. ```cs .TweenLocalPositionZ (float to, float duration) : Tween; ``` #### Tween Anchored Position `version 1.0.2` Instantiates a Tween animating the AnchoredPosition. ```cs .TweenAnchoredPosition (Vector2 to, float duration) : Tween; ``` #### Tween Anchored Position X `version 1.0.2` Instantiates a Tween animating the X axis of the AnchoredPosition. ```cs .TweenAnchoredPositionX (float to, float duration) : Tween; ``` #### Tween Anchored Position Y `version 1.0.2` Instantiates a Tween animating the Y axis of the AnchoredPosition. ```cs .TweenAnchoredPositionY (float to, float duration) : Tween; ``` #### Tween Rotation `version 1.0.0` Instantiates a Tween animating the Rotation. ```cs .TweenRotation (Vector3 to, float duration) : Tween; ``` #### Tween Rotation X `version 1.0.0` Instantiates a Tween animating the X axis of the Rotation. ```cs .TweenRotationX (float to, float duration) : Tween; ``` #### Tween Rotation Y `version 1.0.0` Instantiates a Tween animating the Y axis of the Rotation. ```cs .TweenRotationY (float to, float duration) : Tween; ``` #### Tween Rotation Z `version 1.0.0` Instantiates a Tween animating the Z axis of the Rotation. ```cs .TweenRotationZ (float to, float duration) : Tween; ``` #### Tween Local Rotation `version 1.0.0` Instantiates a Tween animating the LocalRotation. ```cs .TweenLocalRotation (Vector3 to, float duration) : Tween; ``` #### Tween Local Rotation X `version 1.0.0` Instantiates a Tween animating the X axis of the LocalRotation. ```cs .TweenLocalRotationX (float to, float duration) : Tween; ``` #### Tween Local Rotation Y `version 1.0.0` Instantiates a Tween animating the Y axis of the LocalRotation. ```cs .TweenLocalRotationY (float to, float duration) : Tween; ``` #### Tween Local Rotation Z `version 1.0.0` Instantiates a Tween animating the Z axis of the LocalRotation. ```cs .TweenLocalRotationZ (float to, float duration) : Tween; ``` #### Tween Local Scale `version 1.0.0` Instantiates a Tween animating the LocalScale. ```cs .TweenLocalScale (Vector3 to, float duration) : Tween; ``` #### Tween Local Scale X `version 1.0.0` Instantiates a Tween animating the X axis of the LocalScale. ```cs .TweenLocalScaleX (float to, float duration) : Tween; ``` #### Tween Local Scale Y `version 1.0.0` Instantiates a Tween animating the Y axis of the LocalScale. ```cs .TweenLocalScaleY (float to, float duration) : Tween; ``` #### Tween Local Scale Z `version 1.0.0` Instantiates a Tween animating the Z axis of the LocalScale. ```cs .TweenLocalScaleZ (float to, float duration) : Tween; ``` #### Tween Image Fill Amount (Unity GUI) `version 1.0.3` `requires com.unity.ugui` Instantiates a Tween animating the fillAmount of an image. ```cs .TweenImageFillAmount (float to, float duration) : Tween; ``` #### Tween Graphic Alpha (Unity GUI) `version 1.0.4` `requires com.unity.ugui` Instantiates a Tween animating the alpha of a graphic. ```cs .TweenGraphicAlpha (float to, float duration) : Tween; ``` #### Tween Graphic Color (Unity GUI) `version 1.0.4` `requires com.unity.ugui` Instantiates a Tween animating the color of a graphic. ```cs .TweenGraphicColor (Color to, float duration) : Tween; ``` #### Tween Sprite Renderer Alpha `version 1.0.4` Instantiates a Tween animating the alpha of a SpriteRenderer. ```cs .TweenSpriteRendererAlpha (float to, float duration) : Tween; ``` #### Tween Sprite Renderer Color `version 1.0.5` Instantiates a Tween animating the color of a SpriteRenderer. ```cs .TweenSpriteRendererColor (Color to, float duration) : Tween; ``` #### Tween Material Alpha `version 1.0.9` Instantiates a Tween animating the alpha of a Material. ```cs .TweenMaterialAlpha (float to, float duration) : Tween; ``` #### Tween Material Color `version 1.0.9` Instantiates a Tween animating the color of a Material. ```cs .TweenMaterialColor (Color to, float duration) : Tween; ``` #### Tween Text Mesh Alpha `version 1.0.8` Instantiates a Tween animating the alpha of a TextMesh. ```cs .TweenTextMeshAlpha (float to, float duration) : Tween; ``` #### Tween Text Mesh Color `version 1.7.0` Instantiates a Tween animating the color of a TextMesh. ```cs .TweenTextMeshColor (Color to, float duration) : Tween; ``` #### Tween Text Mesh Pro Color (Text Mesh Pro) `version 1.7.0` `requires com.unity.textmeshpro` Instantiates a Tween animating the color of a TextMeshPro. ```cs .TweenTextMeshProColor (Color to, float duration) : Tween; ``` #### Tween Text Mesh Pro Alpha (Text Mesh Pro) `version 1.7.0` `requires com.unity.textmeshpro` Instantiates a Tween animating the alpha of a TextMeshPro. ```cs .TweenTextMeshProAlpha (float to, float duration) : Tween; ``` #### Tween Canvas Group Alpha `version 1.0.10` Instantiates a Tween animating the alpha of a CanvasGroup. ```cs .TweenCanvasGroupAlpha (float to, float duration) : Tween; ``` #### Tween Audio Source Pitch `version 1.0.11` Instantiates a Tween easing the pitch of an AudioSource. ```cs .TweenAudioSourcePitch (float to, float duration) : Tween; ``` #### Tween Audio Source Priority `version 1.10.0` Instantiates a Tween easing the priority of an AudioSource. ```cs .TweenAudioSourcePriority (float to, float duration) : Tween; ``` #### Tween Audio Source Reverb Zone Mix `version 1.10.0` Instantiates a Tween easing the reverb zone mix of an AudioSource. ```cs .TweenAudioSourceReverbZoneMix (float to, float duration) : Tween; ``` #### Tween Audio Source Spatial Blend `version 1.10.0` Instantiates a Tween easing the spatial blend of an AudioSource. ```cs .TweenAudioSourceSpatialBlend (float to, float duration) : Tween; ``` #### Tween Audio Source Stereo Pan `version 1.10.0` Instantiates a Tween easing the stereo pan of an AudioSource. ```cs .TweenAudioSourceStereoPan (float to, float duration) : Tween; ``` #### Tween Audio Source Volume `version 1.0.11` Instantiates a Tween easing the volume of an AudioSource. ```cs .TweenAudioSourceVolume (float to, float duration) : Tween; ``` #### Tween Camera Field Of View `version 1.6.4` Instantiates a Tween easing the field of view of a Camera. ```cs .TweenCameraFieldOfView (float to, float duration) : Tween; ``` #### Tween Camera Orthographic Size `version 1.6.4` Instantiates a Tween easing the orthographic size of a Camera. ```cs .TweenCameraOrthographicSize (float to, float duration) : Tween; ``` #### Tween Light Color `version 1.6.6` Instantiates a Tween easing the color of a Light. ```cs .TweenLightColor (Color to, float duration) : Tween; ``` #### Tween Light Intensity `version 1.9.3` Instantiates a Tween easing the intensity of a Light. ```cs .TweenLightIntensity (float to, float duration) : Tween; ``` #### Tween Volume Weight (Scriptable Render Pipeline) `version 1.6.7` `requires com.unity.render-pipelines.core` Instantiates a Tween animating the weight of a post-processing volume. ```cs .TweenVolumeWeight (float to, float duration) : Tween; ``` #### Tween Value Float `version 1.0.3` Instantiates a Tween animating the a float value. ```cs .TweenValueFloat (float to, float duration, Action onUpdate) : Tween; ``` #### Tween Value Vector2 `version 1.6.5` Instantiates a Tween animating the a Vector2 value. ```cs .TweenValueVector2 (Vector2 to, float duration, Action onUpdate) : Tween; ``` #### Tween Value Vector3 `version 1.6.5` Instantiates a Tween animating the a Vector3 value. ```cs .TweenValueVector3 (Vector3 to, float duration, Action onUpdate) : Tween; ``` #### Tween Value Color `version 1.2.0` Instantiates a Tween animating the a color value. ```cs .TweenValueColor (Color to, float duration, Action onUpdate) : Tween; ``` #### Tween Cancel All `version 1.0.0` Cancels all the running tweens. ```cs .TweenCancelAll (bool includeChildren = false, bool includeInactive = false) : Tween; ``` ## Chainable Options #### Set From `version 1.0.0` Sets the From value of a tween, when not set the current value will be used. ```cs >.SetFrom (T valueFrom) : Tween; ``` #### Set On Complete `version 1.1.0` Sets the event which will be invoked when the tween completes playing. This will not be invoked when the tween is canceled. ```cs >.SetOnComplete (Action onComplete) : Tween; ``` #### Set On Cancel `version 1.3.0` Sets the event which will be invoked when the tween is canceled. ```cs >.SetOnCancel (Action onCancel) : Tween; ``` #### Set Ping Pong `version 1.6.0` Enabled ping pong playback, this will bounce the animation back and forth. The tween has play forward and backwards to count as one cycle. Use either SetLoopCount or SetInifinite to set the number of times the animation should ping pong. ```cs >.SetPingPong () : Tween; ``` #### Set Loop Count `version 1.2.0` Sets the number of times the animation should loop. ```cs >.SetLoopCount (int loopCount) : Tween; ``` #### Set Infinite `version 1.5.0` Sets this tween to infinite, the loopcount will be ignored. ```cs >.SetInfinite () : Tween; ``` #### Set Delay `version 1.3.0` Sets the delay of this tween. The tween will not play anything until the requested delay time is reached. You can change this behaviour by enabeling 'goToFirstFrameImmediately' to set the animation to the first frame immediately. ```cs >.SetDelay (float delay, bool goToFirstFrameImmediately = false) : Tween; ``` #### Set Time `version 1.1.0` Sets the time of the tween. ```cs >.SetTime (float time) : Tween; ``` #### Set Random Time `version 1.3.0` Sets the time of the tween to a random value. ```cs >.SetRandomTime () : Tween; ``` #### Set Paused `version 1.4.0` Sets whether the playback and delay should be paused. ```cs >.SetPaused (bool isPaused) : Tween; ``` #### Set Use Unscaled Time `version 1.6.1` Sets whether the tween should use the unscaled delta time instead of the scaled delta time. ```cs >.SetUseUnscaledTime (bool useUnscaledTime) : Tween; ``` #### Set Overshooting `version 1.5.0` Sets the overshooting of Eases that exceed their boundaries such as elastic and back. ```cs >.SetOvershooting (float overshooting) : Tween; ``` #### Set Ease `version 1.5.0` Sets the ease for this tween. ```cs >.SetEase (Ease ease) : Tween; ``` #### Set Ease Linear `version 1.0.0` Sets the ease for this tween to Linear. ```cs >.SetEaseLinear () : Tween; ``` #### Set Ease Sine In `version 1.0.0` Sets the ease for this tween to SineIn. ```cs >.SetEaseSineIn () : Tween; ``` #### Set Ease Sine Out `version 1.0.0` Sets the ease for this tween to SineOut. ```cs >.SetEaseSineOut () : Tween; ``` #### Set Ease Sine In Out `version 1.0.0` Sets the ease for this tween to SineInOut. ```cs >.SetEaseSineInOut () : Tween; ``` #### Set Ease Quad In `version 1.0.0` Sets the ease for this tween to QuadIn. ```cs >.SetEaseQuadIn () : Tween; ``` #### Set Ease Quad Out `version 1.0.0` Sets the ease for this tween to QuadOut. ```cs >.SetEaseQuadOut () : Tween; ``` #### Set Ease Quad In Out `version 1.0.0` Sets the ease for this tween to QuadInOut. ```cs >.SetEaseQuadInOut () : Tween; ``` #### Set Ease Cubic In `version 1.0.0` Sets the ease for this tween to CubicIn. ```cs >.SetEaseCubicIn () : Tween; ``` #### Set Ease Cubic Out `version 1.0.0` Sets the ease for this tween to CubicOut. ```cs >.SetEaseCubicOut () : Tween; ``` #### Set Ease Cubic In Out `version 1.0.0` Sets the ease for this tween to CubicInOut. ```cs >.SetEaseCubicInOut () : Tween; ``` #### Set Ease Quart In `version 1.0.0` Sets the ease for this tween to QuartIn. ```cs >.SetEaseQuartIn () : Tween; ``` #### Set Ease Quart Out `version 1.0.0` Sets the ease for this tween to QuartOut. ```cs >.SetEaseQuartOut () : Tween; ``` #### Set Ease Quart In Out `version 1.0.0` Sets the ease for this tween to QuartInOut. ```cs >.SetEaseQuartInOut () : Tween; ``` #### Set Ease Quint In `version 1.0.0` Sets the ease for this tween to QuintIn. ```cs >.SetEaseQuintIn () : Tween; ``` #### Set Ease Quint Out `version 1.0.0` Sets the ease for this tween to QuintOut. ```cs >.SetEaseQuintOut () : Tween; ``` #### Set Ease Quint In Out `version 1.0.0` Sets the ease for this tween to QuintInOut. ```cs >.SetEaseQuintInOut () : Tween; ``` #### Set Ease Expo In `version 1.0.0` Sets the ease for this tween to ExpoIn. ```cs >.SetEaseExpoIn () : Tween; ``` #### Set Ease Expo Out `version 1.0.0` Sets the ease for this tween to ExpoOut. ```cs >.SetEaseExpoOut () : Tween; ``` #### Set Ease Expo In Out `version 1.0.0` Sets the ease for this tween to ExpoInOut. ```cs >.SetEaseExpoInOut () : Tween; ``` #### Set Ease Circ In `version 1.0.0` Sets the ease for this tween to CircIn. ```cs >.SetEaseCircIn () : Tween; ``` #### Set Ease Circ Out `version 1.0.0` Sets the ease for this tween to CircOut. ```cs >.SetEaseCircOut () : Tween; ``` #### Set Ease Circ In Out `version 1.0.0` Sets the ease for this tween to CircInOut. ```cs >.SetEaseCircInOut () : Tween; ``` #### Set Ease Back In `version 1.0.0` Sets the ease for this tween to BackIn. ```cs >.SetEaseBackIn () : Tween; ``` #### Set Ease Back Out `version 1.0.0` Sets the ease for this tween to BackOut. ```cs >.SetEaseBackOut () : Tween; ``` #### Set Ease Back In Out `version 1.0.0` Sets the ease for this tween to BackInOut. ```cs >.SetEaseBackInOut () : Tween; ``` #### Set Ease Elastic In `version 1.0.0` Sets the ease for this tween to ElasticIn. ```cs >.SetEaseElasticIn () : Tween; ``` #### Set Ease Elastic Out `version 1.0.0` Sets the ease for this tween to ElasticOut. ```cs >.SetEaseElasticOut () : Tween; ``` #### Set Ease Elastic In Out `version 1.0.0` Sets the ease for this tween to ElasticInOut. ```cs >.SetEaseElasticInOut () : Tween; ``` #### Set Ease Bounce In `version 1.0.0` Sets the ease for this tween to BounceIn. ```cs >.SetEaseBounceIn () : Tween; ``` #### Set Ease Bounce Out `version 1.0.0` Sets the ease for this tween to BounceOut. ```cs >.SetEaseBounceOut () : Tween; ``` #### Set Ease Bounce In Out `version 1.0.0` Sets the ease for this tween to BounceInOut. ```cs >.SetEaseBounceInOut () : Tween; ``` ## Other Methods #### Cancel `version 1.0.0` Cancel the tween. ```cs >.Cancel () : void; ``` #### Await `version 1.9.1` Returns a Task allowing the Tween to be awaited using an Async Await block until the Tween is either completed, destroyed, canceld or was unable to start. Make sure to cancel your Async method to prevent errors from being throwing in the Unity Editor when leaving Play mode while using Tasks to chain a sequence of Tweens. ```cs >.Await () : Task; ``` #### Yield `version 1.9.1` Returns a IEnumerator allowing the Tween to be yielded using a coroutine until the Tween is either completed, destroyed, canceld or was unable to start. ```cs >.Yield () : IEnumerator; ``` #### Get Total Duration `version 1.6.2` Gets the total duration of the tween including the loop count and ping pong settings, and the delay optionally. ```cs >.GetTotalDuration (bool includeDelay = false) : float; ```