Version: 2021.2
LanguageEnglish
  • C#

Rigidbody2D.Distance

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

Switch to Manual

Declaration

public ColliderDistance2D Distance(Collider2D collider);

Parameters

collider A collider used to calculate the minimum distance against all colliders attached to this Rigidbody2D.

Returns

ColliderDistance2D The minimum distance of collider against all colliders attached to this Rigidbody2D.

Description

Calculates the minimum distance of this collider against all Collider2D attached to this Rigidbody2D.

The provided collider will be check against all Collider2D attached to this Rigidbody2D and the minimum distance from all attached Collider2D will be returned.

The provided collider and at least one Collider2D attached to this Rigidbody2D must be valid for the returned ColliderDistance2D to be valid i.e. the Collider2D should not be disabled and must contain collision shapes and the provided collider must not be NULL. You can check if the returned value is valid by checking ColliderDistance2D.isValid.

See Also: Physics2D.Distance and Collider2D.Distance.