Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

distance

The distance the physics query traversed before it detected a Collider2D.
Read time 1 minuteLast updated 13 days ago

Definition

  • Type: Property
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule
public float distance { get; set; }

Remarks

When the RaycastHit2D result is returned from a physics query, the 
distance
refers to the distance from the physics query start position to the position the physics query shape intersected as indicated by _centroid. For simple linecast or raycast queries, _point is used to calculate the distance.
Additional Resources: _fraction

Examples

using UnityEngine;public class ExampleClass : MonoBehaviour{    public Vector2 direction;    void Update()    {        // Cast a ray in the specified direction.        RaycastHit2D hit = Physics2D.Raycast(transform.position, direction);        // If we hit something that was less than 6 world units away then write a message.        if (hit && hit.distance < 6f)            Debug.Log("Hit something within range!");    }}