OverlapCapsule
Checks a capsule against Colliders in the PhysicsScene2D, returning the first intersection only.
Read time 6 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.Physics2DModule
OverlapCapsule(Vector2, Vector2, CapsuleDirection2D, float, int)
Checks a capsule against Colliders in the PhysicsScene2D, returning the first intersection only.
public Collider2D OverlapCapsule(Vector2 point, Vector2 size, CapsuleDirection2D direction, float angle, int layerMask = -5)
Parameters
The center of the capsule.
The size of the capsule.
The direction of the capsule.
The angle of the capsule.
Filter to check objects only on specific layers.
Returns
Type | Description |
|---|---|
| Collider2D | The collider overlapping the capsule. |
Remarks
An "OverlapCapsule" is conceptually like looking at the Scene through a capsule shape to determine what can be seen. Any Collider2D seen can be detected and reported.
This function returns a Collider2D that overlaps the capsule or NULL if nothing overlaps.
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). Overloads of this method that use contactFilter can filter the results by the options available in ContactFilter2D.
Additional Resources: PhysicsScene2D, LayerMask, Physics2D.DefaultRaycastLayers, Physics2D.IgnoreRaycastLayer, Physics2D.queriesHitTriggers.
OverlapCapsule(Vector2, Vector2, CapsuleDirection2D, float, ContactFilter2D)
Checks a capsule against Colliders in the PhysicsScene2D, returning the first intersection only.
public Collider2D OverlapCapsule(Vector2 point, Vector2 size, CapsuleDirection2D direction, float angle, ContactFilter2D contactFilter)
Parameters
The center of the capsule.
The size of the capsule.
The direction of the capsule.
The angle of the capsule.
The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing.
Returns
Type | Description |
|---|---|
| Collider2D | The collider overlapping the capsule. |
Remarks
An "OverlapCapsule" is conceptually like looking at the Scene through a capsule shape to determine what can be seen. Any Collider2D seen can be detected and reported.
This function returns a Collider2D that overlaps the capsule or NULL if nothing overlaps.
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). Overloads of this method that use contactFilter can filter the results by the options available in ContactFilter2D.
Additional Resources: PhysicsScene2D, LayerMask, Physics2D.DefaultRaycastLayers, Physics2D.IgnoreRaycastLayer, Physics2D.queriesHitTriggers.
OverlapCapsule(Vector2, Vector2, CapsuleDirection2D, float, Collider2D[], int)
Checks a capsule against Colliders in the PhysicsScene2D, returning all intersections.
public int OverlapCapsule(Vector2 point, Vector2 size, CapsuleDirection2D direction, float angle, Collider2D[] results, int layerMask = -5)
Parameters
The center of the capsule.
The size of the capsule.
The direction of the capsule.
The angle of the capsule.
The array to receive results. The size of the array determines the maximum number of results that can be returned.
Filter to check objects only on specific layers.
Returns
Type | Description |
|---|---|
| int | Returns the number of results placed in the results array. |
Remarks
An "OverlapCapsule" is conceptually like looking at the Scene through a capsule shape to determine what can be seen. Any Collider2D seen can be detected and reported.
This function returns an array of Collider2D that overlap the capsule.
The integer return value is the number of objects that intersect the capsule (possibly zero) but the results array will not be resized if it doesn't contain enough elements to report all the results. The significance of this is that no memory is allocated for the results and so garbage collection performance is improved. Note that you will always get zero results if you pass an empty array.
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). Overloads of this method that use contactFilter can filter the results by the options available in ContactFilter2D.
Additional Resources: PhysicsScene2D, LayerMask, Physics2D.DefaultRaycastLayers, Physics2D.IgnoreRaycastLayer, Physics2D.queriesHitTriggers.
OverlapCapsule(Vector2, Vector2, CapsuleDirection2D, float, ContactFilter2D, Collider2D[])
Checks a capsule against Colliders in the PhysicsScene2D, returning all intersections.
public int OverlapCapsule(Vector2 point, Vector2 size, CapsuleDirection2D direction, float angle, ContactFilter2D contactFilter, Collider2D[] results)
Parameters
The center of the capsule.
The size of the capsule.
The direction of the capsule.
The angle of the capsule.
The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing.
The array to receive results. The size of the array determines the maximum number of results that can be returned.
Returns
Type | Description |
|---|---|
| int | Returns the number of results placed in the results array. |
Remarks
An "OverlapCapsule" is conceptually like looking at the Scene through a capsule shape to determine what can be seen. Any Collider2D seen can be detected and reported.
This function returns an array of Collider2D that overlap the capsule.
The integer return value is the number of objects that intersect the capsule (possibly zero) but the results array will not be resized if it doesn't contain enough elements to report all the results. The significance of this is that no memory is allocated for the results and so garbage collection performance is improved. Note that you will always get zero results if you pass an empty array.
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). Overloads of this method that use contactFilter can filter the results by the options available in ContactFilter2D.
Additional Resources: PhysicsScene2D, LayerMask, Physics2D.DefaultRaycastLayers, Physics2D.IgnoreRaycastLayer, Physics2D.queriesHitTriggers.
OverlapCapsule(Vector2, Vector2, CapsuleDirection2D, float, ContactFilter2D, List<Collider2D>)
Checks a capsule against Colliders in the PhysicsScene2D, returning all intersections.
public int OverlapCapsule(Vector2 point, Vector2 size, CapsuleDirection2D direction, float angle, ContactFilter2D contactFilter, List<Collider2D> results)
Parameters
The center of the capsule.
The size of the capsule.
The direction of the capsule.
The angle of the capsule.
The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing.
The list to receive results.
Returns
Type | Description |
|---|---|
| int | Returns the number of results placed in the results list. |
Remarks
An "OverlapCapsule" is conceptually like looking at the Scene through a capsule shape to determine what can be seen. Any Collider2D seen can be detected and reported.
This function returns an array of Collider2D that overlap the capsule.
The integer return value is the number of results written into the results list. The results list will be resized if it doesn't contain enough elements to report all the results. This prevents memory from being allocated for results when the results list does not need to be resized, and improves garbage collection performance when the query is performed frequently.
The results can also be filtered by the contactFilter.