6ddd0f16a8
# 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> |
||
|---|---|---|
| .. | ||
| change_detection.rs | ||
| component_hooks.rs | ||
| custom_query_param.rs | ||
| custom_schedule.rs | ||
| dynamic.rs | ||
| ecs_guide.rs | ||
| entity_disabling.rs | ||
| error_handling.rs | ||
| event.rs | ||
| fallible_params.rs | ||
| fixed_timestep.rs | ||
| generic_system.rs | ||
| hierarchy.rs | ||
| hotpatching_systems.rs | ||
| immutable_components.rs | ||
| iter_combinations.rs | ||
| nondeterministic_system_order.rs | ||
| observer_propagation.rs | ||
| observers.rs | ||
| one_shot_systems.rs | ||
| parallel_query.rs | ||
| relationships.rs | ||
| removal_detection.rs | ||
| run_conditions.rs | ||
| send_and_receive_events.rs | ||
| startup_system.rs | ||
| state_scoped.rs | ||
| system_closure.rs | ||
| system_param.rs | ||
| system_piping.rs | ||
| system_stepping.rs | ||