Select your preferred scripting language. All code snippets will be displayed in this language.
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.
Close| point | Center of the capsule. |
| size | Size of the capsule. |
| direction | The direction of the capsule. |
| angle | Angle of the capsule. |
| layerMask | Filter to check objects only on specific layers. |
| minDepth | Only include objects with a Z coordinate (depth) greater than this value. |
| maxDepth | Only include objects with a Z coordinate (depth) less than this value. |
Collider2D[] The cast results returned.
Get a list of all colliders that fall within a capsule area.
This function is similar to OverlapCapsule except that all colliders that fall within the capsule are returned. The colliders in the returned array are sorted in order of increasing Z coordinate. An empty array is returned if there are no colliders within the box.
Note that this function will allocate memory for the returned Collider2D array. You can use OverlapCapsuleNonAlloc to avoid this overhead if you need to make the check frequently.
See Also: OverlapCapsule, OverlapCapsuleNonAlloc.