mirror of
https://github.com/bevyengine/bevy
synced 2024-11-23 21:23:05 +00:00
de875fdc4c
# Objective Closes #13017. ## Solution - Make `AppExit` a enum with a `Success` and `Error` variant. - Make `App::run()` return a `AppExit` if it ever returns. - Make app runners return a `AppExit` to signal if they encountered a error. --- ## Changelog ### Added - [`App::should_exit`](https://example.org/) - [`AppExit`](https://docs.rs/bevy/latest/bevy/app/struct.AppExit.html) to the `bevy` and `bevy_app` preludes, ### Changed - [`AppExit`](https://docs.rs/bevy/latest/bevy/app/struct.AppExit.html) is now a enum with 2 variants (`Success` and `Error`). - The app's [runner function](https://docs.rs/bevy/latest/bevy/app/struct.App.html#method.set_runner) now has to return a `AppExit`. - [`App::run()`](https://docs.rs/bevy/latest/bevy/app/struct.App.html#method.run) now also returns the `AppExit` produced by the runner function. ## Migration Guide - Replace all usages of [`AppExit`](https://docs.rs/bevy/latest/bevy/app/struct.AppExit.html) with `AppExit::Success` or `AppExit::Failure`. - Any custom app runners now need to return a `AppExit`. We suggest you return a `AppExit::Error` if any `AppExit` raised was a Error. You can use the new [`App::should_exit`](https://example.org/) method. - If not exiting from `main` any other way. You should return the `AppExit` from `App::run()` so the app correctly returns a error code if anything fails e.g. ```rust fn main() -> AppExit { App::new() //Your setup here... .run() } ``` --------- Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
120 lines
3.6 KiB
Rust
120 lines
3.6 KiB
Rust
//! An example that illustrates how Time is handled in ECS.
|
|
|
|
use bevy::app::AppExit;
|
|
use bevy::prelude::*;
|
|
|
|
use std::io::{self, BufRead};
|
|
use std::time::Duration;
|
|
|
|
fn banner() {
|
|
println!("This example is meant to intuitively demonstrate how Time works in Bevy.");
|
|
println!();
|
|
println!("Time will be printed in three different schedules in the app:");
|
|
println!("- PreUpdate: real time is printed");
|
|
println!("- FixedUpdate: fixed time step time is printed, may be run zero or multiple times");
|
|
println!("- Update: virtual game time is printed");
|
|
println!();
|
|
println!("Max delta time is set to 5 seconds. Fixed timestep is set to 1 second.");
|
|
println!();
|
|
}
|
|
|
|
fn help() {
|
|
println!("The app reads commands line-by-line from standard input.");
|
|
println!();
|
|
println!("Commands:");
|
|
println!(" empty line: Run app.update() once on the Bevy App");
|
|
println!(" q: Quit the app.");
|
|
println!(" f: Set speed to fast, 2x");
|
|
println!(" n: Set speed to normal, 1x");
|
|
println!(" s: Set speed to slow, 0.5x");
|
|
println!(" p: Pause");
|
|
println!(" u: Unpause");
|
|
}
|
|
|
|
fn runner(mut app: App) -> AppExit {
|
|
banner();
|
|
help();
|
|
let stdin = io::stdin();
|
|
for line in stdin.lock().lines() {
|
|
if let Err(err) = line {
|
|
println!("read err: {:#}", err);
|
|
break;
|
|
}
|
|
match line.unwrap().as_str() {
|
|
"" => {
|
|
app.update();
|
|
}
|
|
"f" => {
|
|
println!("FAST: setting relative speed to 2x");
|
|
app.world_mut()
|
|
.resource_mut::<Time<Virtual>>()
|
|
.set_relative_speed(2.0);
|
|
}
|
|
"n" => {
|
|
println!("NORMAL: setting relative speed to 1x");
|
|
app.world_mut()
|
|
.resource_mut::<Time<Virtual>>()
|
|
.set_relative_speed(1.0);
|
|
}
|
|
"s" => {
|
|
println!("SLOW: setting relative speed to 0.5x");
|
|
app.world_mut()
|
|
.resource_mut::<Time<Virtual>>()
|
|
.set_relative_speed(0.5);
|
|
}
|
|
"p" => {
|
|
println!("PAUSE: pausing virtual clock");
|
|
app.world_mut().resource_mut::<Time<Virtual>>().pause();
|
|
}
|
|
"u" => {
|
|
println!("UNPAUSE: resuming virtual clock");
|
|
app.world_mut().resource_mut::<Time<Virtual>>().unpause();
|
|
}
|
|
"q" => {
|
|
println!("QUITTING!");
|
|
break;
|
|
}
|
|
_ => {
|
|
help();
|
|
}
|
|
}
|
|
}
|
|
|
|
AppExit::Success
|
|
}
|
|
|
|
fn print_real_time(time: Res<Time<Real>>) {
|
|
println!(
|
|
"PreUpdate: this is real time clock, delta is {:?} and elapsed is {:?}",
|
|
time.delta(),
|
|
time.elapsed()
|
|
);
|
|
}
|
|
|
|
fn print_fixed_time(time: Res<Time>) {
|
|
println!(
|
|
"FixedUpdate: this is generic time clock inside fixed, delta is {:?} and elapsed is {:?}",
|
|
time.delta(),
|
|
time.elapsed()
|
|
);
|
|
}
|
|
|
|
fn print_time(time: Res<Time>) {
|
|
println!(
|
|
"Update: this is generic time clock, delta is {:?} and elapsed is {:?}",
|
|
time.delta(),
|
|
time.elapsed()
|
|
);
|
|
}
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(MinimalPlugins)
|
|
.insert_resource(Time::<Virtual>::from_max_delta(Duration::from_secs(5)))
|
|
.insert_resource(Time::<Fixed>::from_duration(Duration::from_secs(1)))
|
|
.add_systems(PreUpdate, print_real_time)
|
|
.add_systems(FixedUpdate, print_fixed_time)
|
|
.add_systems(Update, print_time)
|
|
.set_runner(runner)
|
|
.run();
|
|
}
|