 206c7ce219
			
		
	
	
		206c7ce219
		
	
	
	
	
		
			
			Huge thanks to @maniwani, @devil-ira, @hymm, @cart, @superdump and @jakobhellermann for the help with this PR. # Objective - Followup #6587. - Minimal integration for the Stageless Scheduling RFC: https://github.com/bevyengine/rfcs/pull/45 ## Solution - [x] Remove old scheduling module - [x] Migrate new methods to no longer use extension methods - [x] Fix compiler errors - [x] Fix benchmarks - [x] Fix examples - [x] Fix docs - [x] Fix tests ## Changelog ### Added - a large number of methods on `App` to work with schedules ergonomically - the `CoreSchedule` enum - `App::add_extract_system` via the `RenderingAppExtension` trait extension method - the private `prepare_view_uniforms` system now has a public system set for scheduling purposes, called `ViewSet::PrepareUniforms` ### Removed - stages, and all code that mentions stages - states have been dramatically simplified, and no longer use a stack - `RunCriteriaLabel` - `AsSystemLabel` trait - `on_hierarchy_reports_enabled` run criteria (now just uses an ad hoc resource checking run condition) - systems in `RenderSet/Stage::Extract` no longer warn when they do not read data from the main world - `RunCriteriaLabel` - `transform_propagate_system_set`: this was a nonstandard pattern that didn't actually provide enough control. The systems are already `pub`: the docs have been updated to ensure that the third-party usage is clear. ### Changed - `System::default_labels` is now `System::default_system_sets`. - `App::add_default_labels` is now `App::add_default_sets` - `CoreStage` and `StartupStage` enums are now `CoreSet` and `StartupSet` - `App::add_system_set` was renamed to `App::add_systems` - The `StartupSchedule` label is now defined as part of the `CoreSchedules` enum - `.label(SystemLabel)` is now referred to as `.in_set(SystemSet)` - `SystemLabel` trait was replaced by `SystemSet` - `SystemTypeIdLabel<T>` was replaced by `SystemSetType<T>` - The `ReportHierarchyIssue` resource now has a public constructor (`new`), and implements `PartialEq` - Fixed time steps now use a schedule (`CoreSchedule::FixedTimeStep`) rather than a run criteria. - Adding rendering extraction systems now panics rather than silently failing if no subapp with the `RenderApp` label is found. - the `calculate_bounds` system, with the `CalculateBounds` label, is now in `CoreSet::Update`, rather than in `CoreSet::PostUpdate` before commands are applied. - `SceneSpawnerSystem` now runs under `CoreSet::Update`, rather than `CoreStage::PreUpdate.at_end()`. - `bevy_pbr::add_clusters` is no longer an exclusive system - the top level `bevy_ecs::schedule` module was replaced with `bevy_ecs::scheduling` - `tick_global_task_pools_on_main_thread` is no longer run as an exclusive system. Instead, it has been replaced by `tick_global_task_pools`, which uses a `NonSend` resource to force running on the main thread. ## Migration Guide - Calls to `.label(MyLabel)` should be replaced with `.in_set(MySet)` - Stages have been removed. Replace these with system sets, and then add command flushes using the `apply_system_buffers` exclusive system where needed. - The `CoreStage`, `StartupStage, `RenderStage` and `AssetStage` enums have been replaced with `CoreSet`, `StartupSet, `RenderSet` and `AssetSet`. The same scheduling guarantees have been preserved. - Systems are no longer added to `CoreSet::Update` by default. Add systems manually if this behavior is needed, although you should consider adding your game logic systems to `CoreSchedule::FixedTimestep` instead for more reliable framerate-independent behavior. - Similarly, startup systems are no longer part of `StartupSet::Startup` by default. In most cases, this won't matter to you. - For example, `add_system_to_stage(CoreStage::PostUpdate, my_system)` should be replaced with - `add_system(my_system.in_set(CoreSet::PostUpdate)` - When testing systems or otherwise running them in a headless fashion, simply construct and run a schedule using `Schedule::new()` and `World::run_schedule` rather than constructing stages - Run criteria have been renamed to run conditions. These can now be combined with each other and with states. - Looping run criteria and state stacks have been removed. Use an exclusive system that runs a schedule if you need this level of control over system control flow. - For app-level control flow over which schedules get run when (such as for rollback networking), create your own schedule and insert it under the `CoreSchedule::Outer` label. - Fixed timesteps are now evaluated in a schedule, rather than controlled via run criteria. The `run_fixed_timestep` system runs this schedule between `CoreSet::First` and `CoreSet::PreUpdate` by default. - Command flush points introduced by `AssetStage` have been removed. If you were relying on these, add them back manually. - Adding extract systems is now typically done directly on the main app. Make sure the `RenderingAppExtension` trait is in scope, then call `app.add_extract_system(my_system)`. - the `calculate_bounds` system, with the `CalculateBounds` label, is now in `CoreSet::Update`, rather than in `CoreSet::PostUpdate` before commands are applied. You may need to order your movement systems to occur before this system in order to avoid system order ambiguities in culling behavior. - the `RenderLabel` `AppLabel` was renamed to `RenderApp` for clarity - `App::add_state` now takes 0 arguments: the starting state is set based on the `Default` impl. - Instead of creating `SystemSet` containers for systems that run in stages, simply use `.on_enter::<State::Variant>()` or its `on_exit` or `on_update` siblings. - `SystemLabel` derives should be replaced with `SystemSet`. You will also need to add the `Debug`, `PartialEq`, `Eq`, and `Hash` traits to satisfy the new trait bounds. - `with_run_criteria` has been renamed to `run_if`. Run criteria have been renamed to run conditions for clarity, and should now simply return a bool. - States have been dramatically simplified: there is no longer a "state stack". To queue a transition to the next state, call `NextState::set` ## TODO - [x] remove dead methods on App and World - [x] add `App::add_system_to_schedule` and `App::add_systems_to_schedule` - [x] avoid adding the default system set at inappropriate times - [x] remove any accidental cycles in the default plugins schedule - [x] migrate benchmarks - [x] expose explicit labels for the built-in command flush points - [x] migrate engine code - [x] remove all mentions of stages from the docs - [x] verify docs for States - [x] fix uses of exclusive systems that use .end / .at_start / .before_commands - [x] migrate RenderStage and AssetStage - [x] migrate examples - [x] ensure that transform propagation is exported in a sufficiently public way (the systems are already pub) - [x] ensure that on_enter schedules are run at least once before the main app - [x] re-enable opt-in to execution order ambiguities - [x] revert change to `update_bounds` to ensure it runs in `PostUpdate` - [x] test all examples - [x] unbreak directional lights - [x] unbreak shadows (see 3d_scene, 3d_shape, lighting, transparaency_3d examples) - [x] game menu example shows loading screen and menu simultaneously - [x] display settings menu is a blank screen - [x] `without_winit` example panics - [x] ensure all tests pass - [x] SubApp doc test fails - [x] runs_spawn_local tasks fails - [x] [Fix panic_when_hierachy_cycle test hanging](https://github.com/alice-i-cecile/bevy/pull/120) ## Points of Difficulty and Controversy **Reviewers, please give feedback on these and look closely** 1. Default sets, from the RFC, have been removed. These added a tremendous amount of implicit complexity and result in hard to debug scheduling errors. They're going to be tackled in the form of "base sets" by @cart in a followup. 2. The outer schedule controls which schedule is run when `App::update` is called. 3. I implemented `Label for `Box<dyn Label>` for our label types. This enables us to store schedule labels in concrete form, and then later run them. I ran into the same set of problems when working with one-shot systems. We've previously investigated this pattern in depth, and it does not appear to lead to extra indirection with nested boxes. 4. `SubApp::update` simply runs the default schedule once. This sucks, but this whole API is incomplete and this was the minimal changeset. 5. `time_system` and `tick_global_task_pools_on_main_thread` no longer use exclusive systems to attempt to force scheduling order 6. Implemetnation strategy for fixed timesteps 7. `AssetStage` was migrated to `AssetSet` without reintroducing command flush points. These did not appear to be used, and it's nice to remove these bottlenecks. 8. Migration of `bevy_render/lib.rs` and pipelined rendering. The logic here is unusually tricky, as we have complex scheduling requirements. ## Future Work (ideally before 0.10) - Rename schedule_v3 module to schedule or scheduling - Add a derive macro to states, and likely a `EnumIter` trait of some form - Figure out what exactly to do with the "systems added should basically work by default" problem - Improve ergonomics for working with fixed timesteps and states - Polish FixedTime API to match Time - Rebase and merge #7415 - Resolve all internal ambiguities (blocked on better tools, especially #7442) - Add "base sets" to replace the removed default sets.
		
			
				
	
	
		
			165 lines
		
	
	
		
			5.4 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			165 lines
		
	
	
		
			5.4 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| //! This example illustrates how to use [`States`] for high-level app control flow.
 | |
