DOTween

http://dotween.demigiant.com/documentation.php
Admin
DOTween is a fast, efficient, and type-safe animation engine for Unity that allows developers to...
Tokens:90,859
Snippets:623
Trust Score:9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### OnStart callback example

Source: http://dotween.demigiant.com/documentation.php

Attaches a callback that fires once when the tween starts, after any delay. Use with any tween, e.g., a DOMoveX tween.

```csharp
transform.DOMoveX(4, 1).OnStart(MyCallback);
```

--------------------------------

### Shortcuts way: DOMove and DOColor examples

Source: http://dotween.demigiant.com/documentation.php

Shows how to start tweens directly from Unity objects like Transform, Rigidbody, and Material using shortcut methods.

```csharp
transform.DOMove(new Vector3(2,3,4), 1);
rigidbody.DOMove(new Vector3(2,3,4), 1);
material.DOColor(Color.green, 1);
```

--------------------------------

### WaitForStart() coroutine example

Source: http://dotween.demigiant.com/documentation.php

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

```csharp
IEnumerator SomeCoroutine()
{
  Tween myTween = transform.DOMoveX(45, 1);
  yield return myTween.WaitForStart();
  // This log will happen when the tween starts
  Debug.Log("Tween started!");
}
```

--------------------------------

### DOTweenTMPAnimator Setup Methods

Source: http://dotween.demigiant.com/documentation.php

Setup methods for the DOTweenTMPAnimator wrapper.

```APIDOC
## DOTweenTMPAnimator Setup Methods

### Refresh()
Refreshes the animator text data and resets all transformation data. Automatically called every time you change the text inside your `TMP_Text` object.

### Reset()
Resets all deformations.
```

--------------------------------

### AsyncWaitForStart() task example

Source: http://dotween.demigiant.com/documentation.php

Returns a Task 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).

```csharp
await myTween.AsyncWaitForStart();
```

--------------------------------

### SetDelay(float) example

Source: http://dotween.demigiant.com/documentation.php

Sets a delayed startup for the tween. Has no effect if the tween has already started. When chained to a Sequence, it prepends an interval at the beginning (same as PrependInterval) unless the overload with asPrependedIntervalIfSequence is used.

```csharp
transform.DOMoveX(4, 1).SetDelay(1);
```

--------------------------------

### OnStart(TweenCallback callback)

Source: http://dotween.demigiant.com/documentation.php

Sets a callback that will be fired once when the tween starts.

```APIDOC
## OnStart(TweenCallback callback)

### Description
Sets a callback that will be fired once when the tween starts (meaning when the tween is set in a playing state the first time, after any eventual delay).

### Method
OnStart

### Parameters
- **callback** (TweenCallback) - Required - The callback to be fired when the tween starts.

### Example
```csharp
transform.DOMoveX(4, 1).OnStart(MyCallback);
```
```

--------------------------------

### Get path point with PathGetPoint(float pathPercentage)

Source: http://dotween.demigiant.com/documentation.php

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 created with the Path Editor (DOTween Pro feature); you can force initialization with ForceInit.

```csharp
Vector3 myPathMidPoint = myTween.PathGetPoint(0.5f);
```

--------------------------------

### Creating a Sequence with chaining

Source: http://dotween.demigiant.com/documentation.php

Same as the previous example but with chaining (plus line breaks to make things clearer).

```csharp
Sequence mySequence = DOTween.Sequence();
mySequence.Append(transform.DOMoveX(45, 1))
  .Append(transform.DORotate(new Vector3(0,180,0), 1))
  .PrependInterval(1)
  .Insert(0, transform.DOScale(new Vector3(3,3,3), mySequence.Duration()));
```

--------------------------------

### DOTweenEditorPreview.Start

Source: http://dotween.demigiant.com/documentation.php

Starts the editor preview update loop for tweens. Requires tweens to be prepared first.

```APIDOC
## DOTweenEditorPreview.Start

### Description
Starts the update loop of tweens in the editor. Has no effect during playMode. Before calling this method you must add tweens to the preview loop via DOTweenEditorPreview.PrepareTweenForPreview.

### Method
static

### Signature
`static DOTweenEditorPreview.Start(Action onPreviewUpdated = null)`

### Parameters
- **onPreviewUpdated** (Action) - Optional - Eventual callback to call after every update (while in editor preview).
```

--------------------------------

### Get path length with PathLength()

