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

Fix docs for fixed timestep (#8363)

Browse Source 
# Objective

The docs for `FixedTime::expend` are unfinished.
This commit is contained in:
JoJoJet 2023-04-14 15:41:31 -04:00 committed by GitHub
parent 4805e48da9
commit 1074a41b87
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
crates/bevy_time/src/fixed_timestep.rs
View File

@ -65,7 +65,8 @@ impl FixedTime {
/// Expends one `period` of accumulated time. /// Expends one `period` of accumulated time.
/// ///
/// [`Err(FixedUpdateError`)] will be returned /// [`Err(FixedUpdateError`)] will be returned if there is
/// not enough accumulated time to span an entire period.
pub fn expend(&mut self) -> Result<(), FixedUpdateError> { pub fn expend(&mut self) -> Result<(), FixedUpdateError> {
if let Some(new_value) = self.accumulated.checked_sub(self.period) { if let Some(new_value) = self.accumulated.checked_sub(self.period) {
self.accumulated = new_value; self.accumulated = new_value;