Version: 2018.3 (switch to 2019.1)
LanguageEnglish
  • C#

ColliderDistance2D.isOverlapped

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 bool isOverlapped;

Description

Gets whether the distance represents an overlap or not.

The distance can be positive indicating that the Collider2D are separated (not overlapped), zero indicating that they are touching (but not overlapped) or negative indicating that they are overlapped.

This property is therefore a check to see if distance is negative which indicates the Collider2D are overlapped.

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