Source: http://dotween.demigiant.com/documentation.php

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 created with the Path Editor (DOTween Pro feature); you can force initialization with ForceInit.

```csharp
float myPathLength = myTween.PathLength();
```

--------------------------------

### Shortcuts (Transform.DOMove, Rigidbody.DOMove, Material.DOColor)

Source: http://dotween.demigiant.com/documentation.php

Starts a tween directly from a reference to a Unity object, automatically setting the object as the tween target.

```APIDOC
## [SHORTCUT] transform.DOMove(new Vector3(2,3,4), 1);

### Description
Starts a tween on the Transform component to move it to the specified position.

### Method
Extension method on Transform

### Parameters
- **to** (Vector3) - Required - The end position to move to.
- **duration** (float) - Required - The duration of the tween.

### Request Example
```csharp
transform.DOMove(new Vector3(2,3,4), 1);
```

### Response
No return value documented.

---

## [SHORTCUT] rigidbody.DOMove(new Vector3(2,3,4), 1);

### Description
Starts a tween on the Rigidbody component to move it to the specified position.

### Method
Extension method on Rigidbody

### Parameters
- **to** (Vector3) - Required - The end position to move to.
- **duration** (float) - Required - The duration of the tween.

### Request Example
```csharp
rigidbody.DOMove(new Vector3(2,3,4), 1);
```

### Response
No return value documented.

---

## [SHORTCUT] material.DOColor(Color.green, 1);

### Description
Starts a tween on the Material to change its color to the specified color.

### Method
Extension method on Material

### Parameters
- **to** (Color) - Required - The end color to tween to.
- **duration** (float) - Required - The duration of the tween.

### Request Example
```csharp
material.DOColor(Color.green, 1);
```

### Response
No return value documented.
```

--------------------------------

### AsyncWaitForElapsedLoops(int) task example

Source: http://dotween.demigiant.com/documentation.php

Returns a Task that waits until the tween is killed or has gone through the given amount of loops. Note: the example omits the required int parameter.

```csharp
await myTween.AsyncWaitForElapsedLoops();
```

--------------------------------

### DOSpiral example

Source: http://dotween.demigiant.com/documentation.php

Tweens a Rigidbody's position in a spiral shape. The example uses a duration of 3 seconds, the forward axis, ExpandThenContract mode, and a speed of 1. The frequency defaults to 10 and depth to 0.

```csharp
transform.DOSpiral(3, Vector3.forward, SpiralMode.ExpandThenContract, 1, 10);
```

--------------------------------

### Generic way: DOTween.To examples

Source: http://dotween.demigiant.com/documentation.php

Shows how to tween a Vector3 and a float using the generic DOTween.To method with lambda getter and setter delegates.

```csharp
// Tween a Vector3 called myVector to 3,4,8 in 1 second
DOTween.To(()=> myVector, x=> myVector = x, new Vector3(3,4,8), 1);
// Tween a float called myFloat to 52 in 1 second
DOTween.To(()=> myFloat, x=> myFloat = x, 52, 1);
```

--------------------------------

### WaitForStart()

Source: http://dotween.demigiant.com/documentation.php

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

```APIDOC
## WaitForStart()

### Description
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).

### Method
WaitForStart()

### Parameters
- **bool returnCustomYieldInstruction** (bool) - Optional - If true, returns a CustomYieldInstruction instead of a YieldInstruction.

### Example
```csharp
IEnumerator SomeCoroutine()
{
  Tween myTween = transform.DOMoveX(45, 1);
  yield return myTween.WaitForStart();
  // This log will happen when the tween starts
  Debug.Log("Tween started!");
}
```
```

--------------------------------

### From(T fromValue, bool setImmediately = true, bool isRelative = false)

Source: http://dotween.demigiant.com/documentation.php

Allows to set the starting value of a tween directly, instead of relying on the target's value when the tween starts.

```APIDOC
## From(T fromValue, bool setImmediately = true, bool isRelative = false)

### Description
Allows to set the starting value of a tween directly, instead of relying on the target's value when the tween starts. Must be chained before any other setting, except tween specific options.

### Method
From

### Parameters
- **fromValue** (T) - Required - The value from which the tween will start.
- **setImmediately** (bool) - Optional - If TRUE the target will be immediately set to the `fromValue`, otherwise it will wait for the tween to start.
- **isRelative** (bool) - Optional - If TRUE sets the tween as relative (the FROM value will be calculated as `currentValue + fromValue` instead of being used directly). With FROM tweens you need to use this parameter instead of `SetRelative`.
```

