bevy/crates/bevy_ecs/src/schedule
Alice Cecile 6ddd0f16a8
Component lifecycle reorganization and documentation (#19543)
# Objective

I set out with one simple goal: clearly document the differences between
each of the component lifecycle events via module docs.

Unfortunately, no such module existed: the various lifecycle code was
scattered to the wind.
Without a unified module, it's very hard to discover the related types,
and there's nowhere good to put my shiny new documentation.

## Solution

1. Unify the assorted types into a single
`bevy_ecs::component_lifecycle` module.
2. Write docs.
3. Write a migration guide.

## Testing

Thanks CI!

## Follow-up

1. The lifecycle event names are pretty confusing, especially
`OnReplace`. We should consider renaming those. No bikeshedding in my PR
though!
2. Observers need real module docs too :(
3. Any additional functional changes should be done elsewhere; this is a
simple docs and re-org PR.

---------

Co-authored-by: theotherphil <phil.j.ellison@gmail.com>
2025-06-10 00:59:16 +00:00
..
executor Delete System::component_access(). (#19496) 2025-06-09 22:54:52 +00:00
graph Rename bevy_platform_support to bevy_platform (#18813) 2025-04-11 23:13:28 +00:00
auto_insert_apply_deferred.rs Rename bevy_platform_support to bevy_platform (#18813) 2025-04-11 23:13:28 +00:00
condition.rs Component lifecycle reorganization and documentation (#19543) 2025-06-10 00:59:16 +00:00
config.rs Implement SystemCondition for systems returning Result<bool, BevyError> and Result<(), BevyError> (#19553) 2025-06-10 00:04:10 +00:00
mod.rs Implement SystemCondition for systems returning Result<bool, BevyError> and Result<(), BevyError> (#19553) 2025-06-10 00:04:10 +00:00
pass.rs Schedule build pass (#11094) 2025-02-05 23:14:05 +00:00
schedule.rs Fix uninlined format argument lint (#19561) 2025-06-09 20:53:19 +00:00
set.rs Write real docs for SystemSet (#19538) 2025-06-09 20:03:02 +00:00
stepping.rs Fix uninlined format argument lint (#19561) 2025-06-09 20:53:19 +00:00