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

ColliderDistance2D.isValid

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 isValid;

Description

Gets whether the distance is valid or not.

When a function returns a ColliderDistance2D struct, it may not be valid because the Collider2D used as distance references were not valid in some way due to them being disabled or not having any valid shapes. This property indicates whether the other distance properties can be used and are valid or not.

See Also: Physics2D.Distance, Collider2D.Distance and Rigidbody2D.Distance.

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