DOTween

https://dotween.demigiant.com/
Admin
DOTween is a fast, efficient, and fully type-safe object-oriented animation engine for Unity,...
Tokens:463,081
Snippets:7,152
Trust Score:9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Initialize DOTween with Utility Panel Preferences

Source: https://dotween.demigiant.com/documentation.php?api=Init

Use this example to initialize DOTween using the settings configured in the DOTween Utility Panel. This is the simplest way to start.

```csharp
DOTween.Init();
```

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

### DOTween Settings Examples

Source: https://dotween.demigiant.com/documentation.php?api=From

Examples of chaining settings to a tween. These include setting loops and speed-based animation, and defining callbacks for start and completion.

```csharp
myTween.SetLoops(4, LoopType.Yoyo).SetSpeedBased();
```

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

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

### DOTween Initialization Examples

Source: https://dotween.demigiant.com/documentation.php?api=SetAs

Initialize DOTween using default preferences or custom settings. Example B also demonstrates setting initial capacities for tweens and sequences.

```csharp
DOTween.Init();
```

```csharp
DOTween.Init(true, true, LogBehaviour.Verbose).SetCapacity(200, 10);
```

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

### DOTween Play Example

Source: https://dotween.demigiant.com/documentation.php?api=DOTween.timeScale

Starts or resumes all active tweens managed by DOTween. This is a global control function.

```csharp
DOTween.Play();
```

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

### Start Editor Preview Loop

Source: https://dotween.demigiant.com/documentation.php?api=Init

Starts the update loop for tweens being previewed in the editor. This method should be called after preparing tweens with PrepareTweenForPreview. It has no effect during runtime play mode.

```csharp
DOTweenEditorPreview.Start();
```

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

### Start Editor Tween Preview

Source: https://dotween.demigiant.com/documentation.php?api=DOTween.useSafeMode

Starts the update loop for tweens being previewed in the editor. This method should be called after preparing tweens with PrepareTweenForPreview. It includes an optional callback for updates during the preview.

```csharp
DOTweenEditorPreview.Start(MyUpdateCallback);
```

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=Init

Sets a callback that will be fired once when the tween starts playing for the first time.

```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
Chained method call on a DOTween tween.

### Parameters
#### Callback Parameter
- **callback** (TweenCallback) - Required - The function to execute when the tween starts.

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

### Response
#### Success Response
- The tween itself, allowing for further chaining.

#### Response Example
```csharp
// No direct response body, but the callback is executed.
```
```

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=SetUpdate

Sets a callback that will be fired once when the tween starts playing for the first time.

```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
Chained method call on a DOTween tween.

### Parameters
#### Callback Parameter
- **callback** (TweenCallback) - Required - The function to execute when the tween first starts.

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

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=DOTween.timeScale

Sets a callback that will be fired once when the tween starts playing for the first time.

```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
Chained method call on a DOTween tween.

### Parameters
#### Callback Parameter
- **callback** (TweenCallback) - Required - The function to execute when the tween starts.

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

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

### Start Editor Preview Loop

Source: https://dotween.demigiant.com/documentation.php?api=Clear

Starts the update loop for tweens in the editor. This method has no effect during play mode. Ensure tweens are prepared using PrepareTweenForPreview before calling this.

```csharp
DOTweenEditorPreview.Start(null);
```

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

### DOTween Tween Shortcuts

Source: https://dotween.demigiant.com/documentation.php?api=Init

Examples of using DOTween shortcuts to animate object properties directly. These shortcuts are prefixed with 'DO' and provide a convenient way to start tweens from known objects like transforms or materials.

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

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

### From() - Advanced

Source: https://dotween.demigiant.com/documentation.php?api=useSafeMode

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.

```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(T fromValue, bool setImmediately = true, bool isRelative = false)`

### Parameters
#### Path 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. Defaults to true.
- **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`. Defaults to false.
```

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

### Start Editor Tween Update Loop

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

Starts the update loop for tweens in the editor. This must be called after preparing tweens with PrepareTweenForPreview. It has no effect during play mode.

```csharp
static DOTweenEditorPreview.Start(Action onPreviewUpdated = null)
```

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

### DOTween Play Example

Source: https://dotween.demigiant.com/documentation.php?api=SetAutoKill

Demonstrates how to globally play all active tweens using DOTween's Play method.

```csharp
DOTween.Play();
```

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

### Unity UI Image Fill Amount Example

