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.
CloseFor 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.
Closeorigin | The center of the sphere at the start of the sweep. |
radius | The radius of the sphere. |
direction | The direction in which to sweep the sphere. |
maxDistance | The max length of the sweep. |
layerMask | A Layer mask that is used to selectively ignore colliders when casting a sphere. |
queryTriggerInteraction | Specifies whether this query should hit Triggers. |
RaycastHit[] An array of all colliders hit in the sweep.
Like Physics.SphereCast, but this function will return all hits the sphere sweep intersects.
Casts a sphere against all colliders in the Scene and returns detailed information on each collider which was hit.
This is useful when a Raycast does not give enough precision, because you want to find out if an object of a specific size,
such as a character, will be able to move somewhere without colliding with anything on the way.
Notes: For colliders that overlap the sphere at the start of the sweep, RaycastHit.normal is set opposite to the direction of the sweep, RaycastHit.distance is set to zero, and the zero vector gets returned in RaycastHit.point. You might want to check whether this is the case in your particular query and perform additional queries to refine the result. Passing a zero radius results in undefined output and doesn't always behave the same as Physics.Raycast.
Additional resources: Physics.SphereCast, Physics.CapsuleCast, Physics.Raycast, Rigidbody.SweepTest.
ray | The starting point and direction of the ray into which the sphere sweep is cast. |
radius | The radius of the sphere. |
maxDistance | The max length of the sweep. |
layerMask | A Layer mask that is used to selectively ignore colliders when casting a sphere. |
queryTriggerInteraction | Specifies whether this query should hit Triggers. |
Like Physics.SphereCast, but this function will return all hits the sphere sweep intersects.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.