From d319910d36e65fe6b7537ca40e4e44f81d8e6bba Mon Sep 17 00:00:00 2001 From: Nicola Papale Date: Fri, 5 May 2023 22:33:02 +0200 Subject: [PATCH] Fix wording on DetectChanges::is_changed (#8550) # Objective - Closes #8472 ## Solution - Fix wording on DetectChanges::is_changed --- crates/bevy_ecs/src/change_detection.rs | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/crates/bevy_ecs/src/change_detection.rs b/crates/bevy_ecs/src/change_detection.rs index 772caad356..e92224225b 100644 --- a/crates/bevy_ecs/src/change_detection.rs +++ b/crates/bevy_ecs/src/change_detection.rs @@ -46,7 +46,12 @@ pub trait DetectChanges { /// Returns `true` if this value was added after the system last ran. fn is_added(&self) -> bool; - /// Returns `true` if this value was added or mutably dereferenced after the system last ran. + /// Returns `true` if this value was added or mutably dereferenced + /// either since the last time the system ran or, if the system never ran, + /// since the beginning of the program. + /// + /// To check if the value was mutably dereferenced only, + /// use `this.is_changed() && !this.is_added()`. fn is_changed(&self) -> bool; /// Returns the change tick recording the time this data was most recently changed.