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

EntityCommandBuffer.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(Entity e);

Parameters

Parameter Description
e The entity to destroy.

Description

Records a command to destroy an entity.

At playback, this command throws an error if the entity was destroyed between recording and playback, or if the entity has the Prefab tag.


Declaration

public void DestroyEntity(NativeArray<Entity> entities);

Parameters

Parameter Description
entities The NativeArray of entities to destroy.

Description

Records a command to destroy a NativeArray of entities.

At playback, this command only runs if the entity count is greater than 0. This command throws an error if any of the entities were destroyed between recording and playback, or if any of the entities have the Prefab tag.


Declaration

public void DestroyEntity(EntityQuery entityQuery, EntityQueryCaptureMode queryCaptureMode);

Parameters

Parameter Description
entityQuery The query specifying the entities to destroy.
queryCaptureMode Controls when the entities matching entityQuery are computed and captured.

Description

Records a command to destroy all entities matching a query.


Obsolete This method now takes an extra parameter to control when the query is evaluated. To preserve the current semantics, use EntityQueryCaptureMode.AtRecord (RemovedAfter Entities 2.0).

Declaration

public void DestroyEntity(EntityQuery entityQuery);

Parameters

Parameter Description
entityQuery The query specifying the entities to destroy.

Description

Obsolete. Use EntityCommandBuffer.DestroyEntity instead.