Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

MoveTowards(Vector3, Vector3, float)

Moves vector incrementally towards a target point.
Read time 2 minutesLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public static Vector3 MoveTowards(Vector3 current, Vector3 target, float maxDistanceDelta)

Parameters

current

Vector3
The position to move from.

target

Vector3
The position to move towards.

maxDistanceDelta

float
Distance to move current per call.

Returns

Type

Description

Vector3The new position.

Remarks

This method moves a vector from 
current
to 
target
points, moving no farther each call than the distance specified by 
maxDistanceDelta
.
By updating an object's position each frame using the position calculated by this function, you can move it towards the target smoothly.
Control the speed of movement with the 
maxDistanceDelta
parameter. To make sure that object speed is independent of frame rate, multiply the 
maxDistanceDelta
value by Time.deltaTime (or Time.fixedDeltaTime in a 
FixedUpdate
loop).
If the 
current
position is already closer to the 
target
than 
maxDistanceDelta
, the value returned is equal to 
target
. This method doesn't overshoot 
target
.
You can set 
maxDistanceDelta
to a negative value to move away from 
target
.

Examples

// To run this example, create a cube GameObject positioned at the origin of the scene. // Attach this script to the cube. //// This example creates a cylinder GameObject that becomes the target position for the // cube. When the cube reaches the cylinder, the cylinder is re-positioned to the // initial location of the cube. The cube then changes direction and moves towards the // cylinder again.using UnityEngine;public class MoveTowardsExample : MonoBehaviour{    // Adjust the speed for the application.    public float speed = 1.0f;    // The target (cylinder) position.    private Transform target;    void Awake()    {        // Position the cube at the origin.        transform.position = new Vector3(0.0f, 0.0f, 0.0f);        // Create and position the cylinder. Reduce the diameter.        GameObject cylinder = GameObject.CreatePrimitive(PrimitiveType.Cylinder);        cylinder.transform.localScale = new Vector3(0.15f, 1.0f, 0.15f);        // Set target value to cylinder position.        target = cylinder.transform;        target.transform.position = new Vector3(0.8f, 0.0f, 0.8f);        // Position the camera.        Camera.main.transform.position = new Vector3(0.85f, 1.0f, -3.0f);        Camera.main.transform.localEulerAngles = new Vector3(15.0f, -20.0f, -0.5f);        // Create and position the floor.        GameObject floor = GameObject.CreatePrimitive(PrimitiveType.Plane);        floor.transform.position = new Vector3(0.0f, -1.0f, 0.0f);    }    void Update()    {        // Move our position a step closer to the target.        float step =  speed * Time.deltaTime; // calculate distance to move        transform.position = Vector3.MoveTowards(transform.position, target.position, step);        // Check if the position of the cube and sphere are approximately equal.        if (Vector3.Distance(transform.position, target.position) < 0.001f)        {            // Reset the target position to the original object position.            target.position *= -1.0f;        }    }}