Legacy Documentation: Version 2017.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

Physics.BoxCast

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 static function BoxCast(center: Vector3, halfExtents: Vector3, direction: Vector3, orientation: Quaternion = Quaternion.identity, maxDistance: float = Mathf.Infinity, layerMask: int = DefaultRaycastLayers, queryTriggerInteraction: QueryTriggerInteraction = QueryTriggerInteraction.UseGlobal): bool;
public static bool BoxCast(Vector3 center, Vector3 halfExtents, Vector3 direction, Quaternion orientation = Quaternion.identity, float maxDistance = Mathf.Infinity, int layerMask = DefaultRaycastLayers, QueryTriggerInteraction queryTriggerInteraction = QueryTriggerInteraction.UseGlobal);

Parameters

center Center of the box.
halfExtents Half the size of the box in each dimension.
direction The direction in which to cast the box.
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.

public static function BoxCast(center: Vector3, halfExtents: Vector3, direction: Vector3, out hitInfo: RaycastHit, orientation: Quaternion = Quaternion.identity, maxDistance: float = Mathf.Infinity, layerMask: int = DefaultRaycastLayers, queryTriggerInteraction: QueryTriggerInteraction = QueryTriggerInteraction.UseGlobal): bool;
public static bool BoxCast(Vector3 center, Vector3 halfExtents, Vector3 direction, out RaycastHit hitInfo, Quaternion orientation = Quaternion.identity, float maxDistance = Mathf.Infinity, int layerMask = DefaultRaycastLayers, QueryTriggerInteraction queryTriggerInteraction = QueryTriggerInteraction.UseGlobal);

Parameters

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. (See Also: 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.

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 © 2017 Unity Technologies. Publication: 2017.1-001R. Built: 2017-10-06.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information