Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

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

Mathf.MoveTowards

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again 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 MoveTowards(current: float, target: float, maxDelta: float): float;
public static float MoveTowards(float current, float target, float maxDelta);
public static def MoveTowards(current as float, target as float, maxDelta as float) as float

Parameters

current The current value.
target The value to move towards.
maxDelta The maximum change that should be applied to the value.

Description

Moves a value current towards target.

This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta. Negative values of maxDelta pushes the value away from target.

var currStrength: float;
var maxStrength: float;
var recoveryRate: float;

function Update() { currStrength = Mathf.MoveTowards(currStrength, maxStrength, recoveryRate * Time.deltaTime); }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public float currStrength;
    public float maxStrength;
    public float recoveryRate;
    void Update() {
        currStrength = Mathf.MoveTowards(currStrength, maxStrength, recoveryRate * Time.deltaTime);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public currStrength as float

	public maxStrength as float

	public recoveryRate as float

	def Update() as void:
		currStrength = Mathf.MoveTowards(currStrength, maxStrength, (recoveryRate * Time.deltaTime))