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 failedFor 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 Your name Your email Suggestion* DescriptionStruct 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.
Additional resources: Physics.OverlapBox, ColliderHit.
Properties Property Description center The center of the box. halfExtents Half of the size of the box in each dimension. 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. Static Methods Method Description ScheduleBatch Schedule a batch of overlap box commands to perform in a job.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4