Source: https://dotween.demigiant.com/documentation.php?api=defaultAutoPlay

Demonstrates changing the fill amount of a Unity UI Image (from 0 to 1) over a duration using DOFillAmount.

```csharp
targetImage.DOFillAmount(toFill, duration);
```

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

### Get Full Duration of a Tween (Including Loops)

Source: https://dotween.demigiant.com/documentation.php?api=Init

Get the total duration of the tween, including all its loops. This provides the complete time the animation will run from start to finish.

```csharp
float fullDuration = myTween.Duration();
```

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

### Tween Callbacks

Source: https://dotween.demigiant.com/documentation.php?api=float+timeScale

Examples of chaining callbacks to a tween, such as OnStart and OnComplete.

```APIDOC
## Tween Callbacks

### Description
Prefix for all callbacks that can be chained to a tween.

### Examples
```csharp
// Set start and complete callbacks
myTween.OnStart(myStartFunction).OnComplete(myCompleteFunction);
```
```

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

### Compare HOTween and DOTween Plugin Usage

Source: https://dotween.demigiant.com/support.php?faq=Error+CS0433%3A+The+type

Demonstrates the transition from explicit plugin instantiation in HOTween to the simplified, managed approach in DOTween.

```csharp
HOTween.To(transform, 1, new TweenParms()
				.Prop(new PlugVector3Y("position", 45))
			);
```

```csharp
transform.DOMoveY(45, 1);
```

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

### DOTween Prefixes for Shortcuts and Main Class

Source: https://dotween.demigiant.com/documentation.php?api=DOSpiral__1

Demonstrates the use of 'DO' prefix for starting tweens directly from objects and for the main DOTween class.

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

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

### LineRenderer DOColor Example

Source: https://dotween.demigiant.com/documentation.php?api=DOTween.useSafeMode

Tweens a LineRenderer's color. This method requires both start and end colors to be provided.

```csharp
using DG.Tweening;
using UnityEngine;

public class LineRendererColorExample : MonoBehaviour
{
    public LineRenderer lineRenderer;

    void Start()
    {
        // Tween LineRenderer color from white to green/black
        lineRenderer.DOColor(new Color2(Color.white, Color.white), new Color2(Color.green, Color.black), 1f);
    }
}
```

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

### PlayAll/Play

Source: https://dotween.demigiant.com/documentation.php?api=DOTween.useSafeMode

Resumes or starts playback of the tween.

```APIDOC
## PlayAll/Play

### Description
Plays the tween.

### Method
POST

### Endpoint
/PlayAll/Play

### Response
#### Success Response (200)
- **status** (string) - Indicates success.

### Response Example
{
  "status": "playing"
}
```

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

### DOTween Initialization Examples

Source: https://dotween.demigiant.com/documentation.php?api=SetAutoKill

Demonstrates two ways to initialize DOTween: using default preferences or with custom settings and capacity. Initialize DOTween once before creating any tweens.

```csharp
DOTween.Init();
```

```csharp
DOTween.Init(true, true, LogBehaviour.Verbose).SetCapacity(200, 10);
```

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

### Get Eventual Delay of a Tween

Source: https://dotween.demigiant.com/documentation.php?api=Init

Retrieve the delay that was set for the tween. This value represents the time the tween will wait before starting its animation.

```csharp
float eventualDelay = myTween.Delay();
```

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

### Get Eased Value with Animation Curve

Source: https://dotween.demigiant.com/documentation.php?api=float+timeScale

Calculates a float value based on a start value, end value, lifetime percentage, and a custom AnimationCurve. This allows for highly customized easing behaviors.

```csharp
float val = DOVirtual.EasedValue(0f, 1f, 0.5f, AnimationCurve.EaseInOut(0,0,1,1));
```

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

### Get Total Elapsed Time (Including Loops)

Source: https://dotween.demigiant.com/documentation.php?api=Init

Retrieve the total elapsed time of the tween since it started, including all completed loops and excluding delays. This gives the overall runtime progress.

```csharp
float fullElapsed = myTween.Elapsed();
```

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=SetAutoKill

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

