Unity - Scripting API: PhysicsScene.OverlapCapsule
Success!
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.
Submission failed
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.
Declaration
public int OverlapCapsule(Vector3 point0, Vector3 point1, float radius, Collider[] results, int layerMask = AllLayers, QueryTriggerInteraction queryTriggerInteraction = QueryTriggerInteraction.UseGlobal);
Parameters
| Parameter | Description |
|---|---|
| point0 | The center of the sphere at the start of the capsule. |
| point1 | The center of the sphere at the end of the capsule. |
| radius | The radius of the capsule. |
| results | The buffer to store the results into. |
| layerMask | A Layer mask that is used to selectively filter which colliders are considered when casting a capsule. |
| queryTriggerInteraction | Specifies whether this query should hit Triggers. |
Returns
int The amount of entries written to the buffer.
Description
Check the given capsule against the physics world and return all overlapping colliders in the user-provided buffer.
Additional resources: Physics.OverlapCapsuleNonAllloc.