 992681b59b
			
		
	
	
		992681b59b
		
	
	
	
	
		
			
			*This PR description is an edited copy of #5007, written by @alice-i-cecile.* # Objective Follow-up to https://github.com/bevyengine/bevy/pull/2254. The `Resource` trait currently has a blanket implementation for all types that meet its bounds. While ergonomic, this results in several drawbacks: * it is possible to make confusing, silent mistakes such as inserting a function pointer (Foo) rather than a value (Foo::Bar) as a resource * it is challenging to discover if a type is intended to be used as a resource * we cannot later add customization options (see the [RFC](https://github.com/bevyengine/rfcs/blob/main/rfcs/27-derive-component.md) for the equivalent choice for Component). * dependencies can use the same Rust type as a resource in invisibly conflicting ways * raw Rust types used as resources cannot preserve privacy appropriately, as anyone able to access that type can read and write to internal values * we cannot capture a definitive list of possible resources to display to users in an editor ## Notes to reviewers * Review this commit-by-commit; there's effectively no back-tracking and there's a lot of churn in some of these commits. *ira: My commits are not as well organized :')* * I've relaxed the bound on Local to Send + Sync + 'static: I don't think these concerns apply there, so this can keep things simple. Storing e.g. a u32 in a Local is fine, because there's a variable name attached explaining what it does. * I think this is a bad place for the Resource trait to live, but I've left it in place to make reviewing easier. IMO that's best tackled with https://github.com/bevyengine/bevy/issues/4981. ## Changelog `Resource` is no longer automatically implemented for all matching types. Instead, use the new `#[derive(Resource)]` macro. ## Migration Guide Add `#[derive(Resource)]` to all types you are using as a resource. If you are using a third party type as a resource, wrap it in a tuple struct to bypass orphan rules. Consider deriving `Deref` and `DerefMut` to improve ergonomics. `ClearColor` no longer implements `Component`. Using `ClearColor` as a component in 0.8 did nothing. Use the `ClearColorConfig` in the `Camera3d` and `Camera2d` components instead. Co-authored-by: Alice <alice.i.cecile@gmail.com> Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com> Co-authored-by: devil-ira <justthecooldude@gmail.com> Co-authored-by: Carter Anderson <mcanders1@gmail.com>
		
			
				
	
	
		
			140 lines
		
	
	
		
			4.1 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			140 lines
		
	
	
		
			4.1 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| //! This example illustrates how to use [`States`] to control transitioning from a `Menu` state to
 | |
| //! an `InGame` state.
 | |
| 
 | |
| use bevy::prelude::*;
 | |
| 
 | |
| fn main() {
 | |
|     App::new()
 | |
|         .add_plugins(DefaultPlugins)
 | |
|         .add_state(AppState::Menu)
 | |
|         .add_startup_system(setup)
 | |
|         .add_system_set(SystemSet::on_enter(AppState::Menu).with_system(setup_menu))
 | |
|         .add_system_set(SystemSet::on_update(AppState::Menu).with_system(menu))
 | |
|         .add_system_set(SystemSet::on_exit(AppState::Menu).with_system(cleanup_menu))
 | |
|         .add_system_set(SystemSet::on_enter(AppState::InGame).with_system(setup_game))
 | |
|         .add_system_set(
 | |
|             SystemSet::on_update(AppState::InGame)
 | |
|                 .with_system(movement)
 | |
|                 .with_system(change_color),
 | |
|         )
 | |
|         .run();
 | |
| }
 | |
| 
 | |
| #[derive(Debug, Clone, Eq, PartialEq, Hash)]
 | |
| enum AppState {
 | |
|     Menu,
 | |
|     InGame,
 | |
| }
 | |
| 
 | |
| #[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_bundle(Camera2dBundle::default());
 | |
| }
 | |
| 
 | |
| fn setup_menu(mut commands: Commands, asset_server: Res<AssetServer>) {
 | |
|     let button_entity = commands
 | |
|         .spawn_bundle(ButtonBundle {
 | |
|             style: Style {
 | |
|                 size: Size::new(Val::Px(150.0), Val::Px(65.0)),
 | |
|                 // center button
 | |
|                 margin: UiRect::all(Val::Auto),
 | |
|                 // horizontally center child text
 | |
|                 justify_content: JustifyContent::Center,
 | |
|                 // vertically center child text
 | |
|                 align_items: AlignItems::Center,
 | |
|                 ..default()
 | |
|             },
 | |
|             color: NORMAL_BUTTON.into(),
 | |
|             ..default()
 | |
|         })
 | |
|         .with_children(|parent| {
 | |
|             parent.spawn_bundle(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 state: ResMut<State<AppState>>,
 | |
|     mut interaction_query: Query<
 | |
|         (&Interaction, &mut UiColor),
 | |
|         (Changed<Interaction>, With<Button>),
 | |
|     >,
 | |
| ) {
 | |
|     for (interaction, mut color) in &mut interaction_query {
 | |
|         match *interaction {
 | |
|             Interaction::Clicked => {
 | |
|                 *color = PRESSED_BUTTON.into();
 | |
|                 state.set(AppState::InGame).unwrap();
 | |
|             }
 | |
|             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_bundle(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.seconds_since_startup() * 0.5).sin() as f32 + 2.0);
 | |
|     }
 | |
| }
 |