```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
Chained method call on a DOTween object.

### Parameters
#### Callback Parameter
- **callback** (TweenCallback) - Required - The function to execute on start.

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

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

### Get Eased Value with Ease Type

Source: https://dotween.demigiant.com/documentation.php?api=float+timeScale

Calculates a float value based on a start value, end value, lifetime percentage, and a specified ease type. This method is useful for interpolating values with predefined easing functions.

```csharp
float val = DOVirtual.EasedValue(0f, 1f, 0.5f, Ease.Linear);
```

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

### Spiral Tween Example

Source: https://dotween.demigiant.com/documentation.php?api=DOTween.Init

Tweens a Rigidbody's position in a spiral shape. This example demonstrates expanding and contracting spiral motion.

```csharp
using DG.Tweening;
using UnityEngine;

public class SpiralExample : MonoBehaviour
{
    public Transform target;

    void Start()
    {
        target.DOSpiral(3, Vector3.forward, SpiralMode.ExpandThenContract, 1, 10);
    }
}
```

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=Clear

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

```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
Chained method call on a DOTween tween.

### Endpoint
N/A (This is an SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

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

### Response
#### Success Response (N/A)
N/A

#### Response Example
N/A
```

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

### SetRelative

Source: https://dotween.demigiant.com/documentation.php?api=SetAs

Marks the tween as relative, meaning the end value is calculated by adding it to the start value. This setting has no effect on From tweens or tweens that have already started.

```APIDOC
## SetRelative

### Description
Configures the tween to operate with relative values, where the end value is offset from the start value.

### Method
Chained method

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **isRelative** (bool) - If TRUE, sets the tween as relative. Defaults to TRUE.

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

### Response
#### Success Response (200)
None (this is a configuration method)

#### Response Example
None
```

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=DOSpiral__1

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

```APIDOC
## OnStart

### Description
Sets a callback that will be fired once when the tween begins playing.

### Method
Chained method call on a DOTween tween.

### Endpoint
N/A (Method call)

### Parameters
#### Method Parameters
- **callback** (TweenCallback) - Required - The function to execute when the tween starts.

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

### Response
#### Success Response
N/A (Method modifies tween behavior)

#### Response Example
N/A
```

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

### Tween Settings

Source: https://dotween.demigiant.com/documentation.php?api=float+timeScale

Examples of chaining settings to a tween, such as setting loops or making it speed-based.

```APIDOC
## Tween Settings

### Description
Prefix for all settings that can be chained to a tween.

### Examples
```csharp
// Set loops and speed-based animation
myTween.SetLoops(4, LoopType.Yoyo).SetSpeedBased();
```
```

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=SetLink

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

```APIDOC
## OnStart

### 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
Chained method call on a DOTween tween.

### Parameters
#### Callback Parameter
- **callback** (TweenCallback) - Required - The function to execute when the tween starts.

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

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

### Get Duration of a Tween (Single Loop)

Source: https://dotween.demigiant.com/documentation.php?api=Init

Get the duration of a single loop cycle of the tween, excluding any delays. This is useful when speed-based tweens recalculate their duration.

```csharp
float loopCycleDuration = myTween.Duration(false);
```

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

### OnStart

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

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

```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
Chained method call on a tween object.

### Endpoint
N/A (SDK method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

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

### Response
#### Success Response (200)
N/A (SDK method)

#### Response Example
N/A
```

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=DOTween.showUnityEditorReport

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

```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 Parameter
- **callback** (TweenCallback) - Required - The function to execute when the tween first starts.

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

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

### DOTweenEditorPreview.Start

Source: https://dotween.demigiant.com/documentation.php?api=defaultAutoKill

Starts the update loop for tweens in the editor. This method should be called after preparing tweens with PrepareTweenForPreview.

```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 Signature
`static DOTweenEditorPreview.Start(Action onPreviewUpdated = null)`

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

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=Insert

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

```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
Chained method call on a DOTween tween.

### Parameters
#### Callback Parameter
- **callback** (TweenCallback) - Required - The function to execute when the tween starts.
```

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=SetRecyclable

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

```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 Parameter
- **callback** (TweenCallback) - Required - The function to call when the tween starts.

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

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=defaultAutoPlay

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

```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
Invoke

### Endpoint
N/A (SDK Method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

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

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=useSafeMode

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

```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
Invoke

### Endpoint
N/A (SDK Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

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

### Response
#### Success Response (N/A)
N/A

#### Response Example
N/A
```

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

### Configure Relative Tween Movement

Source: https://dotween.demigiant.com/documentation.php?api=Init

SetRelative makes the tween's end value relative to its start value. This setting has no effect on 'From' tweens or tweens that have already started.

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

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

### DOTweenEditorPreview.Start

Source: https://dotween.demigiant.com/documentation.php?api=SetAutoKill

Starts the update loop for tweens in the editor. This method should be called after preparing tweens with PrepareTweenForPreview.

```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

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

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=defaultRecyclable

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

```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
Invoke

### Parameters
#### Callback Parameters
- **callback** (TweenCallback) - The callback function to execute when the tween starts.

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

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

### From(T fromValue, bool setImmediately, bool isRelative)

Source: https://dotween.demigiant.com/documentation.php?api=DOTween.Init

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. The fromValue is the starting value, setImmediately determines if the target is set to fromValue immediately, and isRelative determines if the fromValue is relative to the current value.

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

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

### Parameters
#### Path 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`.
```

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=defaultAutoKill

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

```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
Invoke

### Parameters
#### Callback Parameters
- **callback** (TweenCallback) - Required - The callback function to execute when the tween starts.
```

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=SetAs

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

```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
Invoke

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **callback** (TweenCallback) - Required - The callback function to execute when the tween starts.

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

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### LineRenderer Color Tween

Source: https://dotween.demigiant.com/documentation.php?api=SetAutoKill

Tweens the start and end colors of a LineRenderer. This method requires explicit start colors as LineRenderers do not provide them directly. Color2 is a DOTween struct for storing two colors.

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

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

### Change Tweener Start Value

Source: https://dotween.demigiant.com/documentation.php?api=defaultAutoKill

Changes the start value of a Tweener and rewinds it without pausing. This method has no effect on Tweeners within Sequences and is not applicable to tweens that animate more than a single value (like `DOLookAt`).

```csharp
ChangeStartValue(newStartValue, float duration = -1)
```

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=From

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

```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
Callback

### Endpoint
OnStart

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **callback** (TweenCallback) - Required - The callback function to execute when the tween starts.

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

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### DOPunchCharScale

Source: https://dotween.demigiant.com/documentation.php?api=From

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. Returns NULL if the charIndex is invalid or the character isn't visible.

```APIDOC
## DOTweenTMPAnimator.DOPunchCharScale

### 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
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **Tween** - A reference to the created tween.

#### Response Example
None
```

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

### OnStart

Source: https://dotween.demigiant.com/documentation.php?api=DOTween.useSafeMode

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

```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
Chained Method

### Parameters
#### Callback Parameters
- **callback** (TweenCallback) - Required - The function to execute when the tween first starts.
```

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

### OnStart Callback

Source: https://dotween.demigiant.com/documentation.php?api=Init

Sets a callback that fires once when the tween begins playing for the first time, after any delay.

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

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

### DOPunchCharRotation

Source: https://dotween.demigiant.com/documentation.php?api=From

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. Returns NULL if the charIndex is invalid or the character isn't visible.

```APIDOC
## DOTweenTMPAnimator.DOPunchCharRotation

### 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
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **Tween** - A reference to the created tween.

#### Response Example
None
```

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

### DOPunchCharOffset

Source: https://dotween.demigiant.com/documentation.php?api=From

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. Returns NULL if the charIndex is invalid or the character isn't visible.

```APIDOC
## DOTweenTMPAnimator.DOPunchCharOffset

### 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
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **Tween** - A reference to the created tween.

#### Response Example
None
```

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

### Transform Movement and Restart Example

Source: https://dotween.demigiant.com/documentation.php?api=SetAutoKill

Shows how to move a transform along the X-axis and restart a tween using DOTween shortcuts.

```csharp
transform.DOMoveX(100, 1);
```

```csharp
transform.DORestart();
```

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

### DOPunchCharScale

Source: https://dotween.demigiant.com/documentation.php?api=Insert

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. Returns NULL if the charIndex is invalid or the character isn't visible.

```APIDOC
## DOTweenTMPAnimator.DOPunchCharScale

### 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
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
Returns a `Tween` reference or `NULL`.

#### Response Example
None
```

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

### DOPunchCharRotation

Source: https://dotween.demigiant.com/documentation.php?api=Insert

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. Returns NULL if the charIndex is invalid or the character isn't visible.

```APIDOC
## DOTweenTMPAnimator.DOPunchCharRotation

### 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
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
Returns a `Tween` reference or `NULL`.

#### Response Example
None
```

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

### DOPunchCharOffset

Source: https://dotween.demigiant.com/documentation.php?api=Insert

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. Returns NULL if the charIndex is invalid or the character isn't visible.

```APIDOC
## DOTweenTMPAnimator.DOPunchCharOffset

### 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
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
Returns a `Tween` reference or `NULL`.

#### Response Example
None
```

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

### Create a DOTween Sequence with Chaining

Source: https://dotween.demigiant.com/documentation.php?api=Init

Shows how to chain multiple sequence operations together for more concise code. This example includes movement, rotation, interval, and scale tweens.

```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()));
```

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

### Tween LineRenderer Color with DOTween

Source: https://dotween.demigiant.com/documentation.php?api=DOTween.timeScale

Tweens the color of a LineRenderer. This method requires explicit start and end colors as LineRenderers cannot retrieve them directly. Use the Color2 struct to manage start and end colors.

```csharp
public static Tweener DOColor(this LineRenderer target, Color2 startValue, Color2 endValue, float duration);
```

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

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

### Create a DOTween Sequence with Multiple Operations

Source: https://dotween.demigiant.com/documentation.php?api=Init

Demonstrates creating a sequence and adding various tweens, intervals, and callbacks in a specific order.

```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()));
```

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

### Change Tweener Start and End Values

Source: https://dotween.demigiant.com/documentation.php?api=defaultAutoKill

Changes both the start and end values of a Tweener and rewinds it without pausing. This method has no effect on Tweeners within Sequences and is not applicable to tweens that animate more than a single value (like `DOLookAt`).

```csharp
ChangeValues(newStartValue, newEndValue, float duration = -1)
```

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

### ForceInit

Source: https://dotween.demigiant.com/documentation.php?api=DOTween.useSafeMode

Forces the initialization of a tween, making its data available immediately.

```APIDOC
## ForceInit