--------------------------------

### AsyncWaitForPosition(float) task example

Source: http://dotween.demigiant.com/documentation.php

Returns a Task that waits until the tween is killed or has reached the given time position (loops included, delays excluded). The example waits for 0.3 seconds.

```csharp
await myTween.AsyncWaitForPosition(0.3f);
```

--------------------------------

### PrependInterval example

Source: http://dotween.demigiant.com/documentation.php

Adds the given interval to the beginning of the Sequence, pushing forward in time the rest of the contents.

```csharp
mySequence.PrependInterval(interval);
```

--------------------------------

### WaitForElapsedLoops(int) coroutine example

Source: http://dotween.demigiant.com/documentation.php

Waits until the tween is killed or has gone through the given amount of loops. The example waits for 2 loops of a 4-loop tween.

```csharp
IEnumerator SomeCoroutine()
{
  Tween myTween = transform.DOMoveX(45, 1).SetLoops(4);
  yield return myTween.WaitForElapsedLoops(2);
  // This log will happen after the 2nd loop has finished
  Debug.Log("Tween has looped twice!");
}
```

--------------------------------

### SetTweensCapacity example

Source: http://dotween.demigiant.com/documentation.php

Sets DOTween's capacity at startup to avoid hiccups when the default max Tweeners/Sequences (200 Tweeners and 50 Sequences) is exceeded.

```csharp
// Set max Tweeners to 2000 and max Sequences to 100
DOTween.SetTweensCapacity(2000, 100);
```

--------------------------------

### Prepend a callback to a Sequence

Source: http://dotween.demigiant.com/documentation.php

Adds the given callback to the beginning of the Sequence. Must be applied before the Sequence starts.

```csharp
mySequence.PrependCallback(MyCallback);
```

--------------------------------

### OnPlay(TweenCallback callback)

Source: http://dotween.demigiant.com/documentation.php

Sets a callback for when the tween starts playing.

```APIDOC
## OnPlay(TweenCallback callback)

### Description
Sets a callback that will be fired 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.

### Method
OnPlay

### Parameters
- **callback** (TweenCallback) - Required - The callback to fire on play.

### Example
```
transform.DOMoveX(4, 1).OnPlay(MyCallback);
```
```

--------------------------------

### OnUpdate callback example

Source: http://dotween.demigiant.com/documentation.php

Attaches a callback that fires every time the tween updates.

```csharp
transform.DOMoveX(4, 1).OnUpdate(MyCallback);
```

--------------------------------

### On prefix chained callbacks

Source: http://dotween.demigiant.com/documentation.php

Shows the On prefix for chaining callbacks to a tween, with start and complete callbacks.

```csharp
myTween.OnStart(myStartFunction).OnComplete(myCompleteFunction);
```

--------------------------------

### AsyncWaitForStart()

Source: http://dotween.demigiant.com/documentation.php

Returns a `Task` 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).

```APIDOC
## AsyncWaitForStart()

### Description
Returns a `Task` 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).

### Method
AsyncWaitForStart()

### Example
```csharp
await myTween.AsyncWaitForStart();
```
```

--------------------------------

### Prepend a tween to a Sequence

Source: http://dotween.demigiant.com/documentation.php

Adds the given tween to the beginning of the Sequence, pushing forward in time the rest of the contents. Must be applied before the Sequence starts.

```csharp
mySequence.Prepend(transform.DOMoveX(45, 1));
```

--------------------------------

### DOTween.Init examples

Source: http://dotween.demigiant.com/documentation.php

Shows two ways to call DOTween.Init: with no parameters to use Utility Panel preferences, or with custom settings and chained SetCapacity to set initial capacities.

```csharp
// EXAMPLE A: initialize with the preferences set in DOTween's Utility Panel
DOTween.Init();
// EXAMPLE B: initialize with custom settings, and set capacities immediately
DOTween.Init(true, true, LogBehaviour.Verbose).SetCapacity(200, 10);
```

--------------------------------

### From() tween examples

Source: http://dotween.demigiant.com/documentation.php

Demonstrates the From() method. The first line is a regular TO tween, the second is a FROM tween, and the third is a FROM tween with a relative FROM value. Must be chained before any other setting except tween-specific options.

```csharp
// Regular TO tween
   transform.DOMoveX(2, 1);
   // FROM tween
   transform.DOMoveX(2, 1).From();
   // FROM tween but with relative FROM value
   transform.DOMoveX(2, 1).From(true);
```