| //! States are a powerful but intuitive tool for controlling which logic runs when.
 | |
| //! You can have multiple independent states, and the [`OnEnter`] and [`OnExit`] schedules
 | |
| //! can be used to great effect to ensure that you handle setup and teardown appropriately.
 | |
| //!
 | |
| //! In this case, we're transitioning from a `Menu` state to  an `InGame` state.
 | |
| 
 | |
| use bevy::prelude::*;
 | |
| 
 | |
| fn main() {
 | |
|     App::new()
 | |
|         .add_plugins(DefaultPlugins)
 | |
|         .add_state::<AppState>()
 | |
|         .add_startup_system(setup)
 | |
|         // This system runs when we enter `AppState::Menu`, during `CoreSet::StateTransitions`.
 | |
|         // All systems from the exit schedule of the state we're leaving are run first,
 | |
|         // and then all systems from the enter schedule of the state we're leaving are run second.
 | |
|         .add_system_to_schedule(OnEnter(AppState::Menu), setup_menu)
 | |
|         // By contrast, on_update systems are stored in the main schedule, during CoreSet::Update,
 | |
|         // and simply check the value of the `State<T>` resource to see if they should run each frame.
 | |
|         .add_system(menu.on_update(AppState::Menu))
 | |
|         .add_system_to_schedule(OnExit(AppState::Menu), cleanup_menu)
 | |
|         .add_system_to_schedule(OnEnter(AppState::InGame), setup_game)
 | |
|         .add_systems((movement, change_color).on_update(AppState::InGame))
 | |
|         .run();
 | |
| }
 | |
