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

Update docs for Updated, Changed and Mutated (#451)

Browse Source 
Update docs for Updated, Changed and Mutated
This commit is contained in:
Boxy 2020-09-07 21:52:03 +01:00 committed by GitHub
parent 54e9f446c4
commit d86fae8147
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
crates/bevy_ecs/hecs/src/query.rs
View File

@ -322,9 +322,8 @@ pub struct Or<T>(PhantomData<T>);
#[doc(hidden)] #[doc(hidden)]
pub struct FetchOr<T>(T); pub struct FetchOr<T>(T);
/// Query transformer that skips entities that have a `T` component that has /// Query transformer that retrieves components of type `T` that have been mutated since the start of the frame.
/// not been mutated since the last pass of the system. This does not include /// Added components do not count as mutated.
/// components that were added in since the last pass.
pub struct Mutated<'a, T> { pub struct Mutated<'a, T> {
value: &'a T, value: &'a T,
} }
@ -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> { pub struct Added<'a, T> {
value: &'a T, value: &'a T,
} }
@ -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 /// Query transformer that retrieves components of type `T` that have either been mutated or added since the start of the frame.
/// since the last pass of the system
pub struct Changed<'a, T> { pub struct Changed<'a, T> {
value: &'a T, value: &'a T,
} }