Unity - Scripting API: CapsulecastCommand

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 capsule cast command that is performed asynchronously during a job.

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 result for a command at index N in the command buffer is stored at index N in the results buffer.

See Also: Physics.Capsulecast.

Properties

directionThe direction of the capsule cast.
distanceThe maximum distance the capsule cast checks for collision.
layerMaskA LayerMask that selectively ignores Colliders when casting a capsule.
physicsSceneThe physics scene this command is run in.
point1The center of the sphere at the start of the capsule.
point2The center of the sphere at the end of the capsule.
radiusThe radius of the capsule.

Constructors

Static Methods

ScheduleBatchSchedules a batch of capsule casts which are performed in a job.