Method DestroyEntity

DestroyEntity(Int32, Entity)

Records a command to destroy an entity.

Declaration

public void DestroyEntity(int sortKey, Entity e)

Parameters

Type	Name	Description
Int32	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, Int32, Boolean, in v128).
Entity	e	The entity to destroy.

Remarks

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

Exceptions

Type	Condition
NullReferenceException	Throws if an Allocator was not passed in when the EntityCommandBuffer was created.

DestroyEntity(Int32, NativeArray<Entity>)

Records a command to destroy a NativeArray of entities.

Declaration

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

Parameters

Type	Name	Description
Int32	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, Int32, Boolean, in v128).
NativeArray<Entity>	entities	The NativeArray of entities to destroy.

Remarks

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 are still deferred or were destroyed between recording and playback, or if any of the entities have the Prefab tag.

Exceptions

Type	Condition
NullReferenceException	Throws if an Allocator was not passed in when the EntityCommandBuffer was created.