Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


SphereCastNonAlloc

Cast sphere along the direction and store the results into buffer.
Read time 2 minutesLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.PhysicsModule

SphereCastNonAlloc(Vector3, float, Vector3, RaycastHit[], float, int, QueryTriggerInteraction)

Cast sphere along the direction and store the results into buffer.
public static int SphereCastNonAlloc(Vector3 origin, float radius, Vector3 direction, RaycastHit[] results, float maxDistance, int layerMask, QueryTriggerInteraction queryTriggerInteraction)

Parameters

origin

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.

The buffer to save the hits into.

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.

Returns

Type

Description

intThe amount of hits stored into the results buffer.

Remarks

This is variant of Physics.SphereCastAll, but instead of allocating the array with the results of the query, it stores the results into the user-provided array. It will only compute as many hits as fit into the buffer, and store them in no particular order. It's not guaranteed that it will store only the closest hits. Generates no garbage.

SphereCastNonAlloc(Ray, float, RaycastHit[], float, int, QueryTriggerInteraction)

Cast sphere along the direction and store the results into buffer.
public static int SphereCastNonAlloc(Ray ray, float radius, RaycastHit[] results, float maxDistance, int layerMask, QueryTriggerInteraction queryTriggerInteraction)

Parameters

ray

The starting point and direction of the ray into which the sphere sweep is cast.

radius

The radius of the sphere.

The buffer to save the results to.

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.

Returns

Type

Description

intThe amount of hits stored into the results buffer.