4820917af6
# Objective
Change detection can be spuriously triggered by setting a field to the same value as before. As a result, a common pattern is to write:
```rust
if *foo != value {
*foo = value;
}
```
This is confusing to read, and heavy on boilerplate.
Adopted from #5373, but untangled and rebased to current `bevy/main`.
## Solution
1. Add a method to the `DetectChanges` trait that implements this boilerplate when the appropriate trait bounds are met.
2. Document this minor footgun, and point users to it.
## Changelog
* added the `set_if_neq` method to avoid triggering change detection when the new and previous values are equal. This will work on both components and resources.
## Migration Guide
If you are manually checking if a component or resource's value is equal to its new value before setting it to avoid triggering change detection, migrate to the clearer and more convenient `set_if_neq` method.
## Context
Related to #2363 as it avoids triggering change detection, but not a complete solution (as it still requires triggering it when real changes are made).
Co-authored-by: Zoey <Dessix@Dessix.net>
58 lines
1.8 KiB
Rust
58 lines
1.8 KiB
Rust
//! This example illustrates how to react to component change.
|
|
|
|
use bevy::prelude::*;
|
|
use rand::Rng;
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
.add_startup_system(setup)
|
|
.add_system(change_component)
|
|
.add_system(change_detection)
|
|
.add_system(tracker_monitoring)
|
|
.run();
|
|
}
|
|
|
|
#[derive(Component, PartialEq, Debug)]
|
|
struct MyComponent(f32);
|
|
|
|
fn setup(mut commands: Commands) {
|
|
commands.spawn(MyComponent(0.));
|
|
commands.spawn(Transform::IDENTITY);
|
|
}
|
|
|
|
fn change_component(time: Res<Time>, mut query: Query<(Entity, &mut MyComponent)>) {
|
|
for (entity, mut component) in &mut query {
|
|
if rand::thread_rng().gen_bool(0.1) {
|
|
info!("changing component {:?}", entity);
|
|
let new_component = MyComponent(time.elapsed_seconds().round());
|
|
// Change detection occurs on mutable derefence,
|
|
// and does not consider whether or not a value is actually equal.
|
|
// To avoid triggering change detection when nothing has actually changed,
|
|
// you can use the `set_if_neq` method on any component or resource that implements PartialEq
|
|
component.set_if_neq(new_component);
|
|
}
|
|
}
|
|
}
|
|
|
|
// There are query filters for `Changed<T>` and `Added<T>`
|
|
// Only entities matching the filters will be in the query
|
|
fn change_detection(query: Query<(Entity, &MyComponent), Changed<MyComponent>>) {
|
|
for (entity, component) in &query {
|
|
info!("{:?} changed: {:?}", entity, component,);
|
|
}
|
|
}
|
|
|
|
// By looking at trackers, the query is not filtered but the information is available
|
|
fn tracker_monitoring(
|
|
query: Query<(
|
|
Entity,
|
|
Option<&MyComponent>,
|
|
Option<ChangeTrackers<MyComponent>>,
|
|
)>,
|
|
) {
|
|
for (entity, component, trackers) in &query {
|
|
info!("{:?}: {:?} -> {:?}", entity, component, trackers);
|
|
}
|
|
}
|