# CapsulecastCommand

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

## Definition

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

```csharp
public struct CapsulecastCommand
```

## Remarks

When you use this struct to schedule a batch of capsule casts, the capsule casts are performed asynchronously and in parallel. The results of each capsule cast is 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.

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

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

Additional Resources: [Physics.CapsuleCast](/engine/6000.7/script-reference/unityengine/physics/capsulecast.md)

## Examples

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

public class CapsulecastExample : MonoBehaviour
{
    void Start()
    {
        // Perform a single capsule cast using CapsulecastCommand 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<CapsulecastCommand>(1, Allocator.TempJob);

        // Set the data of the first command
        Vector3 point1 = Vector3.up * -0.5f;
        Vector3 point2 = Vector3.up * 0.5f;
        Vector3 direction = Vector3.forward;
        float radius = 0.5f;

        commands[0] = new CapsulecastCommand(point1, point2, radius, direction, QueryParameters.Default);

        // Schedule the batch of capsulecasts
        var handle = CapsulecastCommand.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.7/script-reference/unityengine/capsulecastcommand/queryparameters.md) | Structure for specifying additional parameters for a batch query such as layer mask, hit triggers and hit backfaces. |

## Constructors

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

## Properties

| Property                                                                                       | Description                                                 |
| ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| [direction](/engine/6000.7/script-reference/unityengine/capsulecastcommand/direction.md)       | The direction of the capsule cast.                          |
| [distance](/engine/6000.7/script-reference/unityengine/capsulecastcommand/distance.md)         | The maximum distance the capsule cast checks for collision. |
| [physicsScene](/engine/6000.7/script-reference/unityengine/capsulecastcommand/physicsscene.md) | The physics scene this command is run in.                   |
| [point1](/engine/6000.7/script-reference/unityengine/capsulecastcommand/point1.md)             | The center of the sphere at the `start` of the capsule.     |
| [point2](/engine/6000.7/script-reference/unityengine/capsulecastcommand/point2.md)             | The center of the sphere at the `end` of the capsule.       |
| [radius](/engine/6000.7/script-reference/unityengine/capsulecastcommand/radius.md)             | The radius of the capsule.                                  |

## Static Methods

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