Version: 2019.1 (switch to 2018.3 or 2017.4)
LanguageEnglish
  • C#

PhysicsScene.OverlapBox

Other Versions
Leave feedback
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 int OverlapBox(Vector3 center, Vector3 halfExtents, Collider[] results, Quaternion orientation = Quaternion.identity, int layerMask = DefaultRaycastLayers, QueryTriggerInteraction queryTriggerInteraction = QueryTriggerInteraction.UseGlobal);

Parameters

centerCenter of the box.
halfExtentsHalf of the size of the box in each dimension.
resultsThe buffer to store the results in.
orientationRotation of the box.
layerMaskA Layer mask that is used to selectively ignore colliders when casting a ray.
queryTriggerInteractionSpecifies whether this query should hit Triggers.

Returns

int The amount of colliders stored in results.

Description

Find all colliders touching or inside of the given box, and store them into the buffer.

See Also: Physics.OverlapBoxNonAlloc.

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2019 Unity Technologies. Publication: 2019.1-002V. Built: 2019-04-15.
TutorialsCommunity AnswersKnowledge BaseForumsAsset Store