Skip to content

Commit

Permalink
Update docs for Updated, Changed and Mutated (#451)
Browse files Browse the repository at this point in the history
Update docs for Updated, Changed and Mutated
  • Loading branch information
BoxyUwU authored Sep 7, 2020
1 parent 54e9f44 commit d86fae8
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions crates/bevy_ecs/hecs/src/query.rs
Original file line number Diff line number Diff line change
Expand Up @@ -322,9 +322,8 @@ pub struct Or<T>(PhantomData<T>);
#[doc(hidden)]
pub struct FetchOr<T>(T);

/// Query transformer that skips entities that have a `T` component that has
/// not been mutated since the last pass of the system. This does not include
/// components that were added in since the last pass.
/// Query transformer that retrieves components of type `T` that have been mutated since the start of the frame.
/// Added components do not count as mutated.
pub struct Mutated<'a, T> {
value: &'a T,
}
Expand Down Expand Up @@ -389,7 +388,7 @@ impl<'a, T: Component> Fetch<'a> for FetchMutated<T> {
}
}

#[allow(missing_docs)]
/// Query transformer that retrieves components of type `T` that have been added since the start of the frame.
pub struct Added<'a, T> {
value: &'a T,
}
Expand Down Expand Up @@ -452,8 +451,7 @@ impl<'a, T: Component> Fetch<'a> for FetchAdded<T> {
}
}

/// Query transformer skipping entities that have not been either mutated or added
/// since the last pass of the system
/// Query transformer that retrieves components of type `T` that have either been mutated or added since the start of the frame.
pub struct Changed<'a, T> {
value: &'a T,
}
Expand Down

0 comments on commit d86fae8

Please sign in to comment.