--------------------------------

### LineRenderer.DOColor

Source: http://dotween.demigiant.com/documentation.php

Changes the target's color to the given one. Note that this method requires to also insert the start colors for the tween, since LineRenderers have no way to get them. Color2 is a special DOTween struct which allows to store two colors in a single variable.

```APIDOC
## [TWEEN] LineRenderer.DOColor

### Description
Changes the target's color to the given one. Note that this method requires to also insert the start colors for the tween, since LineRenderers have no way to get them. Color2 is a special DOTween struct which allows to store two colors in a single variable.

### Method
Extension Method

### Endpoint
LineRenderer.DOColor(Color2 startValue, Color2 endValue, float duration)

### Parameters
#### Parameters
- **startValue** (Color2) - Required - The start colors for the tween.
- **endValue** (Color2) - Required - The end colors for the tween.
- **duration** (float) - Required - The duration of the tween.

### Request Example
```csharp
myLineRenderer.DOColor(new Color2(Color.white, Color.white), new Color2(Color.green, Color.black), 1);
```
```

--------------------------------

### SetEase with EaseFactory.StopMotion

Source: http://dotween.demigiant.com/documentation.php

Wraps any ease with EaseFactory.StopMotion to simulate a given FPS while tweening, creating a stop-motion effect. The first parameter is the FPS (5 in this example) and the second is the ease to wrap.

```csharp
transform.DOMoveX(4, 1).SetEase(EaseFactory.StopMotion(5, Ease.InOutQuint));
```

--------------------------------

### WaitForRewind() coroutine example

Source: http://dotween.demigiant.com/documentation.php

Waits until the tween is killed or rewinded. The example uses SetAutoKill(false) and OnComplete(myTween.Rewind) to trigger a rewind.

```csharp
IEnumerator SomeCoroutine()
{
  Tween myTween = transform.DOMoveX(45, 1).SetAutoKill(false).OnComplete(myTween.Rewind);
  yield return myTween.WaitForRewind();
  // This log will happen when the tween has been rewinded
  Debug.Log("Tween rewinded!");
}
```

--------------------------------

### DOPunchCharScale

Source: http://dotween.demigiant.com/documentation.php

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

```APIDOC
## DOPunchCharScale(int charIndex, Vector3/float punch, float duration, int vibrato = 10, float elasticity = 1)

### Description
Punches a character's scale towards the given direction and then back to the starting one as if it was connected to the starting position via an elastic. Will return NULL if the `charIndex` is invalid or the character isn't visible.

### Method
DOPunchCharScale

### Parameters
- **charIndex** (int) - Required - Character index.
- **punch** (Vector3/float) - Required - The punch strength.
- **duration** (float) - Required - The tween's duration.
- **vibrato** (int) - Optional - Indicates how much will the punch vibrate per second. Default: 10.
- **elasticity** (float) - Optional - 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 offset and the opposite offset, while 0 oscillates only between the punch offset and the start offset. Default: 1.

### Returns
`Tween` reference, or NULL if the `charIndex` is invalid or the character isn't visible.
```

--------------------------------

### DOPunchCharRotation

Source: http://dotween.demigiant.com/documentation.php

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

```APIDOC
## DOPunchCharRotation(int charIndex, Vector3 punch, float duration, int vibrato = 10, float elasticity = 1)

### Description
Punches a character's rotation towards the given direction and then back to the starting one as if it was connected to the starting position via an elastic. Will return NULL if the `charIndex` is invalid or the character isn't visible.

### Method
DOPunchCharRotation

### Parameters
- **charIndex** (int) - Required - Character index.
- **punch** (Vector3) - Required - The punch strength.
- **duration** (float) - Required - The tween's duration.
- **vibrato** (int) - Optional - Indicates how much will the punch vibrate per second. Default: 10.
- **elasticity** (float) - Optional - 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 offset and the opposite offset, while 0 oscillates only between the punch offset and the start offset. Default: 1.

### Returns
`Tween` reference, or NULL if the `charIndex` is invalid or the character isn't visible.
```

--------------------------------

### DOPunchCharOffset

Source: http://dotween.demigiant.com/documentation.php

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

