# SpherecastCommand

> Use this struct to set up a sphere cast command that is performed asynchronously during a job.

## Definition

* **Type:** Struct
* **Namespace:** [UnityEngine](/engine/6000.0/script-reference/unityengine.md)
* **Assembly:** UnityEngine.PhysicsModule

```csharp
public struct SpherecastCommand
```

## Remarks

When you use this struct to schedule a batch of sphere casts, the sphere casts are performed asynchronously and in parallel. The results of each sphere casts are written to the results buffer. Since the results are written asynchronously, you cannot access the results buffer until the job is completed.

The results for a command at index N in the command buffer are stored at index N \* maxHits in the results buffer.

Spherecast command also allows you to control whether or not Trigger colliders and back-face triangles generate a hit. Use [QueryParameters](/engine/6000.0/script-reference/unityengine/queryparameters.md) to control hit flags.

Note: Only BatchQuery.ExecuteSpherecastJob is logged into the profiler. Query count information is not logged.

Additional Resources: [Spherecast](/engine/6000.0/script-reference/unityengine/physics/spherecast.md).

## Examples

```csharp
using Unity.Collections;
using Unity.Jobs;
using UnityEngine;

public class SpherecastExample : MonoBehaviour
{
    void Start()
    {
        // Perform a single sphere cast using SpherecastCommand and wait for it to complete
        // Set up the command and result buffers
        var results = new NativeArray<RaycastHit>(2, Allocator.TempJob);
        var commands = new NativeArray<SpherecastCommand>(1, Allocator.TempJob);

        // Set the data of the first command
        Vector3 origin = Vector3.forward * -10;
        Vector3 direction = Vector3.forward;
        float radius = 0.5f;

        commands[0] = new SpherecastCommand(origin, radius, direction, QueryParameters.Default);

        // Schedule the batch of sphere casts
        var handle = SpherecastCommand.ScheduleBatch(commands, results, 1, 2, default(JobHandle));

        // Wait for the batch processing job to complete
        handle.Complete();

        // If batchedHit.collider is not null there was a hit
        foreach (var hit in results)
        {
            if (hit.collider != null)
            {
                // Do something with results
            }
        }

        // Dispose the buffers
        results.Dispose();
        commands.Dispose();
    }
}
```

## Fields

| Value                                                                                               | Description                                                                                                          |
| --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| [queryParameters](/engine/6000.0/script-reference/unityengine/spherecastcommand/queryparameters.md) | Structure for specifying additional parameters for a batch query such as layer mask, hit triggers and hit backfaces. |

## Constructors

| Constructor                                                                                                                                                                                                                                                                                        | Description                  |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| [SpherecastCommand(UnityEngine.PhysicsScene,UnityEngine.Vector3,System.Single,UnityEngine.Vector3,UnityEngine.QueryParameters,System.Single)](/engine/6000.0/script-reference/unityengine/spherecastcommand/ctor.md#spherecastcommand\(physicsscene-vector3-float-vector3-queryparameters-float\)) | Creates a SpherecastCommand. |
| [SpherecastCommand(UnityEngine.Vector3,System.Single,UnityEngine.Vector3,UnityEngine.QueryParameters,System.Single)](/engine/6000.0/script-reference/unityengine/spherecastcommand/ctor.md#spherecastcommand\(vector3-float-vector3-queryparameters-float\))                                       | Creates a SpherecastCommand. |

## Properties

| Property                                                                                      | Description                                                  |
| --------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| [direction](/engine/6000.0/script-reference/unityengine/spherecastcommand/direction.md)       | The direction of the sphere cast.                            |
| [distance](/engine/6000.0/script-reference/unityengine/spherecastcommand/distance.md)         | The maximum distance the sphere should check for collisions. |
| [origin](/engine/6000.0/script-reference/unityengine/spherecastcommand/origin.md)             | The starting point of the sphere cast in world coordinates.  |
| [physicsScene](/engine/6000.0/script-reference/unityengine/spherecastcommand/physicsscene.md) | The physics scene this command is run in.                    |
| [radius](/engine/6000.0/script-reference/unityengine/spherecastcommand/radius.md)             | The radius of the casting sphere.                            |

## Static Methods

| Method                                                                                          | Description                                            |
| ----------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| [ScheduleBatch](/engine/6000.0/script-reference/unityengine/spherecastcommand/schedulebatch.md) | Schedules a batch of sphere casts to perform in a job. |