point | The center of the box. |
size | The size of the box. |
angle | The angle of the box. |
layerMask | 特定レイヤーのオブジェクトのみを判定するフィルター |
minDepth | この値よりも大きな Z 座標(深度)にあるオブジェクトのみを含む |
maxDepth | この値よりも小さな Z 座標(深度)のオブジェクトのみを含む |
Collider2D The Collider overlapping the box.
Checks if a Collider falls within a box area.
ボックスはワールド空間の中心座標やサイズにより定義されます。オプションとして layerMask を設定することで特定レイヤーのオブジェクトのみを検出することができます。
Although the Z axis is not relevant for rendering or collisions in 2D, you can use the minDepth and maxDepth parameters to filter objects based on their Z coordinate. If more than one Collider falls within the box then the one returned will be the one with the lowest Z coordinate value. Null is returned if there are no Colliders in the box.
See Also: OverlapBoxAll, OverlapBoxNonAlloc.
point | The center of the box. |
size | The size of the box. |
angle | The angle of the box. |
contactFilter | The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing. |
results | The array to receive results. The size of the array determines the maximum number of results that can be returned. |
int
Returns the number of results placed in the results
array.
Checks if a Collider falls within a box area.
The box is defined by its center coordinate in world space and by its size.
This function returns the number of Colliders found and places those Colliders in the results
array. The results can also be filtered by the contactFilter
. Note that filtering by normal angle is not available for overlap functions.
point | The center of the box. |
size | The size of the box. |
angle | The angle of the box. |
contactFilter | The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing. |
results | The list to receive results. |
int
Returns the number of results placed in the results
list.
Checks if a Collider falls within a box area.
The box is defined by its center coordinate in world space and by its size.
The integer return value is the number of results written into the results
list. The results list will be resized if it doesn't contain enough elements to report all the results. This prevents memory from being allocated for results when the results
list does not need to be resized, and improves garbage collection performance when the query is performed frequently.
The results can also be filtered by the contactFilter
.
Note that filtering by normal angle is not available for overlap functions.
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.