Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


OverlapCapsuleAll(Vector2, Vector2, CapsuleDirection2D, float, int, float, float)

Get a list of all Colliders that fall within a capsule area.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule
public static Collider2D[] OverlapCapsuleAll(Vector2 point, Vector2 size, CapsuleDirection2D direction, float angle, int layerMask, float minDepth, float maxDepth)

Parameters

point

The center of the capsule.

The size of the capsule.

The direction of the capsule.

angle

The 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.

Returns

Type

Description

Collider2D[]The cast results returned.

Remarks

This function is similar to Physics2D.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.
Additional Resources: Physics2D.OverlapCapsule, OverlapCapsuleNonAlloc.