### Description
Forces the tween to initialize its settings immediately. Useful for accessing data that is only available after initialization, like PathLength.

### Method
POST

### Endpoint
/ForceInit

### Response
#### Success Response (200)
- **status** (string) - Indicates success.

### Response Example
{
  "status": "initialized"
}
```

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

### SetUpdate

Source: https://dotween.demigiant.com/documentation.php?api=SetAs

Specifies the update type (Normal, Late, Fixed, Manual) for the tween and optionally allows it to ignore Unity's timeScale and maximumDeltaTime.

```APIDOC
## SetUpdate

### Description
Controls when and how a tween updates, allowing selection of update types (Normal, Late, Fixed, Manual) and independent time scaling.

### Method
Chained method

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **updateType** (UpdateType) - The type of update: `Normal`, `Late`, `Fixed`, or `Manual`.
- **isIndependentUpdate** (bool) - If TRUE, the tween ignores Unity's `Time.timeScale` and `maximumDeltaTime`. Defaults to FALSE.

### Request Example
```csharp
transform.DOMoveX(4, 1).SetUpdate(UpdateType.Late, true);
```

### Response
#### Success Response (200)
None (this is a configuration method)

#### Response Example
None
```

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

### From (T fromValue, bool setImmediately, bool isRelative)

Source: https://dotween.demigiant.com/documentation.php?api=SetAs

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.

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

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

### Method
Chained method

### Parameters
#### Path 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`.
```

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

### PlayAll/Play

Source: https://dotween.demigiant.com/documentation.php?api=SetLink

Resumes or starts the playback of the tween.

```APIDOC
## PlayAll/Play

