Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

EntityCommandBuffer.ParallelWriter.AddSharedComponent

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public void AddSharedComponent(int sortKey, Entity e, T sharedComponent);

Parameters

Parameter Description
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 IJobChunk.Execute.
e The entity to add the shared component value to.
sharedComponent The shared component value to add.

Description

Records a command to add an unmanaged shared component value on an entity.

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.


Declaration

public void AddSharedComponent(int sortKey, NativeArray<Entity> entities, T sharedComponent);

Parameters

Parameter Description
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 IJobChunk.Execute.
entities The NativeArray of entities to add the shared component value to.
sharedComponent The shared component value to add.

Description

Records a command to add an unmanaged shared component value on a NativeArray of entities.

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.