Struct used to set up an overlap box command to be performed asynchronously during a job.
When you use this struct to schedule a batch of overlap box commands, the commands are performed asynchronously. The results of the overlap box are written to the results buffer. Because the results are written asynchronously, the results buffer can't be accessed until the job is complete.
The results for a command at index N in the command buffer are stored at index N * maxHits in the results buffer.
If maxHits is larger than the actual number of results for the command the result buffer will contain some invalid results which did not hit anything. The first invalid result is identified by the collider instance ID being 0. The second and later invalid results are not written to the overlap box command so their collider instance IDs are not guaranteed to be 0. When iterating over the results the loop should stop when the first invalid result is found.
Overlap box command also controls whether or not Trigger colliders generate a hit. You should adjust maxHits and result array size accordingly to store all hits. Use QueryParameters to control hit flags. QueryParameters.hitBackfaces and QueryParameters.hitMultipleFaces flags are not supported and won’t have any impact on overlap results.
Note: Only BatchQuery.ExecuteOverlapBoxJob is logged into the profiler. Query count information is not logged.
See Also: Physics.OverlapBox, ColliderHit.
using Unity.Collections; using UnityEngine;
public class BoxOverlap : MonoBehaviour { //Print names of GameObjects inside the box void BatchOverlapBox() { var commands = new NativeArray<OverlapBoxCommand>(1, Allocator.TempJob); var results = new NativeArray<ColliderHit>(3, Allocator.TempJob);
commands[0] = new OverlapBoxCommand(Vector3.zero, Vector3.one, Quaternion.identity, QueryParameters.Default);
OverlapBoxCommand.ScheduleBatch(commands, results, 1, 3).Complete();
foreach (var hit in results) Debug.Log(hit.collider.name);
commands.Dispose(); results.Dispose(); } }
center | The center of the box. |
halfExtents | 各軸についてのボックスサイズの半分 |
orientation | The orientation of the box. |
physicsScene | The physics scene this command is run in. |
queryParameters | Structure for specifying additional parameters for a batch query such as layer mask or hit triggers. |
OverlapBoxCommand | Create an OverlapBoxCommand. |
ScheduleBatch | Schedule a batch of overlap box commands to perform in a job. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.