[Merged by Bors] - Add missing docs to World::change_tick and World::read_change_tick
#6765
Conversation
alice-i-cecile
added
C-Docs
james7132
added
the
S-Ready-For-Final-Review
| @@ -1390,11 +1390,19 @@ impl World { | |||
| self.change_tick.fetch_add(1, Ordering::AcqRel) | |||
| } | |||
|
|
|||
| /// Reads the current change tick of this world. | |||
There was a problem hiding this comment.
Super basic question so I'm sorry lol, but is a change tick different than a normal tick?
I understand a tick to be a "loop" of the main update loop. But in ECS's I suppose it might not be that simple. I guess this tick is specific to the world?
There was a problem hiding this comment.
I suppose maybe I need some place to read up about how ticks are done in ECS's since maybe worlds and systems run at different ticks? Is there a good place to read up on that?
There was a problem hiding this comment.
Basically, a change tick is a number signifying when a system ran in relation to other systems. This is used to answer questions like "did this value change since the last time this system ran?", powering change detection.
I don't know of any write-ups on change detection internals, so I'd recommend reading these source files for more details:
https://github.com/bevyengine/bevy/blob/main/crates/bevy_ecs/src/change_detection.rs
https://github.com/bevyengine/bevy/blob/main/crates/bevy_ecs/src/component.rs#L521
I suppose the docs are in need of a centralized explanation of how change ticks work.
This reverts commit 5a3dbca.
|
bors r+ |
#6765) # 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.
bors
bot
changed the title
World::change_tick and World::read_change_tickWorld::change_tick and World::read_change_tick
bevyengine#6765) # 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.
bevyengine#6765) # 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.
bevyengine#6765) # 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.
Objective
The methods
World::change_tickandWorld::read_change_ticklack documentation and have confusingly similar behavior.Solution
Add documentation and clarify the distinction between the two functions.