### Description
Plays the tween.

### Method
POST (or equivalent for SDK)

### Endpoint
/PlayAll/Play

### Response
#### Success Response (200)
- **status** (string) - Indicates success.
```

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

### Configure Tween Update Type

Source: https://dotween.demigiant.com/documentation.php?api=Init

SetUpdate specifies the update type (Normal, Late, Fixed, Manual) and whether the tween should ignore Unity's timeScale. This setting is ignored for tweens nested within Sequences.

```csharp
transform.DOMoveX(4, 1).SetUpdate(UpdateType.Late, true);
```

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

### Wait for DOTween Tween Start in Coroutine

Source: https://dotween.demigiant.com/documentation.php?api=Init

Use WaitForStart() in a Coroutine to pause execution until a tween begins playing for the first time, after any initial delay. This is useful for synchronizing actions that must occur immediately upon animation start.

```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!");
}
```

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

### Change Tweener start and end values and rewind

Source: https://dotween.demigiant.com/documentation.php?api=SetTweensCapacity

Use ChangeValues() to update both the start and end values of a Tweener and rewind it without pausing. This method is not effective for Tweeners within Sequences and is not suitable for tweens that animate more than one value, such as DOLookAt.

```csharp
myTweener.ChangeValues(newStartValue, newEndValue, newDuration);
// Example with default duration:
myTweener.ChangeValues(newStartValue, newEndValue);
```

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

### Prepare Tween for Editor Preview

Source: https://dotween.demigiant.com/documentation.php?api=Init

Prepares a tween for preview in the Unity editor. Use this to set up tweens before starting the preview loop. You can control whether callbacks are cleared, auto-kill is prevented, and if the tween plays immediately.

```csharp
DOTweenEditorPreview.PrepareTweenForPreview(true, true, true);
```

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

### ForceInit

Source: https://dotween.demigiant.com/documentation.php?api=From

Forces a tween to initialize its settings immediately, useful for accessing data before initialization.

```APIDOC
## ForceInit

