Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Physics2D.OverlapPoint

Suggest a change

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.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public static function OverlapPoint(point: Vector2, layerMask: int = DefaultRaycastLayers, minDepth: float = -Mathf.Infinity, maxDepth: float = Mathf.Infinity): Collider2D;
public static Collider2D OverlapPoint(Vector2 point, int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity);

Parameters

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

Description

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.

See Also: OverlapArea, OverlapCircle, OverlapPointAll, OverlapPointNonAlloc.

Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information