Version: 2017.1 (switch to 2017.2b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Vector3.SmoothDamp

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function SmoothDamp(current: Vector3, target: Vector3, ref currentVelocity: Vector3, smoothTime: float, maxSpeed: float = Mathf.Infinity, deltaTime: float = Time.deltaTime): Vector3;
public static Vector3 SmoothDamp(Vector3 current, Vector3 target, ref Vector3 currentVelocity, float smoothTime, float maxSpeed = Mathf.Infinity, float deltaTime = Time.deltaTime);

Parameters

current The current position.
target The position we are trying to reach.
currentVelocity The current velocity, this value is modified by the function every time you call it.
smoothTime Approximately the time it will take to reach the target. A smaller value will reach the target faster.
maxSpeed Optionally allows you to clamp the maximum speed.
deltaTime The time since the last call to this function. By default Time.deltaTime.

Description

Gradually changes a vector towards a desired goal over time.

The vector is smoothed by some spring-damper like function, which will never overshoot. The most common use is for smoothing a follow camera.

    // Smooth towards the target

var target : Transform; var smoothTime = 0.3; private var velocity = Vector3.zero;

function Update () { // Define a target position above and behind the target transform var targetPosition : Vector3 = target.TransformPoint(Vector3(0, 5, -10));

// Smoothly move the camera towards that target position transform.position = Vector3.SmoothDamp(transform.position, targetPosition, velocity, smoothTime); }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public Transform target; public float smoothTime = 0.3F; private Vector3 velocity = Vector3.zero; void Update() { Vector3 targetPosition = target.TransformPoint(new Vector3(0, 5, -10)); transform.position = Vector3.SmoothDamp(transform.position, targetPosition, ref velocity, smoothTime); } }