| point | The center of the box. |
| size | The size of the box. |
| angle | The angle of the box. |
| layerMask | Filter to check objects only on specific layers. |
| contactFilter | The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. |
Collider2D The collider overlapping the box.
Checks a box against Colliders in the PhysicsScene2D, returning the first intersection only.
An "OverlapBox" is conceptually like looking at the Scene through a box shape to determine what can be seen. Any Collider2D seen can be detected and reported.
This function returns a Collider2D that overlaps the box or NULL if nothing overlaps.
The layerMask can be used to detect objects selectively only on certain layers (this allows you to apply the detection only to enemy characters, for example). Overloads of this method that use contactFilter can filter the results by the options available in ContactFilter2D.
Additional resources: PhysicsScene2D, LayerMask, Physics2D.DefaultRaycastLayers, Physics2D.IgnoreRaycastLayer, Physics2D.queriesHitTriggers.
| point | The center of the box. |
| size | The size of the box. |
| angle | The angle of the box. |
| results | The array to receive results. The size of the array determines the maximum number of results that can be returned. |
| layerMask | Filter to check objects only on specific layers. |
| contactFilter | The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. |
int
Returns the number of results placed in the results array.
Checks a box against Colliders in the PhysicsScene2D, returning all intersections.
An "OverlapBox" is conceptually like looking at the Scene through a box shape to determine what can be seen. Any Collider2D seen can be detected and reported.
This function returns an array of Collider2D that overlap the box.
The integer return value is the number of objects that intersect the box (possibly zero) but the results array will not be resized if it doesn't contain enough elements to report all the results. The significance of this is that no memory is allocated for the results and so garbage collection performance is improved. Note that you will always get zero results if you pass an empty array.
The layerMask can be used to detect objects selectively only on certain layers (this allows you to apply the detection only to enemy characters, for example). Overloads of this method that use contactFilter can filter the results by the options available in ContactFilter2D.
Additional resources: PhysicsScene2D, LayerMask, Physics2D.DefaultRaycastLayers, Physics2D.IgnoreRaycastLayer, Physics2D.queriesHitTriggers.
| 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 and Z depth. Note that the 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 a box against Colliders in the PhysicsScene2D, returning all intersections.
An "OverlapBox" is conceptually like looking at the Scene through a box shape to determine what can be seen. Any Collider2D seen can be detected and reported.
This function returns an array of Collider2D that overlap the box.
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.