Method DestroyEntity
DestroyEntity(EntityQuery)
Destroy all entities having a common set of component types.
Declaration
public void DestroyEntity(EntityQuery entityQuery)
Parameters
Type | Name | Description |
---|---|---|
Entity |
entityQuery | 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 entityQueryFilter
parameter.
If any entities matching the query have the Linked
Exceptions
Type | Condition |
---|---|
Argument |
Thrown if this operation would not destroy all entities in all
Linked |
DestroyEntity(NativeArray<Entity>)
Destroys all entities in an array.
Declaration
public void DestroyEntity(NativeArray<Entity> entities)
Parameters
Type | Name | Description |
---|---|---|
Native |
entities | 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.
Declaration
public void DestroyEntity(NativeSlice<Entity> entities)
Parameters
Type | Name | Description |
---|---|---|
Native |
entities | 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.
Declaration
public void DestroyEntity(Entity entity)
Parameters
Type | Name | Description |
---|---|---|
Entity | entity | 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.