Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

EntityQuery.ToEntityListAsync

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 NativeList<Entity> ToEntityListAsync(AllocatorHandle allocator, out JobHandle outJobHandle);

Parameters

Parameter Description
allocator The type of memory to allocate.
outJobHandle An out parameter assigned a handle that you can use as a dependency for a Job that uses the output data.

Returns

NativeList<Entity> A list containing all the entities selected by the query. The contents of this list (including the list's Length property) must not be accessed before outJobHandle has been completed. To pass this list to a job that expects a NativeArray<T0>, use NativeList<T0>.AsDeferredJobArray.

Description

Creates (and asynchronously populates) a NativeList containing the selected entities. Since the exact number of entities matching the query won't be known until the job runs, this method returns a NativeList<T0>.

This function is provided to handle cases that require a single linear indexable array of entities which match a query. If your goal is to iterate over entities to perform a per-entity operation, consider using IJobEntity or idiomatic foreach to iterate over the entities directly in their chunks, instead of creating a temporary copy.

The job scheduled by this call will automatically use the component safety system to determine its input dependencies, to avoid the most common race conditions. If additional input dependencies are required beyond what the component safety system knows about, use EntityQuery.ToEntityListAsync.


Declaration

public NativeList<Entity> ToEntityListAsync(AllocatorHandle allocator, JobHandle additionalInputDep, out JobHandle outJobHandle);

Parameters

Parameter Description
allocator The type of memory to allocate.
additionalInputDep A job handle which the newly scheduled job will depend upon, in addition to the dependencies automatically determined by the component safety system.
outJobHandle An out parameter assigned a handle that you can use as a dependency for a Job that uses the output data.

Returns

NativeList<Entity> A list containing all the entities selected by the query. The contents of this list (including the list's Length property) must not be accessed before outJobHandle has been completed. To pass this list to a job that expects a NativeArray<T0>, use NativeList<T0>.AsDeferredJobArray.

Description

Creates (and asynchronously populates) a NativeList containing the selected entities. Since the exact number of entities matching the query won't be known until the job runs, this method returns a NativeList<T0>.

This function is provided to handle cases that require a single linear indexable array of entities matches a query. If your goal is to iterate over entities to perform a per-entity operation, consider using IJobEntity or idiomatic foreach to iterate over the entities directly in their chunks, instead of creating a temporary copy.