| origin | The point in 2D space where the box originates. |
| size | The size of the box. |
| angle | The angle of the box (in degrees). |
| direction | Vector representing the direction of the box. |
| distance | Maximum distance over which to cast the box. |
| layerMask | Filter to detect Colliders only on certain layers. |
| minDepth | Only include objects with a Z coordinate (depth) greater than or equal to this value. |
| maxDepth | Only include objects with a Z coordinate (depth) less than or equal to this value. |
RaycastHit2D[] The cast results returned.
Casts a box against colliders in the Scene, returning all colliders that contact with it.
A BoxCast is conceptually like dragging a box through the Scene in a particular direction. Any object making contact with the box can be detected and reported.
This function is similar to the BoxCast function but instead of detecting just the first collider that is hit, an array of all colliders along the path of the box is returned. The colliders in the array are sorted in order of distance from the origin point. 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).
The returned RaycastHit2D returns both the point and normal of the contact where the box would touch the collider. It also returns the centroid where the box would be positioned for it to contact at that point.
See Also: LayerMask class, RaycastHit2D class, BoxCast, BoxCastNonAlloc, DefaultRaycastLayers, IgnoreRaycastLayer, raycastsHitTriggers.
Did you find this page useful? Please give it a rating: