mirror of
https://github.com/bevyengine/bevy
synced 2024-11-22 20:53:53 +00:00
Document EntityMut::remove()
(#6168)
# Objective - Fixes #5990 ## Solution - Add docs for `EntityMut::remove()` explaining its return value.
This commit is contained in:
parent
29098b7a11
commit
2a6b544a0a
1 changed files with 3 additions and 0 deletions
|
@ -277,6 +277,9 @@ impl<'w> EntityMut<'w> {
|
|||
}
|
||||
|
||||
// TODO: move to BundleInfo
|
||||
/// Removes a [`Bundle`] of components from the entity and returns the bundle.
|
||||
///
|
||||
/// Returns `None` if the entity does not contain the bundle.
|
||||
pub fn remove<T: Bundle>(&mut self) -> Option<T> {
|
||||
let archetypes = &mut self.world.archetypes;
|
||||
let storages = &mut self.world.storages;
|
||||
|
|
Loading…
Reference in a new issue