Select your preferred scripting language. All code snippets will be displayed in this language.
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.
Closepoint | A point in world space. |
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. |
Check if a collider overlaps a point in space.
The optional layerMask allows the test to check only for objects on specific layers.
Although the Z axis is not relevant for rendering or collisions in 2D, you can use the minDepth and maxDepth parameters to filter objects based on their Z coordinate. If more than one collider overlaps the point then the one returned will be the one with the lowest Z coordinate value. Null is returned if there are no colliders over the point.Note that this function will allocate memory for the returned Collider2D object. You can use OverlapPointNonAlloc to avoid this overhead if you need to make the check frequently.See Also: OverlapArea, OverlapCircle, OverlapPointAll, OverlapPointNonAlloc.