Skip to content

Commit 4bcf49b

Browse files
committed
elaborate on Timer docs (#6385)
These tiny changes answer question I had when using the Timer class.
1 parent 4569713 commit 4bcf49b

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

crates/bevy_time/src/timer.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ impl Timer {
4747
}
4848
}
4949

50-
/// Returns `true` if the timer has reached its duration.
50+
/// Returns `true` if the timer has reached its duration at least once.
51+
/// See also [`Timer::just_finished`](Timer::just_finished).
5152
///
5253
/// # Examples
5354
/// ```
@@ -188,6 +189,7 @@ impl Timer {
188189
/// Advance the timer by `delta` seconds.
189190
/// Non repeating timer will clamp at duration.
190191
/// Repeating timer will wrap around.
192+
/// Will not affect paused timers.
191193
///
192194
/// See also [`Stopwatch::tick`](Stopwatch::tick).
193195
///

0 commit comments

Comments
 (0)