Method ToComponentDataListAsync

ToComponentDataListAsync<T>(AllocatorManager.AllocatorHandle, out 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>.

Declaration

[GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[]{typeof(BurstCompatibleComponentData)})]
public NativeList<T> ToComponentDataListAsync<T>(AllocatorManager.AllocatorHandle allocator, out JobHandle outJobHandle)
    where T : struct, IComponentData

Parameters

Type	Name	Description
AllocatorManager.AllocatorHandle	allocator	The type of memory to allocate.
JobHandle	outJobHandle	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`1, use AsDeferredJobArray().

Type Parameters

Name	Description
T	The component type.

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 ToComponentDataListAsync<T>(AllocatorManager.AllocatorHandle, out JobHandle).

Exceptions

Type	Condition
InvalidOperationException	Thrown if T is not part of the query.

ToComponentDataListAsync<T>(AllocatorManager.AllocatorHandle, JobHandle, out 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>.

Declaration

[GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[]{typeof(BurstCompatibleComponentData)})]
public NativeList<T> ToComponentDataListAsync<T>(AllocatorManager.AllocatorHandle allocator, JobHandle additionalInputDep, out JobHandle outJobHandle)
    where T : struct, IComponentData

Parameters

Type	Name	Description
AllocatorManager.AllocatorHandle	allocator	The type of memory to allocate.
JobHandle	additionalInputDep	A job handle which the newly scheduled job will depend upon, in addition to the dependencies automatically determined by the component safety system.
JobHandle	outJobHandle	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`1, use AsDeferredJobArray().

Type Parameters

Name	Description
T	The component type.

Exceptions

Type	Condition
InvalidOperationException	Thrown if T is not part of the query.