From ee49535c6bbc2bc02d6681bb2138b9022d5a1583 Mon Sep 17 00:00:00 2001 From: Hans Meine Date: Thu, 27 Oct 2022 15:48:29 +0000 Subject: [PATCH] elaborate on Timer docs (#6385) These tiny changes answer question I had when using the Timer class. --- crates/bevy_time/src/timer.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/crates/bevy_time/src/timer.rs b/crates/bevy_time/src/timer.rs index 767c79d91b9a7b..2aa983400e1611 100644 --- a/crates/bevy_time/src/timer.rs +++ b/crates/bevy_time/src/timer.rs @@ -47,7 +47,8 @@ impl Timer { } } - /// Returns `true` if the timer has reached its duration. + /// Returns `true` if the timer has reached its duration at least once. + /// See also [`Timer::just_finished`](Timer::just_finished). /// /// # Examples /// ``` @@ -188,6 +189,7 @@ impl Timer { /// Advance the timer by `delta` seconds. /// Non repeating timer will clamp at duration. /// Repeating timer will wrap around. + /// Will not affect paused timers. /// /// See also [`Stopwatch::tick`](Stopwatch::tick). ///