DestroyEntity
Destroy all entities having a common set of component types.
Read time 2 minutesLast updated 2 days ago
Definition
- Type: Method
- Namespace: Unity.Entities
- Assembly: UnityEngine.EntitiesModule
DestroyEntity(EntityQuery)
Destroy all entities having a common set of component types.
public void DestroyEntity(EntityQuery entityQuery)
Parameters
Defines the components an entity must have to qualify for destruction.
Remarks
Since entities in the same chunk share the same component structure, this function effectively destroys the chunks holding any entities identified by the parameter.
entityQueryFilterIf any entities matching the query have the LinkedEntityGroup component, this operation will fail if any entities in a LinkedEntityGroup buffer do not also match the query.
DestroyEntity(NativeArray<Entity>)
Destroys all entities in an array.
public void DestroyEntity(NativeArray<Entity> entities)
Parameters
An array containing the Entity objects of the entities to destroy.
Remarks
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before destroying the entity. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.
DestroyEntity(NativeSlice<Entity>)
Destroys all entities in a slice of an array.
public void DestroyEntity(NativeSlice<Entity> entities)
Parameters
The slice of an array containing the Entity objects of the entities to destroy.
Remarks
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before destroying the entity. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.
DestroyEntity(Entity)
Destroys an entity.
public void DestroyEntity(Entity entity)
Parameters
The Entity object of the entity to destroy.
Remarks
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before destroying the entity. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.