Method AddComponentForEntityQuery
AddComponentForEntityQuery<T>(EntityCommandBuffer, EntityQuery, T)
Records a command to add a managed component and set its value for all entities matching a query.
Declaration
public static void AddComponentForEntityQuery<T>(this EntityCommandBuffer ecb, EntityQuery query, T component)
where T : class, IComponentDataParameters
| Type | Name | Description |
|---|---|---|
| EntityCommandBuffer | ecb | |
| EntityQuery | query | The query specifying which entities to add the component value to. |
| T | component | The component value to add. |
Type Parameters
| Name | Description |
|---|---|
| T |
Remarks
The set of entities matching the query is 'captured' in the method call, and the recorded command stores an array of all these entities.
Entities which already have the component type will have the component set to the value.
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | Thrown in playback if one or more of the entities has been destroyed. (With safety checks disabled, playback will perform invalid and unsafe memory access.). |
| NullReferenceException | Throws if an Allocator was not passed in when the EntityCommandBuffer was created. |
| InvalidOperationException | Throws if this EntityCommandBuffer has already been played back. |