Unity - Scripting API: PhysicsScene.BoxCast
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.
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.
Parameters
| Parameter | Description |
|---|---|
| center | Center of the box. |
| halfExtents | Half the size of the box in each dimension. |
| direction | The direction in which to cast the box. |
| hitInfo | If true is returned, hitInfo will contain more information about where the collider was hit. (Additional resources: RaycastHit). |
| orientation | Rotation of the box. |
| maxDistance | The max length of the cast. |
| layerMask | A Layer mask that is used to selectively ignore colliders when casting a capsule. |
| queryTriggerInteraction | Specifies whether this query should hit Triggers. |
Returns
bool True, if any intersections were found.
Description
Casts the box along a ray and returns detailed information on what was hit.
Declaration
public int BoxCast(Vector3 center, Vector3 halfExtents, Vector3 direction, RaycastHit[] results, Quaternion orientation = Quaternion.identity, float maxDistance = Mathf.Infinity, int layerMask = DefaultRaycastLayers, QueryTriggerInteraction queryTriggerInteraction = QueryTriggerInteraction.UseGlobal);
Parameters
| Parameter | Description |
|---|---|
| center | Center of the box. |
| halfExtents | Half the size of the box in each dimension. |
| direction | The direction in which to cast the box. |
| results | The buffer to store the results in. |
| orientation | Rotation of the box. |
| maxDistance | The max length of the cast. |
| layerMask | A Layer mask that is used to selectively ignore colliders when casting a capsule. |
| queryTriggerInteraction | Specifies whether this query should hit Triggers. |
Returns
int
The amount of hits stored to the results buffer.
Description
Casts the box along a ray and returns detailed information on what was hit.