Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

ToComponentDataListAsync

Creates (and asynchronously populates) a NativeList containing the value of component T for 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<T>.
Read time 2 minutesLast updated a day ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule

ToComponentDataListAsync<T>(AllocatorHandle, JobHandle)

Creates (and asynchronously populates) a NativeList containing the value of component 
T
for 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<T>.
public NativeList<T> ToComponentDataListAsync<T>(AllocatorManager.AllocatorHandle allocator, out JobHandle outJobHandle) where T : unmanaged, IComponentData

Parameters

allocator

AllocatorHandle
The type of memory to allocate.

outJobHandle

JobHandle
An 
out
parameter assigned a handle that you can use as a dependency for a Job that uses the output data.

Returns

Type

Description

NativeList<T>A list containing all the values of component type 
T
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<T>, use NativeList<T>.AsDeferredJobArray.

Remarks

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.ToComponentDataListAsync.

ToComponentDataListAsync<T>(AllocatorHandle, JobHandle, JobHandle)

Creates (and asynchronously populates) a NativeList containing the value of component 
T
for 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<T>.
public NativeList<T> ToComponentDataListAsync<T>(AllocatorManager.AllocatorHandle allocator, JobHandle additionalInputDep, out JobHandle outJobHandle) where T : unmanaged, IComponentData

Parameters

allocator

AllocatorHandle
The type of memory to allocate.

additionalInputDep

JobHandle
A job handle which the newly scheduled job will depend upon, in addition to the dependencies automatically determined by the component safety system.

outJobHandle

JobHandle
An 
out
parameter assigned a handle that you can use as a dependency for a Job that uses the output data.

Returns

Type

Description

NativeList<T>A list containing all the values of component type 
T
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<T>, use NativeList<T>.AsDeferredJobArray.