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

EntityCommandBuffer.ParallelWriter.SetSharedComponent

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 SetSharedComponent(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 set the shared component value of.
sharedComponent The shared component value to set.

Description

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

At playback, this command throws an error if this entity is destroyed before playback, if the entity has the Prefab tag, or if the entity doesn't have the shared component type.


Declaration

public void SetSharedComponent(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 set the shared component value of.
sharedComponent The shared component value to set.

Description

Records a command to set a shared component value on a NativeArray of entities.

At playback, this command throws an error if any entity is destroyed before playback, if any entity has the Prefab tag, or if any entity doesn't have the shared component type.