2022-05-16 13:53:20 +00:00
|
|
|
//! This example demonstrates you can create a custom runner (to update an app manually). It reads
|
|
|
|
//! lines from stdin and prints them from within the ecs.
|
|
|
|
|
2024-04-22 16:48:18 +00:00
|
|
|
use bevy::{app::AppExit, prelude::*};
|
2022-07-01 13:41:23 +00:00
|
|
|
use std::io;
|
2020-11-09 21:04:27 +00:00
|
|
|
|
Make `Resource` trait opt-in, requiring `#[derive(Resource)]` V2 (#5577)
*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>
2022-08-08 21:36:35 +00:00
|
|
|
#[derive(Resource)]
|
2020-11-09 21:04:27 +00:00
|
|
|
struct Input(String);
|
|
|
|
|
2024-04-22 16:48:18 +00:00
|
|
|
fn my_runner(mut app: App) -> AppExit {
|
2024-05-03 20:12:27 +00:00
|
|
|
// Finalize plugin building, including running any necessary clean-up.
|
|
|
|
// This is normally completed by the default runner.
|
|
|
|
app.finish();
|
|
|
|
app.cleanup();
|
|
|
|
|
2020-11-09 21:04:27 +00:00
|
|
|
println!("Type stuff into the console");
|
2022-07-01 13:41:23 +00:00
|
|
|
for line in io::stdin().lines() {
|
2020-11-09 21:04:27 +00:00
|
|
|
{
|
2024-03-31 03:16:10 +00:00
|
|
|
let mut input = app.world_mut().resource_mut::<Input>();
|
2020-11-09 21:04:27 +00:00
|
|
|
input.0 = line.unwrap();
|
|
|
|
}
|
|
|
|
app.update();
|
2024-04-22 16:48:18 +00:00
|
|
|
|
|
|
|
if let Some(exit) = app.should_exit() {
|
|
|
|
return exit;
|
|
|
|
}
|
2020-11-09 21:04:27 +00:00
|
|
|
}
|
2024-04-22 16:48:18 +00:00
|
|
|
|
|
|
|
AppExit::Success
|
2020-11-09 21:04:27 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
fn print_system(input: Res<Input>) {
|
|
|
|
println!("You typed: {}", input.0);
|
|
|
|
}
|
|
|
|
|
2024-04-22 16:48:18 +00:00
|
|
|
fn exit_system(input: Res<Input>, mut exit_event: EventWriter<AppExit>) {
|
|
|
|
if input.0 == "exit" {
|
|
|
|
exit_event.send(AppExit::Success);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// AppExit implements `Termination` so we can return it from main.
|
|
|
|
fn main() -> AppExit {
|
2021-07-27 20:21:06 +00:00
|
|
|
App::new()
|
2021-01-30 20:55:13 +00:00
|
|
|
.insert_resource(Input(String::new()))
|
2020-11-09 21:04:27 +00:00
|
|
|
.set_runner(my_runner)
|
2024-04-22 16:48:18 +00:00
|
|
|
.add_systems(Update, (print_system, exit_system))
|
|
|
|
.run()
|
2020-11-09 21:04:27 +00:00
|
|
|
}
|