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

EntityCommandBuffer.RemoveComponent

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

Parameters

Parameter Description
e The entity to have the component removed.

Description

Records a command to remove component of type T from an entity.

At playback, it's not an error if the entity doesn't have component T. Will throw an error if this entity is destroyed before playback, or if T is type Entity or Prefab.


Declaration

public void RemoveComponent(NativeArray<Entity> entities);

Parameters

Parameter Description
entities The NativeArray of entities to have the component removed.

Description

Records a command to remove component of type T from a NativeArray of entities.

At playback, it's not an error if any entity doesn't have component T. Will throw an error if one of these entities is destroyed before playback, or if T is type Entity or Prefab.


Declaration

public void RemoveComponent(Entity e, ComponentType componentType);

Parameters

Parameter Description
e The entity to have the component removed.
componentType The type of component to remove.

Description

Records a command to remove a component from an entity.

At playback, it's not an error if the entity doesn't have the component type. Will throw an error if this entity is destroyed before playback, or if the component type is Entity or Prefab.


Declaration

public void RemoveComponent(NativeArray<Entity> entities, ComponentType componentType);

Parameters

Parameter Description
entities The NativeArray of entities to have the component removed.
componentType The type of component to remove.

Description

Records a command to remove one or more components from a NativeArray of entities.

At playback, it's not an error if any entity doesn't have the component type. Will throw an error if one of these entities is destroyed before playback, or if the component type is Entity or Prefab.


Declaration

public void RemoveComponent(Entity e, ref ComponentTypeSet componentTypeSet);

Parameters

Parameter Description
e The entity to have components removed.
componentTypeSet The types of components to remove.

Description

Records a command to remove one or more components from an entity.

At playback, it's not an error if the entity doesn't have one of the component types. Will throw an error if this entity is destroyed before playback, or if any of the component types are Entity or Prefab.


Declaration

public void RemoveComponent(NativeArray<Entity> entities, ref ComponentTypeSet componentTypeSet);

Parameters

Parameter Description
entities The NativeArray of entities to have components removed.
componentTypeSet The types of components to remove.

Description

Records a command to remove one or more components from a NativeArray of entities.

At playback, it's not an error if any entity doesn't have one of the component types. Will throw an error if one of these entities is destroyed before playback, or if any of the component types are Entity or Prefab.


Declaration

public void RemoveComponent(EntityQuery entityQuery, ComponentType componentType, EntityQueryCaptureMode queryCaptureMode);

Parameters

Parameter Description
entityQuery The query specifying the entities from which the component is removed.
componentType The types of component to remove.
queryCaptureMode Controls when the entities matching entityQuery are computed and captured.

Description

Records a command to remove a component from all entities matching a query.

Does not affect entities already missing the component.


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 RemoveComponent(EntityQuery entityQuery, ComponentType componentType);

Parameters

Parameter Description
entityQuery The query specifying the entities to which the component is added.
componentType The type of component to add.

Description

Obsolete. Use EntityCommandBuffer.RemoveComponent instead.


Declaration

public void RemoveComponent(EntityQuery entityQuery, EntityQueryCaptureMode queryCaptureMode);

Parameters

Parameter Description
entityQuery The query specifying the entities from which the component is removed.
queryCaptureMode Controls when the entities matching entityQuery are computed and captured.

Description

Records a command to remove a component from all entities matching a query.

Does not affect entities already missing the component.


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 RemoveComponent(EntityQuery entityQuery);

Parameters

Parameter Description
entityQuery The query specifying the entities to which the component is added.

Description

Obsolete. Use EntityCommandBuffer.RemoveComponent instead.


Declaration

public void RemoveComponent(EntityQuery entityQuery, ref ComponentTypeSet componentTypeSet, EntityQueryCaptureMode queryCaptureMode);

Parameters

Parameter Description
entityQuery The query specifying the entities from which the components are removed.
componentTypeSet The types of components to remove.
queryCaptureMode Controls when the entities matching entityQuery are computed and captured.

Description

Records a command to remove multiple components from all entities matching a query.

The set of entities matching the query is 'captured' in the method call, and the recorded command stores an array of all these entities.

Some matching entities may already be missing some or all of the specified components. After this operation, all matching entities will have none of the components.

At playback, this command throws an error if one of these entities is destroyed before playback. (With safety checks enabled, an exception is thrown. Without safety checks, playback will perform invalid and unsafe memory access.)


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 RemoveComponent(EntityQuery entityQuery, ref ComponentTypeSet componentTypeSet);

Parameters

Parameter Description
entityQuery The query specifying the entities from which the components are removed.
componentTypeSet The types of components to remove.

Description

Obsolete. Use EntityCommandBuffer.RemoveComponent instead.