### Description
Forces the tween to initialize its settings immediately. This is useful for accessing tween data that is only available after initialization, such as PathLength.

### Method
ForceInit()

### Notes
Works from `Tween`, `Tweener`, or `Sequence` instances.
```

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

### Change Tweener start value and rewind

Source: https://dotween.demigiant.com/documentation.php?api=SetTweensCapacity

Use ChangeStartValue() to alter a Tweener's start value and rewind it without pausing. This method is ineffective for Tweeners inside Sequences and does not apply to tweens animating multiple values like DOLookAt.

```csharp
myTweener.ChangeStartValue(newStartValue, newDuration);
// Example with default duration:
myTweener.ChangeStartValue(newStartValue);
```

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

### ForceInit

Source: https://dotween.demigiant.com/documentation.php?api=defaultAutoKill

Forces the tween to initialize its settings immediately. Useful for accessing data not available until initialization, like PathLength.

```APIDOC
## ForceInit

### Description
Forces the tween to initialize its settings immediately. Useful for accessing data not available until initialization, like PathLength.

### Method
POST

### Endpoint
/ForceInit

### Response
#### Success Response (200)
- **status** (string) - Indicates success.

#### Response Example
```json
{
  "status": "success"
}
```
```

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

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

Source: https://dotween.demigiant.com/documentation.php?api=float+timeScale

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.

```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.**

### Parameters
#### Path 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`.
```

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

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

Source: https://dotween.demigiant.com/documentation.php?api=defaultRecyclable

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.

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

### Method
Chained method

### Parameters
#### Path 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. Defaults to true.
- **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`. Defaults to false.

### Request Example
```csharp
// Example usage would depend on the specific type T
```
```

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

### ForceInit

Source: https://dotween.demigiant.com/documentation.php?api=float+timeScale

Forces the tween to initialize its settings immediately. Useful for retrieving data that becomes available only after initialization.

```APIDOC
## ForceInit

### Description
Forces the tween to initialize its settings immediately. This is useful for accessing tween data that is only available after initialization, such as PathLength.

### Method
POST (or similar, depending on SDK implementation)

### Endpoint
/tweens/forceInit

### Response
#### Success Response (200)
- **status** (string) - Indicates success.

#### Response Example
{
  "status": "initialized"
}
```

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

### Initialize DOTween with Custom Settings and Capacity

Source: https://dotween.demigiant.com/documentation.php?api=Init

Initialize DOTween with custom settings for recycling, safe mode, and logging, and immediately set the initial capacity for tweeners and sequences. This provides more control over DOTween's behavior and resource management.

```csharp
DOTween.Init(true, true, LogBehaviour.Verbose).SetCapacity(200, 10);
```

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

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

Source: https://dotween.demigiant.com/documentation.php?api=Init

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.

```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.**

### Parameters
#### Path 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. Defaults to true.
- **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`. Defaults to false.
```

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

### ForceInit

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

Forces the tween to initialize its settings immediately. Useful for accessing data not available until initialization.

```APIDOC
## ForceInit

### Description
Forces the tween to initialize its settings immediately. Useful for accessing data not available until initialization.

### Method
POST

### Endpoint
/ForceInit

### Response
#### Success Response (200)
- **status** (string) - Indicates success.
```

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

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

Source: https://dotween.demigiant.com/documentation.php?api=SetAutoKill

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.

```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.**

### Parameters
#### Query 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. Defaults to true.
- **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`. Defaults to false.
```
Tokens:
Raw