```APIDOC
## DOPunchCharOffset(int charIndex, Vector3 punch, float duration, int vibrato = 10, float elasticity = 1)

### Description
Punches a character's offset towards the given direction and then back to the starting one as if it was connected to the starting position via an elastic. Will return NULL if the `charIndex` is invalid or the character isn't visible.

### Method
DOPunchCharOffset

### Parameters
- **charIndex** (int) - Required - Character index.
- **punch** (Vector3) - Required - The punch strength.
- **duration** (float) - Required - The tween's duration.
- **vibrato** (int) - Optional - Indicates how much will the punch vibrate per second. Default: 10.
- **elasticity** (float) - Optional - 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 offset and the opposite offset, while 0 oscillates only between the punch offset and the start offset. Default: 1.

### Returns
`Tween` reference, or NULL if the `charIndex` is invalid or the character isn't visible.
```

--------------------------------

### DO prefix tween shortcuts

Source: http://dotween.demigiant.com/documentation.php

Shows the DO prefix used for tween shortcuts that operate directly on known objects like transforms, and for the main DOTween class. Includes a movement tween, a restart, and a play command.

```csharp
transform.DOMoveX(100, 1);
transform.DORestart();
DOTween.Play();
```

--------------------------------

### DOPunchScale

Source: http://dotween.demigiant.com/documentation.php

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

```APIDOC
## DOPunchScale(Vector3 punch, float duration, int vibrato, float elasticity)

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

### Method
DOPunchScale

### Parameters
- **punch** (Vector3) - Required - The punch strength (added to the Transform's current scale).
- **duration** (float) - Required - The duration of the tween.
- **vibrato** (int) - Required - Indicates how much the punch will vibrate.
- **elasticity** (float) - Required - 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.
```

--------------------------------

### DOPunchRotation

Source: http://dotween.demigiant.com/documentation.php

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

```APIDOC
## DOPunchRotation(Vector3 punch, float duration, int vibrato, float elasticity)

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

### Method
DOPunchRotation

### Parameters
- **punch** (Vector3) - Required - The punch strength (added to the Transform's current rotation).
- **duration** (float) - Required - The duration of the tween.
- **vibrato** (int) - Required - Indicates how much the punch will vibrate.
- **elasticity** (float) - Required - 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.
```

--------------------------------

### DOPunchPosition

Source: http://dotween.demigiant.com/documentation.php

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.

```APIDOC
## DOPunchPosition(Vector3 punch, float duration, int vibrato, float elasticity, bool snapping)

### Description
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.

### Method
DOPunchPosition

### Parameters
- **punch** (Vector3) - Required - The direction and strength of the punch (added to the Transform's current position).
- **duration** (float) - Required - The duration of the tween.
- **vibrato** (int) - Required - Indicates how much the punch will vibrate.
- **elasticity** (float) - Required - 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.
- **snapping** (bool) - Required - If TRUE the tween will smoothly snap all values to integers.
```

--------------------------------

### More on chaining

Source: http://dotween.demigiant.com/documentation.php

Shows how to chain multiple tween settings and callbacks in a single statement.

```APIDOC
## Chaining Example

### Description
Demonstrates that you can chain multiple settings and callbacks directly on a tween creation method.

### Usage Example
```csharp
transform.DOMoveX(45, 1).SetDelay(2).SetEase(Ease.OutQuad).OnComplete(MyCallback);
```
```

--------------------------------

### Callback with parameters using lambda

Source: http://dotween.demigiant.com/documentation.php

Shows how to use a callback with parameters via a lambda. The first line uses a parameterless callback, the second uses a lambda to pass parameters.

```csharp
// Callback without parameters
   transform.DOMoveX(4, 1).OnComplete(MyCallback);
   // Callback with parameters
   transform.DOMoveX(4, 1).OnComplete(()=>MyCallback(someParam, someOtherParam));
```

--------------------------------

### Chaining Multiple Settings

Source: http://dotween.demigiant.com/documentation.php

Demonstrates chaining multiple settings directly on a tween in one line. You can chain delay, ease, and completion callback without needing TweenParams.

```csharp
transform.DOMoveX(45, 1).SetDelay(2).SetEase(Ease.OutQuad).OnComplete(MyCallback);
```

--------------------------------

### WaitForPosition(float) coroutine example

Source: http://dotween.demigiant.com/documentation.php

Waits until the tween is killed or has reached the given time position (loops included, delays excluded). The example waits for 0.3 seconds of playback.

