Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

Physics2D.Distance

Other Versions
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

public static method Distance(colliderA: Collider2D, colliderB: Collider2D): ColliderDistance2D;
public static ColliderDistance2D Distance(Collider2D colliderA, Collider2D colliderB);

Parameters

colliderAA collider used to calculate the minimum distance against colliderB.
colliderBA collider used to calculate the minimum distance against colliderA.

Returns

ColliderDistance2D The minimum distance between colliderA and colliderB.

Description

Calculates the minimum distance between two colliders.

A valid colliderA and colliderB must be provided for the returned ColliderDistance2D to be valid i.e. both colliderA or colliderB should not be NULL, should not be disabled and must contain collision shapes. You can check if the returned value is valid by checking ColliderDistance2D.isValid.

See Also: Collider2D.Distance and Rigidbody2D.Distance.

Did you find this page useful? Please give it a rating:

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 © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information