Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

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

Physics2D.OverlapBox

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

Submission failed

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

Close

Cancel

public static function OverlapBox(point: Vector2, size: Vector2, angle: float, layerMask: int = DefaultRaycastLayers, minDepth: float = -Mathf.Infinity, maxDepth: float = Mathf.Infinity): Collider2D;
public static Collider2D OverlapBox(Vector2 point, Vector2 size, float angle, int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity);

Parameters

point Center of the box.
size Size of the box.
angle Angle of the box.
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

Collider2D The cast results returned.

Description

Check if a collider falls within a box area.

The box is defined by its center coordinate in world space and by its size. 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 falls within the box then the one returned will be the one with the lowest Z coordinate value. Null is returned if there are no colliders in the box.

See Also: OverlapCircle, OverlapArea, OverlapPoint, OverlapBoxAll, OverlapBoxNonAlloc.

Copyright © 2016 Unity Technologies. Publication 5.5-001B
Tutorials Community Answers Knowledge Base Forums Asset Store