```csharp
IEnumerator SomeCoroutine()
{
  Tween myTween = transform.DOMoveX(45, 1);
  yield return myTween.WaitForPosition(0.3f);
  // This log will happen after the tween has played for 0.3 seconds
  Debug.Log("Tween has played for 0.3 seconds!");
}
```

--------------------------------

### DOTween.Init

Source: http://dotween.demigiant.com/documentation.php

Initializes DOTween with optional parameters for recycling, safe mode, and logging behavior. Call this once before creating any tweens.

```APIDOC
## [POST] /DOTween.Init

### Description
Initializes DOTween. Call it without any parameter to use the preferences set in DOTween's Utility Panel (otherwise they will be overrided by any eventual parameter passed).

### Method
POST

### Endpoint
DOTween.Init

### Parameters
#### Query Parameters
- **recycleAllByDefault** (bool) - Optional - If TRUE all new tweens will be set for recycling, meaning that when killed they won't be destroyed but instead will be put in a pool and reused rather than 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 might now be in use as other completely different 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 DOTween.defaultRecyclable property, or you can set the recycling behaviour for each tween separately, using SetRecyclable.
- **useSafeMode** (bool) - Optional - If set to TRUE tweens will be slightly slower but safer, allowing DOTween to automatically take care of things like targets being destroyed while a tween is running. **WARNING:** on iOS safeMode works only if stripping level is set to "Strip Assemblies" or Script Call Optimization is set to "Slow and Safe", while on Windows 10 WSA it won't work if Master Configuration and .NET are selected.
- **logBehaviour** (LogBehaviour) - Optional - Depending on the chosen mode DOTween will log only errors, errors and warnings, or everything plus additional informations.

### Request Example
```
// EXAMPLE A: initialize with the preferences set in DOTween's Utility Panel
DOTween.Init();
// EXAMPLE B: initialize with custom settings, and set capacities immediately
DOTween.Init(true, true, LogBehaviour.Verbose).SetCapacity(200, 10);
```

### Response
#### Success Response (200)
No specific response body is documented.

#### Response Example
No response example provided.
```

--------------------------------

### Shortcuts way with From()

Source: http://dotween.demigiant.com/documentation.php

Shows the FROM alternate version of the shortcuts, where the target immediately jumps to the FROM position when the tween is created.

```csharp
transform.DOMove(new Vector3(2,3,4), 1).From();
rigidbody.DOMove(new Vector3(2,3,4), 1).From();
material.DOColor(Color.green, 1).From();
```

--------------------------------

### DOBlendableMoveBy example

Source: http://dotween.demigiant.com/documentation.php

Blends two move tweens on the same Transform so they work together instead of fighting. The second tween loops 3 times with Yoyo, using the default OutQuad ease.

```csharp
// Tween a target by moving it by 3,3,0
// while blending another move by -3,0,0 that will loop 3 times
// (using the default OutQuad ease)
transform.DOBlendableMoveBy(new Vector3(3, 3, 0), 3);
transform.DOBlendableMoveBy(new Vector3(-3, 0, 0), 1f).SetLoops(3, LoopType.Yoyo);
```

--------------------------------

### Tween LineRenderer color with DOColor and Color2

Source: http://dotween.demigiant.com/documentation.php

Tweens a LineRenderer's color from the given start colors to the given end colors. Requires the Color2 struct to provide start colors because LineRenderers cannot retrieve them automatically.

```csharp
myLineRenderer.DOColor(new Color2(Color.white, Color.white), new Color2(Color.green, Color.black), 1);
```

--------------------------------

### AsyncWaitForKill() task example

Source: http://dotween.demigiant.com/documentation.php

Returns a Task that waits until the tween is killed.

```csharp
await myTween.AsyncWaitForKill();
```

--------------------------------

### DOTween Settings and Tween Settings

Source: http://dotween.demigiant.com/documentation.php

Documentation for DOTween static settings and tween instance properties and chained settings.

```APIDOC
## DOTween.defaultAutoKill

### Description
Default autoKill behaviour applied to all newly created tweens.

### Property
`static bool DOTween.defaultAutoKill`

### Default
`TRUE`

```

```APIDOC
## DOTween.defaultAutoPlay

### Description
Default autoPlay behaviour applied to all newly created tweens.

### Property
`static AutoPlay DOTween.defaultAutoPlay`

### Default
`AutoPlay.All`

```

```APIDOC
## DOTween.defaultEaseOvershootOrAmplitude

### Description
Default overshoot/amplitude used for eases.

### Property
`static float DOTween.defaultEaseOvershootOrAmplitude`

### Default
`1.70158f`

```

