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

Add missing docs to World::change_tick and World::read_change_tick (#6765)

Browse Source 
# Objective

The methods `World::change_tick` and `World::read_change_tick` lack documentation and have confusingly similar behavior.

## Solution

Add documentation and clarify the distinction between the two functions.
This commit is contained in:
JoJoJet 2022-12-05 23:23:14 +00:00
parent b337ed63ad
commit 83e8224694
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
crates/bevy_ecs/src/world/mod.rs
View File

@ -1396,11 +1396,19 @@ impl World {
self.change_tick.fetch_add(1, Ordering::AcqRel) self.change_tick.fetch_add(1, Ordering::AcqRel)
} }
/// Reads the current change tick of this world.
///
/// If you have exclusive (`&mut`) access to the world, consider using [`change_tick()`](Self::change_tick),
/// which is more efficient since it does not require atomic synchronization.
#[inline] #[inline]
pub fn read_change_tick(&self) -> u32 { pub fn read_change_tick(&self) -> u32 {
self.change_tick.load(Ordering::Acquire) self.change_tick.load(Ordering::Acquire)
} }
/// Reads the current change tick of this world.
///
/// This does the same thing as [`read_change_tick()`](Self::read_change_tick), only this method
/// is more efficient since it does not require atomic synchronization.
#[inline] #[inline]
pub fn change_tick(&mut self) -> u32 { pub fn change_tick(&mut self) -> u32 {
*self.change_tick.get_mut() *self.change_tick.get_mut()