| 
 | |
| #[derive(Debug, Clone, Copy, Default, Eq, PartialEq, Hash)]
 | |
| enum AppState {
 | |
|     #[default]
 | |
|     Menu,
 | |
|     InGame,
 | |
| }
 | |
| 
 | |
| impl States for AppState {
 | |
|     type Iter = std::array::IntoIter<AppState, 2>;
 | |
| 
 | |
|     fn variants() -> Self::Iter {
 | |
|         [AppState::Menu, AppState::InGame].into_iter()
 | |
|     }
 | |
| }
 | |
| 
 | |
| #[derive(Resource)]
 | |
| struct MenuData {
 | |
|     button_entity: Entity,
 | |
| }
 | |
| 
 | |
| const NORMAL_BUTTON: Color = Color::rgb(0.15, 0.15, 0.15);
 | |
| const HOVERED_BUTTON: Color = Color::rgb(0.25, 0.25, 0.25);
 | |
| const PRESSED_BUTTON: Color = Color::rgb(0.35, 0.75, 0.35);
 | |
| 
 | |
| fn setup(mut commands: Commands) {
 | |
|     commands.spawn(Camera2dBundle::default());
 | |
| }
 | |
| 
 | |
| fn setup_menu(mut commands: Commands, asset_server: Res<AssetServer>) {
 | |
|     let button_entity = commands
 | |
|         .spawn(NodeBundle {
 | |
|             style: Style {
 | |
|                 // center button
 | |
|                 size: Size::new(Val::Percent(100.0), Val::Percent(100.0)),
 | |
|                 justify_content: JustifyContent::Center,
 | |
|                 align_items: AlignItems::Center,
 | |
|                 ..default()
 | |
|             },
 | |
|             ..default()
 | |
|         })
 | |
|         .with_children(|parent| {
 | |
|             parent
 | |
|                 .spawn(ButtonBundle {
 | |
|                     style: Style {
 | |
|                         size: Size::new(Val::Px(150.0), Val::Px(65.0)),
 | |
|                         // horizontally center child text
 | |
|                         justify_content: JustifyContent::Center,
 | |
|                         // vertically center child text
 | |
|                         align_items: AlignItems::Center,
 | |
|                         ..default()
 | |
|                     },
 | |
|                     background_color: NORMAL_BUTTON.into(),
 | |
|                     ..default()
 | |
|                 })
 | |
|                 .with_children(|parent| {
 | |
|                     parent.spawn(TextBundle::from_section(
 | |
|                         "Play",
 | |
|                         TextStyle {
 | |
|                             font: asset_server.load("fonts/FiraSans-Bold.ttf"),
 | |
|                             font_size: 40.0,
 | |
|                             color: Color::rgb(0.9, 0.9, 0.9),
 | |
|                         },
 | |
|                     ));
 | |
|                 });
 | |
|         })
 | |
|         .id();
 | |
|     commands.insert_resource(MenuData { button_entity });
 | |
| }
 | |
