Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

OverlapCapsule(Vector3, Vector3, float, Collider[], int, QueryTriggerInteraction)

Check the given capsule against the physics world and return all overlapping colliders in the user-provided buffer.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.PhysicsModule
public int OverlapCapsule(Vector3 point0, Vector3 point1, float radius, Collider[] results, int layerMask = -1, QueryTriggerInteraction queryTriggerInteraction = QueryTriggerInteraction.UseGlobal)

Parameters

point0

Vector3
The center of the sphere at the 
start
of the capsule.

point1

Vector3
The center of the sphere at the 
end
of the capsule.

radius

float
The radius of the capsule.

results

Collider[]
The buffer to store the results into.

layerMask

int
A Layer mask that is used to selectively filter which colliders are considered when casting a capsule.

queryTriggerInteraction

QueryTriggerInteraction
Specifies whether this query should hit Triggers.

Returns

Type

Description

intThe amount of entries written to the buffer.

Remarks

Additional Resources: Physics.OverlapCapsuleNonAlloc