forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve EntityWorldMut.remove, retain and despawn docs by linking to more detail (#10943)

Browse Source 
## Solution

`Commands.remove` and `.retain` (because I copied `remove`s doc)
referenced `EntityWorldMut.remove` and `retain` for more detail but the
`Commands` docs are much more detailed (which makes sense because it is
the most common api), so I have instead inverted this so that
`EntityWorldMut` docs link to `Commands`.

I also made `EntityWorldMut.despawn` reference `World.despawn` for more
details, like `Commands.despawn` does.
This commit is contained in:
TheBigCheese 2023-12-12 19:27:11 +00:00 committed by GitHub
parent 4b1865f8bd
commit 6a15ed564d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
crates/bevy_ecs/src/system/commands/mod.rs
View File

@ -812,9 +812,6 @@ impl<'w, 's, 'a> EntityCommands<'w, 's, 'a> {
/// Removes a [`Bundle`] of components from the entity. /// Removes a [`Bundle`] of components from the entity.
/// ///
/// See [`EntityWorldMut::remove`](EntityWorldMut::remove) for more
/// details.
///
/// # Example /// # Example
/// ///
/// ``` /// ```
@ -912,9 +909,6 @@ impl<'w, 's, 'a> EntityCommands<'w, 's, 'a> {
/// ///
/// This can also be used to remove all the components from the entity by passing it an empty Bundle. /// This can also be used to remove all the components from the entity by passing it an empty Bundle.
/// ///
/// See [`EntityWorldMut::retain`](EntityWorldMut::retain) for more
/// details.
///
/// # Example /// # Example
/// ///
/// ``` /// ```

6
crates/bevy_ecs/src/world/entity_ref.rs
View File

@ -889,6 +889,8 @@ impl<'w> EntityWorldMut<'w> {
} }
/// Removes any components in the [`Bundle`] from the entity. /// Removes any components in the [`Bundle`] from the entity.
///
/// See [`EntityCommands::remove`](crate::system::EntityCommands::remove) for more details.
// TODO: BundleRemover? // TODO: BundleRemover?
pub fn remove<T: Bundle>(&mut self) -> &mut Self { pub fn remove<T: Bundle>(&mut self) -> &mut Self {
let archetypes = &mut self.world.archetypes; let archetypes = &mut self.world.archetypes;
@ -920,6 +922,8 @@ impl<'w> EntityWorldMut<'w> {
} }
/// Removes any components except those in the [`Bundle`] from the entity. /// Removes any components except those in the [`Bundle`] from the entity.
///
/// See [`EntityCommands::retain`](crate::system::EntityCommands::retain) for more details.
pub fn retain<T: Bundle>(&mut self) -> &mut Self { pub fn retain<T: Bundle>(&mut self) -> &mut Self {
let archetypes = &mut self.world.archetypes; let archetypes = &mut self.world.archetypes;
let storages = &mut self.world.storages; let storages = &mut self.world.storages;
@ -961,6 +965,8 @@ impl<'w> EntityWorldMut<'w> {
} }
/// Despawns the current entity. /// Despawns the current entity.
///
/// See [`World::despawn`] for more details.
pub fn despawn(self) { pub fn despawn(self) {
debug!("Despawning entity {:?}", self.entity); debug!("Despawning entity {:?}", self.entity);
let world = self.world; let world = self.world;