AddSharedComponent
Records a command to add an unmanaged shared component value on an entity.
Read time 2 minutesLast updated 2 days ago
Definition
- Type: Method
- Namespace: Unity.Entities
- Assembly: UnityEngine.EntitiesModule
AddSharedComponent<T>(int, Entity, T)
Records a command to add an unmanaged shared component value on an entity.
public void AddSharedComponent<T>(int sortKey, Entity e, T sharedComponent) where T : unmanaged, ISharedComponentData
Parameters
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 IJobChunk.Execute.
The entity to add the shared component value to.
Remarks
At playback, this command throws an error if this entity is destroyed before playback, if adding this shared component exceeds the maximum number of shared components, or adding a component type makes the archetype too large.
AddSharedComponent<T>(int, NativeArray<Entity>, T)
Records a command to add an unmanaged shared component value on a NativeArray of entities.
public void AddSharedComponent<T>(int sortKey, NativeArray<Entity> entities, T sharedComponent) where T : unmanaged, ISharedComponentData
Parameters
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 IJobChunk.Execute.
The NativeArray of entities to add the shared component value to.
Remarks
At playback, this command throws an error if any entity is destroyed before playback, if adding this shared component exceeds the maximum number of shared components, or adding a component type makes the archetype too large.