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

EntityCommandBuffer.ParallelWriter.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(int sortKey, Entity e);

Parameters

Parameter Description
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.
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(int sortKey, NativeArray<Entity> entities);

Parameters

Parameter Description
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.
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(int sortKey, Entity e, ComponentType componentType);

Parameters

Parameter Description
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.
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(int sortKey, NativeArray<Entity> entities, ComponentType componentType);

Parameters

Parameter Description
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.
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(int sortKey, Entity e, ref ComponentTypeSet typeSet);

Parameters

Parameter Description
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.
e The entity to have the components removed.
typeSet 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(int sortKey, NativeArray<Entity> entities, ref ComponentTypeSet typeSet);

Parameters

Parameter Description
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.
entities The NativeArray of entities to have components removed.
typeSet 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.