Add EntityCommands.retain and EntityWorldMut.retain
#10873
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…red functionality of remove and retain, with the added bonus of less safety invariants outside of this function.
| } | ||
|
|
||
| /// Removes any components in the [`Bundle`] from the entity. | ||
| // TODO: BundleRemover? |
There was a problem hiding this comment.
This TODO isn't clear to me.
There was a problem hiding this comment.
I don't know what this todo is referring to, it was already on remove so I left it there
There was a problem hiding this comment.
Going back through the commits looks like it's referring to a potential API to aggregate Bundle operations into builder APIs like a BundleRemover cause it also appears on other bundle operations.
alice-i-cecile
requested changes
Dec 5, 2023
…`retain_nothing` checking clearing an entity (with `()`) and `retain_some_components` checking normal behaviour, including retaining a component that isn't on the entity.
alice-i-cecile
approved these changes
Dec 5, 2023
alice-i-cecile
added
A-ECS
iiYese
approved these changes
Dec 5, 2023
alice-i-cecile
added
the
S-Ready-For-Final-Review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
Adds
EntityCommands.retainandEntityWorldMut.retainto remove all components except the given bundle from the entity.Fixes #10865.
Solution
I added a private unsafe function in
EntityWorldMutcalledremove_bundle_infowhich performs the shared behaviour ofremoveandretain, namely taking aBundleInfoof components to remove, and removing them from the given entity. Thenretainsimply gets all the components on the entity and filters them by whether they are in the bundle it was passed, before passing thisBundleInfointoremove_bundle_info.EntityCommands.retainjust creates a new typeRetainwhich runsEntityWorldMut.retainwhen run.Changelog
Added
EntityCommands.retainandEntityWorldMut.retain, which remove all components except the given bundle from the entity, they can also be used to remove all components by passing()as the bundle.