```APIDOC
## DOTween.defaultEasePeriod

### Description
Default period used for eases.

### Property
`static float DOTween.defaultEasePeriod`

### Default
`0`

```

```APIDOC
## DOTween.defaultEaseType

### Description
Default ease applied to all newly created Tweeners.

### Property
`static Ease DOTween.defaultEaseType`

### Default
`Ease.OutQuad`

```

```APIDOC
## DOTween.defaultLoopType

### Description
Default loop type applied to all newly created tweens that involve loops.

### Property
`static LoopType DOTween.defaultLoopType`

### Default
`LoopType.Restart`

```

```APIDOC
## DOTween.defaultRecyclable

### Description
Default recycling behaviour applied to all newly created tweens.

### Property
`static bool DOTween.defaultRecyclable`

### Default
`false`

```

```APIDOC
## DOTween.defaultTimeScaleIndependent

### Description
Sets whether Unity's timeScale/maximumDeltaTime should be taken into account by default or not.

### Property
`static bool DOTween.defaultTimeScaleIndependent`

### Default
`false`

```

```APIDOC
## DOTween.defaultUpdateType

### Description
Default `UpdateType` applied to all newly created tweens.

### Property
`static UpdateType DOTween.defaultUpdateType`

### Default
`UpdateType.Normal`

```

```APIDOC
## timeScale

### Description
Sets the internal timeScale for the tween.

### Property
`float timeScale`

### Default
`1`

### Example
```csharp
// Sets the tween so that it plays at half the speed
myTween.timeScale = 0.5f;
```

### Note
This value can be tweened by another tween to achieve smooth slow-motion effects.

```

```APIDOC
## SetAs(Tween tween \ TweenParams tweenParams)

### Description
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) or of the given TweenParams object.

### Method
SetAs

### Parameters
- **tween** (Tween) - Required - The tween whose parameters to copy.
- **tweenParams** (TweenParams) - Required - The TweenParams object whose parameters to copy.

### Remarks
Has no effect if the tween has already started.

### Example
```csharp
transform.DOMoveX(4, 1).SetAs(myOtherTween);
```

```

--------------------------------

### Tween.Delay()

Source: http://dotween.demigiant.com/documentation.php

Instance method on Tween/Tweener/Sequence to get the delay set for the tween.

```APIDOC
## float Delay()

### Description
Returns the eventual delay set for the tween.

### Method
Instance method on Tween/Tweener/Sequence

### Returns
- **float** - The eventual delay set for the tween.

### Example
```
float eventualDelay = myTween.Delay();
```
```

--------------------------------

### OnStepComplete callback example

Source: http://dotween.demigiant.com/documentation.php

Attaches a callback that fires each time the tween completes a loop cycle. For a tween with 3 loops, OnStepComplete fires 3 times, while OnComplete fires only once at the end.

```csharp
transform.DOMoveX(4, 1).OnStepComplete(MyCallback);
```

--------------------------------

### DOVirtual.DelayedCall examples

Source: http://dotween.demigiant.com/documentation.php

Shows two ways to use DOVirtual.DelayedCall: calling a named method after a delay, and using a lambda to log a message. The delay is in seconds and ignoreTimeScale defaults to true.

```csharp
DOVirtual.DelayedCall(1, MyOtherMethodName);
// Example 2: using a lambda to throw a log after 1 second
DOVirtual.DelayedCall(1, ()=> Debug.Log("Hello world"));
```

--------------------------------

### DOTween.PlayingTweens()

Source: http://dotween.demigiant.com/documentation.php

Static method on DOTween to get all active playing tweens.

```APIDOC
## static List<Tween> PlayingTweens()

### Description
Returns a list of all active tweens in a playing state, or NULL if there are no active playing tweens. Calling this method creates garbage allocation since a new List is generated with each call.

### Method
Static method on DOTween

### Returns
- **List<Tween>** - List of all active playing tweens, or NULL if none.
```

--------------------------------

### SetDelay(float delay, bool asPrependedIntervalIfSequence)

Source: http://dotween.demigiant.com/documentation.php

Sets a delayed startup for the tween with options to choose how the delay is applied in case of Sequences.

