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.
CloseFor 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.
Closecollider | A collider used to calculate the minimum distance against all colliders attached to this Rigidbody2D. |
ColliderDistance2D
The minimum distance of collider
against all colliders attached to this Rigidbody2D.
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.
Additional resources: Physics2D.Distance and Collider2D.Distance.
thisPosition | The position to use for this Rigidbody. |
thisAngle | The rotation to use for this Rigidbody. |
collider | A collider used to calculate the minimum separation against this Rigidbody. |
position | The position to use for the specified collider . |
angle | The rotation to use for the specified collider . |
ColliderDistance2D
The minimum distance of collider
against all colliders attached to this Rigidbody2D.
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.
NOTE: The positions and angles used here represent the position of the Rigidbody2D the respective Collider2D is attached to. If the Collider2D is offset from the center of mass then the Collider2D will use the same offset. This can be confusing so it is recommened that only Collider2D that align with the center of mass are used. If not then you must take this into account. If the specified collider
is not attached to a Rigidbody2D, this call cannot be used and will result in a warning.
Additional resources: Physics2D.Distance and Collider2D.Distance.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.