Remove components from an entity
To remove components from an entity, use the EntityManager
for the World that the entity is in.
Important
Removing a component from an entity is a structural change which means that the entity moves to a different archetype chunk.
From the main thread
You can directly remove components from an entity from the main thread. The following code sample gets every entity with an attached Rotation
component and then removes the Rotation
component.
public partial struct RemoveComponentSystemExample : ISystem
{
public void OnCreate(ref SystemState state)
{
var query = state.GetEntityQuery(typeof(Rotation));
state.EntityManager.RemoveComponent<Rotation>(query);
}
}
From a job
Because removing a component from an entity is a structural change, you can't directly do it in a job. Instead, you must use an EntityCommandBuffer
to record your intention to remove components later.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.