Method SetSharedComponent
SetSharedComponent<T>(Int32, Entity, T)
Records a command to set a shared component value on an entity.
Declaration
public void SetSharedComponent<T>(int sortKey, Entity e, T component)
where T : struct, ISharedComponentData
Parameters
Type | Name | Description |
---|---|---|
Int32 | sortKey | A unique index for each set of commands added to this EntityCommandBuffer
across all parallel jobs writing commands to this buffer. The |
Entity | e | The entity to set the shared component value of. |
T | component | The shared component value to set. |
Type Parameters
Name | Description |
---|---|
T | The type of shared component to set. |
Remarks
Behavior at Playback: Will throw an error if this entity is destroyed before playback, if this entity is still deferred, or if the entity doesn't have the shared component type.
Exceptions
Type | Condition |
---|---|
NullReferenceException | Throws if an Allocator was not passed in when the EntityCommandBuffer was created. |
SetSharedComponent<T>(Int32, NativeArray<Entity>, T)
Records a command to set a shared component value on a NativeArray of entities.
Declaration
public void SetSharedComponent<T>(int sortKey, NativeArray<Entity> entities, T component)
where T : struct, ISharedComponentData
Parameters
Type | Name | Description |
---|---|---|
Int32 | sortKey | A unique index for each set of commands added to this EntityCommandBuffer
across all parallel jobs writing commands to this buffer. The |
NativeArray<Entity> | entities | The NativeArray of entities to set the shared component value of. |
T | component | The shared component value to set. |
Type Parameters
Name | Description |
---|---|
T | The type of shared component to set. |
Remarks
Behavior at Playback: Will throw an error if any entity is destroyed before playback, if any entity is still deferred, or if any entity doesn't have the shared component type.
Exceptions
Type | Condition |
---|---|
NullReferenceException | Throws if an Allocator was not passed in when the EntityCommandBuffer was created. |