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.Close
For 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
|origin||The point in 2D space where the capsule originates.|
|size||The size of the capsule.|
|capsuleDirection||The direction of the capsule.|
|angle||The angle of the capsule (in degrees).|
|direction||Vector representing the direction to cast the capsule.|
|distance||The maximum distance over which to cast the capsule.|
|layerMask||Filter to detect Colliders only on certain 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.|
RaycastHit2D The cast results returned.
Casts a capsule against Colliders in the Scene, returning all Colliders that contact with it.
A CapsuleCast is conceptually like dragging a capsule through the Scene in a particular direction. Any object making contact with the capsule can be detected and reported.
This function is similar to the CapsuleCast function but instead of detecting just the first Collider that is hit, an array of all Colliders along the path of the capsule 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 capsule would touch the Collider. It also returns the centroid where the capsule would be positioned for it to contact at that point.
See Also: ContactFilter2D, LayerMask class, RaycastHit2D class, CapsuleCast, CapsuleCastNonAlloc, DefaultRaycastLayers, IgnoreRaycastLayer, raycastsHitTriggers.