```APIDOC
## SetDelay(float delay, bool asPrependedIntervalIfSequence)

### Description
Sets a delayed startup for the tween with options to choose how the delay is applied in case of Sequences. Has no effect if the tween has already started.

### Method
SetDelay

### Parameters
- **delay** (float) - Required - The delay in seconds before the tween starts.
- **asPrependedIntervalIfSequence** (bool) - Required - Only used by `Sequences`: If FALSE sets the delay as a one-time occurrence (defaults to this for `Tweeners`), otherwise as a Sequence interval which will repeat at the beginning of every loop cycle.

### Example
```csharp
transform.DOMoveX(4, 1).SetDelay(1);
```
```

--------------------------------

### DOTween.PausedTweens()

Source: http://dotween.demigiant.com/documentation.php

Static method on DOTween to get all active paused tweens.

```APIDOC
## static List<Tween> PausedTweens()

### Description
Returns a list of all active tweens in a paused state, or NULL if there are no active paused tweens. Calling this method creates garbage allocation since a new List is generated with each call.

### Method
Static method on DOTween

### Returns
- **List<Tween>** - List of all active paused tweens, or NULL if none.
```

--------------------------------

### Creating a Sequence

Source: http://dotween.demigiant.com/documentation.php

Creates a Sequence with Append, PrependInterval, and Insert to combine movement, rotation, delay, and scale tweens.

```csharp
// Grab a free Sequence to use
Sequence mySequence = DOTween.Sequence();
// Add a movement tween at the beginning
mySequence.Append(transform.DOMoveX(45, 1));
// Add a rotation tween as soon as the previous one is finished
mySequence.Append(transform.DORotate(new Vector3(0,180,0), 1));
// Delay the whole Sequence by 1 second
mySequence.PrependInterval(1);
// Insert a scale tween for the whole duration of the Sequence
mySequence.Insert(0, transform.DOScale(new Vector3(3,3,3), mySequence.Duration()));
```

--------------------------------

### AsyncWaitForRewind() task example

Source: http://dotween.demigiant.com/documentation.php

Returns a Task that waits until the tween is killed or rewinded.

```csharp
await myTween.AsyncWaitForRewind();
```

--------------------------------

### Tweener.ChangeStartValue

Source: http://dotween.demigiant.com/documentation.php

Instance method on Tweener that changes the start value and rewinds the tween.

```APIDOC
## Tweener.ChangeStartValue

### Description
Changes the start value of a Tweener and rewinds it (without pausing it). Has no effect with Tweeners that are inside Sequences. Works on regular tweens, not on ones that do more than just animate one value from one point to another (like DOLookAt). For shortcuts that accept a single axis (DOMoveX/Y/Z, DOScaleX/YZ, etc) you still have to pass a full Vector2/3/4 value, even if only the one you set in the tween will be considered.

### Method
ChangeStartValue

### Parameters
- **newStartValue** (type not specified) - Required - New start value.
- **duration** (float) - Optional - If bigger than 0 also changes the duration of the tween.
```

--------------------------------

### Tween.CompletedLoops()

Source: http://dotween.demigiant.com/documentation.php

Instance method on Tween/Tweener/Sequence to get the total number of loops completed.

```APIDOC
## int CompletedLoops()

### Description
Returns the total number of loops completed by the tween.

### Method
Instance method on Tween/Tweener/Sequence

### Returns
- **int** - Total number of loops completed.

### Example
```
int completedLoops = myTween.CompletedLoops();
```
```

--------------------------------

### Tween.fullPosition

Source: http://dotween.demigiant.com/documentation.php

Instance property on Tween/Tweener/Sequence to get and set the time position of the tween.

```APIDOC
## float fullPosition

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

### Property
Instance property on Tween/Tweener/Sequence
```

--------------------------------

### Create a Sequence with DOTween.Sequence()

Source: http://dotween.demigiant.com/documentation.php

Creates a new Sequence that can be stored and used to add tweens. Sequences animate other tweens or sequences as a group and can be nested without depth limit.

```csharp
Sequence mySequence = DOTween.Sequence();
```

--------------------------------

### DOTween.TotalActiveTweeners()

Source: http://dotween.demigiant.com/documentation.php

Static method on DOTween to get the total number of active Tweeners.

```APIDOC
## static int TotalActiveTweeners()

### Description
Returns the total number of active Tweeners, regardless if they're playing or not.

### Method
Static method on DOTween

### Returns
- **int** - Total number of active Tweeners.

### Example
```
int totalActiveTweeners = DOTween.TotalActiveTweeners();
```
```
Tokens:
Raw