Documentation

Unity Engine


Unity Engine


DestroyEntity

Records a command to destroy an entity.
Read time 1 minuteLast updated 3 days ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule

DestroyEntity(int, Entity)

Records a command to destroy an entity.
public void DestroyEntity(int sortKey, Entity e)

Parameters

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.

The entity to destroy.

Remarks

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.

DestroyEntity(int, NativeArray<Entity>)

Records a command to destroy a NativeArray of entities.
public void DestroyEntity(int sortKey, NativeArray<Entity> entities)

Parameters

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.

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