Version: 2022.3
LanguageEnglish
  • C#

CapsulecastCommand.ScheduleBatch

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

Declaration

public static Unity.Jobs.JobHandle ScheduleBatch(NativeArray<CapsulecastCommand> commands, NativeArray<RaycastHit> results, int minCommandsPerJob, int maxHits, Unity.Jobs.JobHandle dependsOn);

Parameters

commands A NaviveArray of CapsulecastCommands to perform.
results A NavtiveArray of RaycastHit where the result of commands are stored.
minCommandsPerJob The minimum number of commands to perform in a single job.
dependsOn A jobHandle of a job that must be completed before performing capsule casts.
maxHits The maximum number of Colliders the CapsuleCast can hit.

Returns

JobHandle Returns a JobHandle of the job that will performs the capsule casts.

Description

Schedules a batch of capsule casts to perform in a job.


Declaration

public static Unity.Jobs.JobHandle ScheduleBatch(NativeArray<CapsulecastCommand> commands, NativeArray<RaycastHit> results, int minCommandsPerJob, Unity.Jobs.JobHandle dependsOn);

Parameters

commands A NaviveArray of CapsulecastCommands to perform.
results A NavtiveArray of RaycastHit where the result of commands are stored.
minCommandsPerJob The minimum number of commands to perform in a single job.
dependsOn A jobHandle of a job that must be completed before performing capsule casts.

Returns

JobHandle Returns a JobHandle of the job that will performs the capsule casts.

Description

Schedules a batch of capsule casts to perform in a job.

By default maxHits in this variant is set to 1.