Method SetSharedComponent
SetSharedComponent<T>(int, Entity, T)
Records a command to set an unmanaged shared component value on an entity.
Declaration
public void SetSharedComponent<T>(int sortKey, Entity e, T sharedComponent) where T : unmanaged, ISharedComponentDataParameters
| Type | Name | Description |
|---|---|---|
| int | sortKey | A unique index for each set of commands added to this EntityCommandBuffer across all parallel jobs writing commands to this buffer. The ChunkIndexInQuery provided by IJobEntity is an appropriate value to use for this parameter. In an IJobChunk pass the 'unfilteredChunkIndex' value from Execute(in ArchetypeChunk, int, bool, in v128). |
| Entity | e | The entity to set the shared component value of. |
| T | sharedComponent | The shared component value to set. |
Type Parameters
| Name | Description |
|---|---|
| T | The type of shared component to set. |
Remarks
At playback, this command throws an error if this entity is destroyed before playback, if this entity is still deferred, if the entity has the Prefab tag, 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>(int, 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 sharedComponent) where T : unmanaged, ISharedComponentDataParameters
| Type | Name | Description |
|---|---|---|
| int | sortKey | A unique index for each set of commands added to this EntityCommandBuffer across all parallel jobs writing commands to this buffer. The ChunkIndexInQuery provided by IJobEntity is an appropriate value to use for this parameter. In an IJobChunk pass the 'unfilteredChunkIndex' value from Execute(in ArchetypeChunk, int, bool, in v128). |
| NativeArray<Entity> | entities | The NativeArray of entities to set the shared component value of. |
| T | sharedComponent | The shared component value to set. |
Type Parameters
| Name | Description |
|---|---|
| T | The type of shared component to set. |
Remarks
At playback, this command throws an error if any entity is destroyed before playback, if any entity is still deferred, if any entity has the Prefab tag, 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. |