Version: 2021.3
LanguageEnglish
  • C#

Collider2D.Distance

Leave feedback
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

Declaration

public ColliderDistance2D Distance(Collider2D collider);

Parameters

collider A collider used to calculate the minimum separation against this collider.

Returns

ColliderDistance2D The minimum separation of collider and this collider.

Description

Calculates the minimum separation of this collider against another collider.

A valid collider must be provided for the ColliderDistance2D to be valid. If there are any problems with collider or this Collider2D such as they are disabled or do not contain any collision shapes then the separation will be invalid as indicated by ColliderDistance2D.isValid.

Additional resources: Physics2D.Distance and Rigidbody2D.Distance.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2024 Unity Technologies. Publication Date: 2024-11-02.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information