Version: 2018.1 (switch to 2018.2 or 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

RaycastCommand

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

Struct used to set up a raycast command to be performed asynchronously during a job.

When you use this struct to schedule a batch of raycasts, they will be performed asynchronously and in parallel to each other. The results of the raycasts are written to the results buffer. Since the results are written asynchronously the results buffer cannot be accessed until the job has been completed.

The result for a command at index N in the command buffer will be 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 being null. The second and later invalid results are not written to by the raycast command so their colliders are not guaranteed to be null. When iterating over the results the loop should stop when the first invalid result is found.

See Also: Physics.Raycast, Physics.RaycastAll.

no example available in JavaScript
// Perform a single raycast using RaycastCommand and wait for it to complete
// Setup the command and result buffers
var results = new NativeArray<RaycastHit>(1, Allocator.Temp);
var commands = new NativeArray<RaycastCommand>(1, Allocator.Temp);

// Set the data of the first command Vector3 origin = Vector3.forward * -10; Vector3 direction = Vector3.forward;

commands[0] = new RaycastCommand(origin, direction);

// Schedule the batch of raycasts var handle = RaycastCommand.ScheduleBatch(commands, results, 1);

// Wait for the batch processing job to complete handle.Complete();

// Copy the result. If batchedHit.collider is null there was no hit RaycastHit batchedHit = results[0];

// Dispose the buffers results.Dispose(); commands.Dispose();

Properties

directionThe direction of the ray.
distanceThe maximum distance the ray should check for collisions.
fromThe starting point of the ray in world coordinates.
layerMaskA LayerMask that is used to selectively ignore Colliders when casting a ray.
maxHitsThe maximum number of Colliders the ray can hit.

Constructors

RaycastCommandCreate a RaycastCommand.

Static Methods

ScheduleBatchSchedule a batch of raycasts which are performed in a job.

Did you find this page useful? Please give it a rating: