Version: 2023.1
LanguageEnglish
  • C#

OverlapBoxCommand.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<OverlapBoxCommand> commands, NativeArray<ColliderHit> results, int minCommandsPerJob, int maxHits, Unity.Jobs.JobHandle dependsOn);

Parameters

commands A NativeArray of the OverlapBoxCommands to perform.
results A NativeArray of the ColliderHits where the results of the commands are stored.
minCommandsPerJob The minimum number of commands to perform in a single job.
maxHits The maximum number of Colliders the overlap can hit.
dependsOn A JobHandle of a job which must be completed before the overlap box starts.

Returns

JobHandle The JobHandle of the job which will perform the overlap box.

Description

Schedule a batch of overlap box commands to perform in a job.