Unity - Scripting API: BoxcastCommand

struct in UnityEngine

/

Implemented in:UnityEngine.PhysicsModule

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

Description

Use this struct to set up a box cast command to be performed asynchronously during a job.

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

The result for a command at index N in the command buffer is stored at index N in the results buffer.

See Also: Physics.Boxcast.

Properties

centerCenter of the box.
directionThe direction in which to sweep the box.
distanceThe maximum distance of the sweep.
halfExtentsHalf the size of the box in each dimension.
layerMaskA LayerMask that is used to selectively ignore Colliders when casting a box.
orientationRotation of the box.
physicsSceneThe physics scene this command is run in.

Constructors

Static Methods

ScheduleBatchSchedules a batch of boxcasts to be performed in a job.