Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs for Updated, Changed and Mutated #451

Merged
merged 2 commits into from
Sep 7, 2020
Merged

Update docs for Updated, Changed and Mutated #451

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56cea0f
Update docs for Updated, Changed and Mutated
BoxyUwU Sep 6, 2020
6257352
Less clunky wording maybe?
BoxyUwU Sep 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions crates/bevy_ecs/hecs/src/query.rs
View file
Open in desktop
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