| 
 | |
| fn menu(
 | |
|     mut next_state: ResMut<NextState<AppState>>,
 | |
|     mut interaction_query: Query<
 | |
|         (&Interaction, &mut BackgroundColor),
 | |
|         (Changed<Interaction>, With<Button>),
 | |
|     >,
 | |
| ) {
 | |
|     for (interaction, mut color) in &mut interaction_query {
 | |
|         match *interaction {
 | |
|             Interaction::Clicked => {
 | |
|                 *color = PRESSED_BUTTON.into();
 | |
|                 next_state.set(AppState::InGame);
 | |
|             }
 | |
|             Interaction::Hovered => {
 | |
|                 *color = HOVERED_BUTTON.into();
 | |
|             }
 | |
|             Interaction::None => {
 | |
|                 *color = NORMAL_BUTTON.into();
 | |
|             }
 | |
|         }
 | |
|     }
 | |
| }
 | |
| 
 | |
| fn cleanup_menu(mut commands: Commands, menu_data: Res<MenuData>) {
 | |
|     commands.entity(menu_data.button_entity).despawn_recursive();
 | |
| }
 | |
| 
 | |
| fn setup_game(mut commands: Commands, asset_server: Res<AssetServer>) {
 | |
|     commands.spawn(SpriteBundle {
 | |
|         texture: asset_server.load("branding/icon.png"),
 | |
|         ..default()
 | |
|     });
 | |
| }
 | |
| 
 | |
| const SPEED: f32 = 100.0;
 | |
| fn movement(
 | |
|     time: Res<Time>,
 | |
|     input: Res<Input<KeyCode>>,
 | |
|     mut query: Query<&mut Transform, With<Sprite>>,
 | |
| ) {
 | |
|     for mut transform in &mut query {
 | |
|         let mut direction = Vec3::ZERO;
 | |
|         if input.pressed(KeyCode::Left) {
 | |
|             direction.x -= 1.0;
 | |
|         }
 | |
|         if input.pressed(KeyCode::Right) {
 | |
|             direction.x += 1.0;
 | |
|         }
 | |
|         if input.pressed(KeyCode::Up) {
 | |
|             direction.y += 1.0;
 | |
|         }
 | |
|         if input.pressed(KeyCode::Down) {
 | |
|             direction.y -= 1.0;
 | |
|         }
 | |
| 
 | |
|         if direction != Vec3::ZERO {
 | |
|             transform.translation += direction.normalize() * SPEED * time.delta_seconds();
 | |
|         }
 | |
|     }
 | |
| }
 | |
| 
 | |
| fn change_color(time: Res<Time>, mut query: Query<&mut Sprite>) {
 | |
|     for mut sprite in &mut query {
 | |
|         sprite
 | |
|             .color
 | |
|             .set_b((time.elapsed_seconds() * 0.5).sin() + 2.0);
 | |
|     }
 | |
| }
 |