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

EntityCommandBuffer.ParallelWriter.DestroyEntity

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 DestroyEntity(int sortKey, Entity e);

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 destroy.

Description

Records a command to destroy an entity.

At playback, this command will throw an error if any of the entities were destroyed between recording and playback, or if the entity has the Prefab tag.


Declaration

public void DestroyEntity(int sortKey, NativeArray<Entity> entities);

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 destroy.

Description

Records a command to destroy a NativeArray of entities.

At playback, this command will do nothing if entities has a count of 0. This command will throw an error if any of the entities were destroyed between recording and playback, or if any of the entities have the Prefab tag.